Optional Readonly titleThe title of the figure, or null if no title was set.
Static Readonly EVENT_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 EVENT_RECONNECT is fired, or EVENT_RECONNECTFAILED fires, indicating that it wasn't possible to reconnect and the figure should be recreated/refetched.
Static Readonly EVENT_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.
Static Readonly EVENT_Downsampling has finished on the given Series instances, and data will arrive shortly. The
event.detail value is the array of Series instances.
Static Readonly EVENT_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 EVENT_DOWNSAMPLEFAILED.
Static Readonly EVENT_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.
Static Readonly EVENT_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.
Static Readonly EVENT_This figure failed to reconnect to the server, and is no longer usable. The event.detail value is a
FigureFetchError describing what went wrong.
Static Readonly EVENT_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.
Static Readonly EVENT_The data within this figure was updated. event.detail is FigureUpdateEventData.
The number of columns in this figure's chart layout.
Any errors that the server reported while building this figure.
The number of rows in this figure's chart layout.
The color to use when drawing the figure's title.
The font to use when drawing the figure's title.
The update interval of this figure, in milliseconds.
Listen for events on this object.
The type of the data that the event will provide.
The name of the event to listen for.
A function to call when the event occurs.
Returns a cleanup function.
Listen for events on this object.
Returns a cleanup function.
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.
The type of the event detail.
The event name.
Optional timeoutInMillis: numberOptional timeout in milliseconds.
A promise that resolves with the next matching event.
Removes an event listener added to this table.
Subscribe to the underlying tables to receive updates for all series in this figure.
Optional forceDisableDownsample: DownsampleOptionsthe downsampling behavior to use for every series in this figure. Pass dh.plot.DISABLE to load all data without downsampling, or omit the argument to use dh.plot.DEFAULT.
Static create
Base class providing an event listener API for Deephaven JS client objects.