StockChartX Web & Mobile

Class: MouseHoverGesture

StockChartX. MouseHoverGesture

new MouseHoverGesture(config)

Represents mouse hover gesture.
Parameters:
Name Type Argument Description
config Object <optional>
 The configuration object.
Properties
Name Type Argument Default Description
enterEventEnabled Boolean <optional>
 true The flag that indicates whether mouse enter event should be raised.
hoverEventEnabled Boolean <optional>
 true The flag that indicates whether mouse hover event should be raised.
leaveEventEnabled Boolean <optional>
 true The flag that indicates whether mouse leave event should be raise.

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:

enterEnabled :boolean

The flag that indicates whether mouse enter event should be raised.
Type:
  • boolean
See:

handler :StockChartX.Gesture~GestureHandler

Gesture event handler
Type:
Inherited From:

hitTest :StockChartX.Gesture~GestureHitTestHandler

Hit test function.
Type:
Inherited From:

hoverEnabled :boolean

The flag that indicates whether mouse hover event should be raised.
Type:
  • boolean
See:

leaveEnabled :boolean

The flag that indicates whether mouse leave event should be raised.
Type:
  • boolean
See:

<readonly> state :number

Current gesture state.
Type:
  • number
Inherited From:

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