ChartDirector 5.1 (PHP Edition)

BaseMeter.addLabel


Usage

addLabel(pos, label)

Description

Adds a label to a specific position on the meter scale.

By default, all labels will be associated major ticks on the scale. To associate a label with a minor tick instead , use '-' as the first character of the label. To associate a label with a micro tick instead, use ':' as the first character of the label. To draw the label without any tick at all, use '~' as the first character of the label.

Leading '-', '~' or ':' characters are tick specification characters and will not appear on the labels. They just specify the the tick style to be associated with the labels. If you want have a label that actually begins these characters, add '\' as the first character as the escape character.

In some cases, it may be desirable to skip some labels. If you want to draw a major, minor or micro tick without any label, use ' ' (a space character), '-' or ':' as the only character in the label text. If you want leave a label position empty without a tick or a label, use an empty string.

Arguments

ArgumentDefaultDescription
pos(Mandatory)The position to add the label to in meter scale unit.
label(Mandatory)The label to add to the meter scale.

Return Value

None