All documentation
  • API Reference for older versions
  • ChartDataObject

    An object that contains information about the chart segment. It is used in the customizeChartElement(), chartclick event, and other methods and events.

    Properties

    {
      chartType: string,
      type: string,
      columns: object[],
      element: object,
      id: string,
      label: string,
      measure: object,
      rows: object[],
      value: number
    }
    Property/TypeDescription
    chartType
    String
    The selected chart type. This property is included only in the data parameter of the customizeChartElement() API call.
    type
    String
    Type of the chart element. Possible values:
    • "series" — if the element is a graphical chart element (e.g., bar or pie slice).
    • "series_label" — if the element is a data label. Data labels are present on the chart only when the chart.showDataLabels option is set to true.
    This property is included only in the data parameter of the customizeChartElement() API call.
    columns
    Object[]
    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
    Object[]
    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