Layer.addCustomAggregateLabel

ChartDirector 7.0 (Perl Edition)

Usage

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

Description

Adds 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

Argument	Default	Description
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.
fontSize	8	The font size used to draw the labels.
fontColor	TextColor	The color used to draw the labels.
fontAngle	0	The rotation angle of the labels.

Return Value

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