ChartDirector 7.0 (Perl Edition)

Layer.getLegendIcon


Usage

getLegendIcon(dataSetNo)

Description

Gets the CDML representation of the legend icon for a data set.

The CDML representation can be used in any ChartDirector API that supports CDML. Note that the CDML representation is only valid in the BaseChart object that contains the data set. It is not allowed to use the CDML representation obtained from one chart in a different chart.

The legend icon is the same icon that would appear in the LegendBox. If you modify the icon using methods of the LegendBox object (such as using LegendBox.setKeyBorder to set the legend icon border), the modification will also apply to the icon returned by this method.

Arguments

ArgumentDefaultDescription
dataSetNo(Mandatory)The index of the data set. The index of the first data set added to the layer is 0. The index of the Nth data set added to the layer is N - 1.

Return Value

The CDML representation of the legend icon for the data set.