ChartDirector Ver 3.1 (PHP Edition Edition)

Layer.addCustomAggregateLabel


Usage

addCustomAggregateLabel(dataItem , label[, font[, fontSize[, fontColor[, fontAngle ]]]])

Description

Add a custom aggregate label to an aggregated object.

Aggregate data labels applies to layer types that contains "aggregated data", such as stacked bar layer and stacked area layer. In these layer types, data labels (see Layer.setDataLabelStyle) represents a single data item, while aggregate labels represents the stacked object.

See Font Specification for details on various font attributes.

Arguments

ArgumentDefaultDescription
dataItem(Mandatory)The index of the aggregated object. The first aggregated object is 0, while the nth aggregated object is (n - 1).
label(Mandatory)A text string representing the custom aggregate label. Parameter substitution and formatting is supported.
font""The font used to draw the labels.
fontSize8The font size used to draw the labels.
fontColorTextColorThe color used to draw the labels.
fontAngle0Set the rotation of the font.

Return Value

A TextBox object that represents the custom aggregate label. You may use the methods of this object to fine-tune the appearance of the custom aggregate data label.