StockChartX Web & Mobile

Class: PanGesture

StockChartX. PanGesture

new PanGesture(config)

Represents pan gesture.
Parameters:
Name Type Argument Description
config Object <optional>
 The configuration object.
Properties
Name Type Argument Default Description
minMoveDistance Number <optional>
 1 The min move distance. Gesture raises move events only if pointer moved more than this distance.
horizontalMoveEnabled Boolean <optional>
 true The flag that indicates whether horizontal move is enabled.
verticalMoveEnabled Boolean <optional>
 true The flag that indicates whether vertical move is enabled.

Extends

Members

button :number

The mouse button that needs to be used in gesture.
Type:
  • number
Inherited From:

context :Object

The execution context.
Type:
  • Object
Inherited From:

handler :StockChartX.Gesture~GestureHandler

Gesture event handler
Type:
Inherited From:

hitTest :StockChartX.Gesture~GestureHitTestHandler

Hit test function.
Type:
Inherited From:

horizontalMoveEnabled :boolean

Gets/Sets flag that indicates whether horizontal move is enabled.
Type:
  • boolean
See:

minMoveDistance :number

Gets/Sets min move distance. Move events are raised only if pointer moved more than this value.
Type:
  • number

<readonly> moveOffset :StockChartX.Point

The current move offset in pixels.
Type:

<readonly> state :number

Current gesture state.
Type:
  • number
Inherited From:

verticalMoveEnabled :boolean

Gets/Sets flag that indicates whether vertical move is enabled.
Type:
  • boolean
See:

Methods

handleEvent(event)

Handles event.
Parameters:
Name Type Description
event StockChartX.WindowEvent The event object.
Inherited From:
Returns:
True if event was handled, false otherwise.
Type
boolean

isActive()

Checks if gesture is active (in STARTED or CONTINUED state).
Inherited From:
Returns:
Type
boolean