ChartDirector 6.2 (.NET Edition)

Layer.addCustomAggregateLabel


Usage

[C#] public ChartDirector.TextBox addCustomAggregateLabel(int dataItem, string label [, string font [, double fontSize [, int fontColor [, double fontAngle ]]]]);
[VB] Public Function addCustomAggregateLabel(dataItem As Integer, label As String [, font As String [, fontSize As Double [, fontColor As Integer [, fontAngle As Double ]]]]) As ChartDirector.TextBox

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

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.
fontAngle0The 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.