ChartDirector Ver 5.0 (PHP Edition)

Layer.getLegendIcon


Usage

getLegendIcon(dataSetNo)

Description

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

The textual representation can be used in any ChartDirector API that supports the ChartDirector Mark Up Language. A common usage is to insert the icon to a cell in a CDMLTable to label the data series in the table, or to create a custom legend table.

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

Arguments

ArgumentDefaultDescription
dataSetNo(Mandatory)The data set for which the legend icon represents.

Return Value

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