Get Free Trial
API reference
Table of contents

ChartDataObject

An object which contains information about the chart segment. It is used in the customizeChartElement() method and the chartclick event.

The ChartDataObject has the following properties:

  • chartType – String. The selected chart type. This property is returned only with the customizeChartElement() API call.
  • type – String. The element type. Can be either "series" or "series_label". This property is returned only with the customizeChartElement() API call.
  • columns – Array of objects. Column tuple. Each object contains information about the hierarchy members from columns associated with this chart segment.
  • element – Object. The HTML DOM element of the segment.
  • id – String. The id of the segment.
  • label – String. The label of the segment.
  • measure – Object. Measure associated with the segment.
  • rows – Array of objects. Row tuple. Each object contains information about the hierarchy members from rows associated with this chart segment.
  • value – Number. The value of the segment.

See also

customizeChartElement()
chartclick
Customizing the pivot charts