Options
All
  • Public
  • Public/Protected
  • All
Menu

Defines the interface to a Chart Modifier - a class which provides Zoom, Pan, Tooltip or interaction behavior to SciChart - High Performance Realtime JavaScript Charts

Hierarchy

Implemented by

Index

Properties

canReceiveMouseEvents

canReceiveMouseEvents: boolean

When true, this modifier can receive mouse events

executeOn

executeOn: EExecuteOn

The operation that modifier should respond to

Readonly id

id: string

A unique Id for the IChartModifierBase

invalidateParentCallback

invalidateParentCallback: () => void

A callback to invalidate the parent SciChartSurfaceBase

Type declaration

    • (): void
    • Returns void

isAttached

isAttached: boolean

When true, the modifier is attached to a SciChartSurfaceBase

remarks

Set internally by SciChart on attaching to a parent surface

isEnabled

isEnabled: boolean

When true, the modifier is enabled

modifierGroup

modifierGroup: string

Specifies a string ID to group modifiers.

remarks

When one receives a mouse event, all modifiers in the same group receive the event.

modifierType

modifierType: EModifierType

The type of Chart Modifier, see EModifierType for a list of values

receiveHandledEvents

receiveHandledEvents: boolean

When true, this modifier should receive events which have been handled by modifiers higher up in the call hierachy.

remarks

Use this property to solve issues related to events being consumed by modifiers and not passed down

Methods

applyTheme

delete

  • delete(): void
  • Deletes native (WebAssembly) memory used by this type, after which it cannot be used.

    remarks

    Call .delete() before finishing with the object to ensure that WebAssmembly memory leaks do not occur.

    All elements within SciChart's High Performance Realtime JavaScript Charts which implement IDeletable must be deleted manually to free native (WebAssembly) memory

    Returns void

modifierDoubleClick

modifierMouseDown

modifierMouseEnter

modifierMouseLeave

modifierMouseMove

modifierMouseUp

modifierMouseWheel

modifierPointerCancel

onAttach

  • onAttach(): void
  • Called when the modifier is attached to a parent SciChartSurfaceBase

    Returns void

onAttachSeries

onDetach

  • onDetach(): void
  • Called when the modifier is detached from a parent SciChartSurfaceBase

    Returns void

onDetachSeries

  • Called when a RenderableSeries is detached from this modifier

    Parameters

    Returns void

onParentSurfaceRendered

  • onParentSurfaceRendered(): void
  • Called when the parent SciChartSurfaceBase is rendered

    Returns void

setParentSurface

Optional toJSON

  • toJSON(): any
  • Convert the object to a definition that can be serialized to JSON, or used directly with the builder api

    Returns any

Generated using TypeDoc