ChartDirector Ver 3.1 (PHP Edition Edition)

PieChart.addExtraField


Usage

addExtraField(texts)

Description

Associate an extra text to each sector.

An extra field is an array of texts that are associated with the sectors (the first element with the first sector, the second element with the second sector, and so on). These texts can be used in methods that supports parameter substitution and formatting.

One common usage of extra field is to associate a hidden ID to each sector, so that when the user clicks on the sector, the hidden ID is passed to the handler as query parameters.

To do this, the hidden IDs can be provided to ChartDirector as an array of text using addExtraField. The extra field can then be included in HTML image maps using BaseChart.getHTMLImageMap.

Another common usage is to include additional information in the sector labels. For example, ICON images for the sectors can be represented as texts using the ChartDirector Mark Up Language. They can then be provided to ChartDirector as an array of text using addExtraField, and be included in sector labels using PieChart.setLabelFormat.

Arguments

ArgumentDefaultDescription
texts(Mandatory)An array of text to be associated to the sectors.

Return Value

None