Options
All
  • Public
  • Public/Protected
  • All
Menu

The MouseManager handles mouse and touch events from any IEventListenerSource and publishes events to any IReceiveMouseEvents type

remarks

Used internally by the SciChartSurface and SciChart3DSurface to manage and route mouse eents

Hierarchy

  • MouseManager

Index

Constructors

constructor

Properties

Protected doubleTapHandled

doubleTapHandled: boolean

Tracks status of double tap event. Positive value means that polyfill was used to handle the event.

enableDoubleTapPolyfill

enableDoubleTapPolyfill: boolean = true

Toggles usage of double tap polyfill

forceDoubleTapPolyfill

forceDoubleTapPolyfill: boolean = false

Defines whether double tap polyfill should always be used

isOver

isOver: boolean = false

For subCharts - to track if the mousepointer is over the subChart, so we can fake Enter and Leave events

Protected lastTapTime

lastTapTime: number

maxTapDuration

maxTapDuration: number = 500

Max allowed interval between taps for them to be considered a double tap action.

remarks

used by double tap polyfill

sciChartSurface

sciChartSurface: SciChartSurfaceBase

The target SciChartSurfaceBase that we are listening to events on

Protected supportsDoubleTap

supportsDoubleTap: boolean

Tracks if double tap action fired dbclick event

Methods

getMasterData

  • Get data from the master surface which will be passed to other surfaces when modifierGroups are used. Use this if you want to use the data value from the master surface in the modifier on the other surfaces

    Parameters

    Returns any

modifierDoubleClick

modifierDrop

modifierMouseDown

modifierMouseEnter

modifierMouseLeave

modifierMouseMove

modifierMouseUp

modifierMouseWheel

modifierPointerCancel

  • Parameters

    Returns void

onContextMenu

  • onContextMenu(event: MouseEvent): void
  • Internal function called when 'contextmenu' event is fired on the target element

    Parameters

    • event: MouseEvent

      The {@link PointerEvent}

    Returns void

onDoubleClick

  • onDoubleClick(event: MouseEvent): void
  • Internal function called when 'dblclick' event is fired on the target element

    Parameters

    • event: MouseEvent

      The {@link PointerEvent}

    Returns void

onDrop

  • onDrop(event: MouseEvent): void
  • Parameters

    • event: MouseEvent

    Returns void

onMouseEnter

  • onMouseEnter(event: MouseEvent): void
  • Internal function called when 'mouseenter' event is fired on the target element

    Parameters

    • event: MouseEvent

      The {@link PointerEvent}

    Returns void

onMouseLeave

  • onMouseLeave(event: MouseEvent): void
  • Internal function called when 'mouseleave' event is fired on the target element

    Parameters

    • event: MouseEvent

      The {@link PointerEvent}

    Returns void

onMouseWheel

  • onMouseWheel(event: WheelEvent): void
  • Internal function called when 'wheel' event is fired on the target element

    Parameters

    • event: WheelEvent

      The {@link PointerEvent}

    Returns void

onPointerCancel

  • onPointerCancel(event: PointerEvent): void
  • Parameters

    • event: PointerEvent

    Returns void

onPointerDown

  • onPointerDown(event: PointerEvent): void
  • Internal function called when 'pointerdown' event is fired on the target element

    Parameters

    • event: PointerEvent

      The {@link PointerEvent}

    Returns void

onPointerMove

  • onPointerMove(event: PointerEvent): void
  • Internal function called when 'pointermove' event is fired on the target element

    Parameters

    • event: PointerEvent

      The {@link PointerEvent}

    Returns void

onPointerUp

  • onPointerUp(event: PointerEvent): void
  • Internal function called when 'pointerup' event is fired on the target element

    Parameters

    • event: PointerEvent

      The {@link PointerEvent}

    Returns void

subscribe

  • Used internally - subscribes to mouse events on the source

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void
  • Used internally - unsubscribes from mouse events

    Returns void

Generated using TypeDoc