Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Type parameters

Hierarchy

Implements

Index

Properties

invalidateParentCallback

invalidateParentCallback: () => void

A callback to invalidate the parent SciChartSurfaceBase

Type declaration

    • (): void
    • Returns void

Protected isAttachedProperty

isAttachedProperty: boolean

Protected isEnabledProperty

isEnabledProperty: boolean = true

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.

Protected mousePoint

mousePoint: Point

Protected receiveHandledEventsProperty

receiveHandledEventsProperty: boolean

Accessors

canReceiveMouseEvents

  • get canReceiveMouseEvents(): boolean
  • When true, this modifier can receive mouse events

    inheritdoc

    Returns boolean

executeOn

  • The operation that modifier should respond to

    inheritdoc

    Returns EExecuteOn

  • The operation that modifier should respond to

    inheritdoc

    Parameters

    Returns void

isAttached

  • get isAttached(): boolean
  • When true, the modifier is attached to a SciChartSurfaceBase

    inheritdoc

    Returns boolean

isEnabled

  • get isEnabled(): boolean
  • set isEnabled(isEnabled: boolean): void
  • When true, the modifier is enabled

    inheritdoc

    Returns boolean

  • When true, the modifier is enabled

    inheritdoc

    Parameters

    • isEnabled: boolean

    Returns void

modifierType

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

    inheritdoc

    Returns EModifierType

parentSurface

  • get parentSurface(): TSurfaceType
  • inheritdoc

    Returns TSurfaceType

receiveHandledEvents

  • get receiveHandledEvents(): boolean
  • set receiveHandledEvents(receiveHandledEvents: boolean): void
  • When true, this modifier should receive events which have been handled by modifiers higher up in the call hierachy.

    inheritdoc

    Returns boolean

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

    inheritdoc

    Parameters

    • receiveHandledEvents: boolean

    Returns void

Methods

applyTheme

modifierDoubleClick

  • inheritdoc

    Parameters

    Returns void

modifierMouseDown

  • inheritdoc

    Parameters

    Returns void

modifierMouseEnter

  • inheritdoc

    Parameters

    Returns void

modifierMouseLeave

  • inheritdoc

    Parameters

    Returns void

modifierMouseMove

  • inheritdoc

    Parameters

    Returns void

modifierMouseUp

  • inheritdoc

    Parameters

    Returns void

modifierMouseWheel

  • inheritdoc

    Parameters

    Returns void

modifierPointerCancel

  • inheritdoc

    Parameters

    Returns void

Protected notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void
  • Notifies the parent surface that a property has changed by calling invalidateParentCallback

    Parameters

    • propertyName: string

      the property name which has changed

    Returns void

onAttach

  • onAttach(): void

onAttachSeries

onDetach

  • onDetach(): void

onDetachSeries

onParentSurfaceRendered

  • onParentSurfaceRendered(): void

setParentSurface

Generated using TypeDoc