Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IUpdateSuspender

Go to JavaScript Charting Documentation
Go to JavaScript Chart Examples
Go to SciChart.js on Github

Defines the interface to an UpdateSuspender, a class which allows nested suspend/resume operations on an ISuspendable target

Hierarchy

  • IUpdateSuspender

Implemented by

Index

Properties

Methods

Properties

Readonly isSuspended

isSuspended: boolean

Gets a value indicating whether updates for the target are currently suspended

onResumed

onResumed: EventHandler<void>

An EventHandler that fires an event when the suspender is becomes unsuspended

Methods

lock

  • lock(): () => boolean
  • experimental

    Call this to force suspend drawing.

    remarks

    All of the unlock tokens have to be called to resume drawing.

    Returns () => boolean

    an unlock token.

      • (): boolean

      • Returns boolean

resume

  • resume(force: boolean): void

  • Call to resume updates on the target. Note this MUST be called or your target will stay suspended forever!

    remarks

    to resume call this the same number of times as { @link IUpdateSuspender.suspend }, or call with force flag to ignore multiple suspend executions

    Parameters

    • force: boolean

    Returns void

suspend

  • suspend(): void

  • Call to suspend updates on the target. Increments call counter.

    Returns void

Generated using TypeDoc