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

    Class Figure

    Base class providing an event listener API for Deephaven JS client objects.

    Implements

    Index
    title?: string

    The title of the figure, or null if no title was set.

    EVENT_DISCONNECT: string

    This figure has lost its connection to the server. No further events will be fired, and no data will update, until either the connection is reestablished and Figure.EVENT_RECONNECT is fired, or Figure.EVENT_RECONNECTFAILED fires, indicating that it wasn't possible to reconnect and the figure should be recreated/refetched.

    EVENT_DOWNSAMPLEFAILED: string

    Downsampling failed for some reason on one or more series. The event.detail object has three properties: the message string describing what went wrong, the size number showing the full size of the table, and the series property, an array of Series instances affected.

    EVENT_DOWNSAMPLEFINISHED: string

    Downsampling has finished on the given Series instances, and data will arrive shortly. The event.detail value is the array of Series instances.

    EVENT_DOWNSAMPLENEEDED: string

    There are too many points to be drawn in the table which backs these series, and downsampling should be enabled. As an alternative, downsampling can be explicitly disabled, provided there are less than 200,000 rows in the table. The event.detail object has the same properties as Figure.EVENT_DOWNSAMPLEFAILED.

    EVENT_DOWNSAMPLESTARTED: string

    The API is updating how downsampling works on this Figure, probably in response to a call to Axis.range or subscribe. The event.detail value is an array of Series instances which are affected by this.

    EVENT_RECONNECT: string

    This figure has reconnected to the server, and all of its tables are ready to deliver data again. Any subscriptions that were active before the disconnect are restored.

    EVENT_RECONNECTFAILED: string

    This figure failed to reconnect to the server, and is no longer usable. The event.detail value is a FigureFetchError describing what went wrong.

    EVENT_SERIES_ADDED: string

    A series used within this figure was added as part of a multi-series in a chart. The series instance is the detail for this event.

    EVENT_UPDATED: string

    The data within this figure was updated. event.detail is FigureUpdateEventData.

    • get charts(): Chart[]

      The charts to draw.

      Returns Chart[]

    • get cols(): number

      The number of columns in this figure's chart layout.

      Returns number

    • get errors(): string[]

      Any errors that the server reported while building this figure.

      Returns string[]

    • get rows(): number

      The number of rows in this figure's chart layout.

      Returns number

    • get titleColor(): string

      The color to use when drawing the figure's title.

      Returns string

    • get titleFont(): string

      The font to use when drawing the figure's title.

      Returns string

    • get updateInterval(): number

      The update interval of this figure, in milliseconds.

      Returns number

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

    • Close the figure, and clean up subscriptions.

      Returns void

    • 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

    • Disable updates for all series in this figure.

      Returns void