Class Figure

constructor

• new Figure(): Figure

• Returns Figure

Optional Readonly title

Static Readonly EVENT_DISCONNECT

Static Readonly EVENT_DOWNSAMPLEFAILED

Static Readonly EVENT_DOWNSAMPLEFINISHED

Static Readonly EVENT_DOWNSAMPLENEEDED

Static Readonly EVENT_DOWNSAMPLESTARTED

Static Readonly EVENT_RECONNECT

Static Readonly EVENT_RECONNECTFAILED

Static Readonly EVENT_SERIES_ADDED

Static Readonly EVENT_UPDATED

charts

• get charts(): Chart[]

• The charts to draw.

  Returns Chart[]

  dh.plot.Chart

cols

• get cols(): number

• Returns number

errors

• get errors(): string[]

• Returns string[]

rows

• get rows(): number

• Returns number

titleColor

• get titleColor(): string

• Returns string

titleFont

• get titleFont(): string

• Returns string

updateInterval

• get updateInterval(): number

• Returns number

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

    • Listen for events on this object.

      Returns void

      Returns a cleanup function.

close

• close(): void

• Close the figure, and clean up subscriptions.

  Returns void

hasListeners

• hasListeners(name): boolean

• Parameters

  • name: string

  Returns boolean

nextEvent

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

• Type Parameters

  • T

  Parameters

  • eventName: string

  • Optional timeoutInMillis: number

  Returns Promise<Event<T>>

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

subscribe

• subscribe(forceDisableDownsample?): void

• Parameters

  • Optional forceDisableDownsample: DownsampleOptions

  Returns void

unsubscribe

• unsubscribe(): void

• Disable updates for all series in this figure.

  Returns void

Static create

• create(config): Promise<Figure>

• Parameters

  • config: FigureDescriptor

  Returns Promise<Figure>