Options
All
  • Public
  • Public/Protected
  • All
Menu

Mouse arguments passed to ChartModifierBase methods

Hierarchy

Index

Constructors

constructor

Properties

Readonly altKey

altKey: boolean

When true, the Alt Key is currently pressed

Readonly button

button: number

The mouse button number that was pressed

Readonly ctrlKey

ctrlKey: boolean

When true, the Ctrl Key is currently pressed

handled

handled: boolean = false

Gets or sets whether the event is handled

remarks

Set handled to true if you want to prevent the event from propagating to subsequent modifiers in the parent SciChartSurfaceBase.chartModifiers collection

If handled is true, the events no longer propagate. To override this behaviour set ChartModifierBase.receiveHandledEvents to true

Readonly isMaster

isMaster: boolean

When true, the event was raised from the master or parent SciChartSurfaceBase, else it came from the child SciChartSurfaceBase

remarks

This is relevant in the case of linking together multiple charts

Readonly modifierGroup

modifierGroup: string

The Modifier Group string is an ID which is used to group together Chart Modifiers when used in a multi-chart scenario

Readonly mousePoint

mousePoint: Point

The MousePoint as an X,Y coordinate where the event occurred

Readonly mouseWheelDelta

mouseWheelDelta: number

The mouse wheel delta as a positive or negative value depending on mouse wheel direction

pointerId

pointerId: number

The PointerId associated with the current pointer or stylus device

pointerType

pointerType: string

The type of the current Pointer or stylus

Readonly shiftKey

shiftKey: boolean

When true, the Shift Key is currently pressed

target

target: Element

The target {@link Element} which raised the event

Methods

Static copy

  • Copies or clones a ModifierMouseArgs

    Parameters

    • args: ModifierMouseArgs

      the ModifierMouseArgs instance

    • modifierGroup: string

      the Modifier Group / string ID for sharing mouse events

    • masterViewport: Rect

      the master viewport or parent chart issuing mouse events

    • slaveViewport: Rect

      the slave viewport or child chart receiving mouse events

    Returns ModifierMouseArgs

Static fromMouseEvent

  • Creates a ModifierMouseArgs instance from Javascript {@link MouseEvent}

    Parameters

    • mouseEvent: MouseEvent

      the Javascript {@link MouseEvent}

    Returns ModifierMouseArgs

Static fromPointerEvent

  • Creates a ModifierMouseArgs instance from Javascript {@link PointerEvent}

    Parameters

    • pointerEvent: PointerEvent

    Returns ModifierMouseArgs

Static fromWheelEvent

  • Creates a ModifierMouseArgs instance from Javascript {@link WheelEvent}

    Parameters

    • wheelEvent: WheelEvent

    Returns ModifierMouseArgs

Generated using TypeDoc