ChartDirector 5.1 (PHP Edition)

Layer.addCustomGroupLabel


Usage

addCustomGroupLabel(dataGroup, dataItem, label [, font [, fontSize [, fontColor [, fontAngle ]]]])

Description

Adds a custom data group label to object representing the group.

Data group label applies to layer types that may represent data groups. See Layer.addDataGroup on how data groups are created and the layer types that support data groups.

See Font Specification for details on various font attributes.

Arguments

ArgumentDefaultDescription
dataGroup(Mandatory)The data group index of the data point. The first data group is 0; the nth data group is (n - 1).
dataItem(Mandatory)The data point index of the data point. The first data point is 0; the nth data point is (n - 1).
label(Mandatory)A text string representing the data label. Parameter Substitution and Formatting is supported.
font""The font used to draw the label.
fontSize8The font size used to draw the label.
fontColorTextColorThe color used to draw the label.
fontAngle0The rotation angle of the label.

Return Value

A TextBox object representing the prototype of the custom data group label. This may be used to fine-tune the appearance of the custom data group label.