Class Chart

Optional Readonly title

Static Readonly EVENT_SERIES_ADDED

axes

• get axes(): Axis[]

• The axes used in this chart.

  Returns Axis[]

chartType

• get chartType(): number

• The type of this chart. See ChartType for more details.

  Returns number

colspan

• get colspan(): number

• The number of columns this chart spans in the figure layout.

  Returns number

column

• get column(): number

• The column position of this chart in the figure layout.

  Returns number

is3d

• get is3d(): boolean

• Whether this chart is rendered in 3D.

  Returns boolean

legendColor

• get legendColor(): string

• The color used to render the chart legend.

  Returns string

legendFont

• get legendFont(): string

• The font used to render the chart legend.

  Returns string

multiSeries

• get multiSeries(): MultiSeries[]

• Gets the chart multi-series array.

  Returns MultiSeries[]

row

• get row(): number

• The row position of this chart in the figure layout.

  Returns number

rowspan

• get rowspan(): number

• The number of rows this chart spans in the figure layout.

  Returns number

series

• get series(): Series[]

• Gets a copy of the chart series array.

  Returns Series[]

showLegend

• get showLegend(): boolean

• Whether the chart legend is shown.

  Returns boolean

titleColor

• get titleColor(): string

• The color used to render the chart title.

  Returns string

titleFont

• get titleFont(): string

• The font used to render the chart title.

  Returns string

addEventListener

• addEventListener<T>(name, callback): (() => void)

• Listen for events on this object.

  Type Parameters

  • T

    The type of the data that the event will provide.

  Parameters

  • name: string

    The name of the event to listen for.

  • callback: ((e) => void)

    A function to call when the event occurs.

    • • (e): void

      • Parameters

        • e: Event<T>

        Returns void

  Returns (() => void)

  Returns a cleanup function.

  • • (): void

    • Returns void

hasListeners

• hasListeners(name): boolean

• Checks whether any event listeners are registered for the given event name.

  Parameters

  • name: string

    The event name.

  Returns boolean

  true if there is at least one listener registered for name; false otherwise.

nextEvent

• nextEvent<T>(eventName, timeoutInMillis?): Promise<Event<T>>

• Returns a promise that resolves the next time the named event occurs, with the value of the event's detail. If a timeout is specified and occurs before the event takes place, the promise will reject, otherwise waits indefinitely.

  Type Parameters

  • T

    The type of the event detail.

  Parameters

  • eventName: string

    The event name.

  • Optional timeoutInMillis: number

    Optional timeout in milliseconds.

  Returns Promise<Event<T>>

  A promise that resolves with the next matching event.

removeEventListener

• removeEventListener<T>(name, callback): boolean

• Removes an event listener added to this table.

  Type Parameters

  • T

  Parameters

  • name: string

  • callback: ((e) => void)

    • • (e): void

      • Parameters

        • e: Event<T>

        Returns void

  Returns boolean