ChartDirector 6.0 (Ruby Edition)

MeterPointer.setShape


Usage

setShape(pointerType [, lengthRatio [, widthRatio ]])

Description

Sets the shape of the meter pointer to one of the built-in shapes.

Note: For angular meters, this method is for classical style pointers. There is another method MeterPointer.setShapeAndOffset for setting the shapes and positions of new style pointers.



The built-in symbols are specified by using the following predefined constants as the pointerType argument.

ConstantValueDescription
DiamondPointer0The blue pointers in the meters above.
TriangularPointer1The purple pointers in the meters above.
ArrowPointer2The red pointers in the meters above.
ArrowPointer23The yellow pointers in the meters above.
LinePointer4The green pointers in the meters above.
PencilPointer5The grey pointers in the meters above.

The length and width of the pointer can be scaled by using the lengthRatio and widthRatio arguments. The meters above are using default length and width ratios, which are both 1 for angular meters, and 0.75 and 1 for linear meters.

Arguments

ArgumentDefaultDescription
pointerType(Mandatory)One of the predefined pointer shape constants to specify the pointer shape to use.
lengthRatioNoValueThe length ratio to be applied to the pointer. NoValue means the lengthRatio is not modified. The default is 1.0 for angular meters and 0.75 for linear meters.
widthRatioNoValueThe width ratio to be applied to the pointer. NoValue means the widthRatio is not modified. The default is 1.0.

Return Value

None