Package esys :: Package pyvisi :: Module scalarbar :: Class ScalarBar

[frames] | no frames]

Class ScalarBar

Known Subclasses:

legend.Legend

Class that defines a scalar bar.

Instance Methods

[hide private]

vtkTextPorperty

__getLabelProperty(self)
Return the scalar bar's label property.

vtkTextPorperty

__getTitleProperty(self)
Return the scalar bar's title property.

__init__(self)
Initialise the scalar bar.

__setupScalarBar(self)
Setup the scalar bar.

vtkScalarBarActor

_getScalarBar(self)
Return the scalar bar.

_setScalarBarLookupTable(self, lookup_table)
Set the scalar bar's lookup table.

labelBoldOff(self)
Disable the bold on the scalar bar's label.

labelBoldOn(self)
Enable the bold on the scalar bar's label.

setHeight(self, height)
Set the height of the scalar bar.

setLabelColor(self, color)
Set the color of the scalar bar's label.

setNumberOfLabels(self, labels)
Set the number of labels on the scalar bar.

setOrientationToHorizontal(self)
Set the orientation of the scalar bar to horizontal.

setOrientationToVertical(self)
Set the orientation of the scalar bar to vertical.

setPosition(self, position)
Set the local position of the scalar bar.

setTitle(self, title)
Set the title on the scalar bar.

setTitleColor(self, color)
Set the color of the scalar bar's title.

setWidth(self, width)
Set the width of the scalar bar.

titleBoldOff(self)
Disable the bold on the scalar bar's title.

titleBoldOn(self)
Enable the bold on the scalar bar's title.

Method Details

[hide private]

__getLabelProperty(self)

Return the scalar bar's label property.

Returns: vtkTextPorperty: Scalar bar's label property

__getTitleProperty(self)

Return the scalar bar's title property.

Returns: vtkTextPorperty: Scalar bar's title property

_getScalarBar(self)

Return the scalar bar.

Returns: vtkScalarBarActor: Scalar bar actor

_setScalarBarLookupTable(self, lookup_table)

Set the scalar bar's lookup table.

Parameters:

lookup_table (vtkScalarsToColors) - Converts scalar data to colors

setHeight(self, height)

Set the height of the scalar bar.

Parameters:

height (Number) - Height of the scalar bar

setLabelColor(self, color)

Set the color of the scalar bar's label.

Parameters:

color (Color constant) - Color of the scalar bar label

setNumberOfLabels(self, labels)

Set the number of labels on the scalar bar.

Parameters:

labels (Number) - Number of labels on the scalar bar

setPosition(self, position)

Set the local position of the scalar bar.

Parameters:

position (LocalPosition object) - Position of the scalar bar

setTitle(self, title)

Set the title on the scalar bar.

Parameters:

title (String) - Title on the scalar bar

setTitleColor(self, color)

Set the color of the scalar bar's title.

Parameters:

color (Color constant) - Color of the scalar bar title

setWidth(self, width)

Set the width of the scalar bar.

Parameters:

width (Number) - Width of the scalar bar.