@deephaven/jsapi-types
    Preparing search index...

    Class Chart

    Provides the details for a chart.

    Implements

    Index
    title?: string

    The title of the chart.

    EVENT_SERIES_ADDED: string

    Fired when a new series is added to this chart as part of a multi-series chart. The event detail is the added series instance.

    • get axes(): Axis[]

      The axes used in this chart.

      Returns Axis[]

    • get chartType(): number

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

      Returns number

    • get colspan(): number

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

      Returns number

    • get column(): number

      The column position of this chart in the figure layout.

      Returns number

    • get is3d(): boolean

      Whether this chart is rendered in 3D.

      Returns boolean

    • get legendColor(): string

      The color used to render the chart legend.

      Returns string

    • get legendFont(): string

      The font used to render the chart legend.

      Returns string

    • get row(): number

      The row position of this chart in the figure layout.

      Returns number

    • get rowspan(): number

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

      Returns number

    • get series(): Series[]

      Gets a copy of the chart series array.

      Returns Series[]

    • get showLegend(): boolean

      Whether the chart legend is shown.

      Returns boolean

    • get titleColor(): string

      The color used to render the chart title.

      Returns string

    • get titleFont(): string

      The font used to render the chart title.

      Returns string

    • 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: Event<T>) => void

        A function to call when the event occurs.

      Returns () => void

      Returns a cleanup function.

    • 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.

    • 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.

      • OptionaltimeoutInMillis: number

        Optional timeout in milliseconds.

      Returns Promise<Event<T>>

      A promise that resolves with the next matching event.

    • Removes an event listener added to this table.

      Type Parameters

      • T

      Parameters

      • name: string
      • callback: (e: Event<T>) => void

      Returns boolean