Get Free Trial
API reference
Table of contents

ChartLegendDataObject

An object which contains information about the chart legend element. It is needed to customize the pivot charts.

The ChartLegendDataObject has the following properties:

  • chartType – String. The selected chart type.
  • type – String. The element type. For the ChartLegendDataObject it is "legend".
  • label – String. The legend element’s label.
  • color – String. The color of the series connected with the legend element.
  • tuple – Array of objects. Each object contains information about the hierarchy members associated with this chart segment.
  • member – Object. A member connected with the legend element.
  • measure – Object. A measure connected with the legend element.
  • level – Number. The nesting level of the legend element.
  • isExpanded – Boolean. Indicates whether the legend element is expanded (true) or not (false).
  • isCollapsed – Boolean. Indicates whether the legend element is collapsed (true) or not (false).
  • isDrilledUp – Boolean. Indicates whether the legend element is drilled up (true) or not (false).
  • isDrilledDown – Boolean. Indicates whether the legend element is drilled down (true) or not (false).

See also

Customizing the pivot charts
customizeChartElement()