Class: AbstractGestureTool

• new AbstractGestureTool(options)

• Protected new AbstractGestureTool(options)

AbstractTool.constructor

▸ dispose(): void

Function to clean up the references from this tool.

void

AbstractTool.dispose

▸ getClassName(): string

string

AbstractTool.getClassName

▸ getName(): string

Returns the tool name.

string

The tool's name

AbstractTool.getName

▸ getOptions(): Required<Options>

Get abstract gesture tool options

Required<Options>

options

AbstractTool.getOptions

▸ getPlot(): Plot

Get the plot of this Tool.

Plot

AbstractTool.getPlot

▸ hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

boolean

AbstractTool.hasEventListener

▸ isArmed(): boolean

Return if this tool is 'armed'.
The tool actions are disabled when not armed.
A tool can either be armed at all time, or only when a specific key is pressed. To set/unset the arming key, please see this tool option 'armingkey', via .setOptions().

boolean

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractTool.isDisposed

▸ isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

boolean

AbstractTool.isSilent

▸ isTouchEvent(eventArgs): boolean

return true if the event is a touch event and false otherwise.

boolean

AbstractTool.isTouchEvent

▸ notify<E>(type, source, args?): AbstractGestureTool

Notify listeners

AbstractGestureTool

this

AbstractTool.notify

▸ off<E>(type?, callback?): AbstractGestureTool

Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.

AbstractGestureTool

this

AbstractTool.off

▸ on<E>(type, callback): AbstractGestureTool

Attach listener on event that will be called whenever the specified event is delivered to the target

If the callback function is already in the list of event listeners for this target, the function is not added a second time.

If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.

AbstractGestureTool

this

AbstractTool.on

▸ onContext(event): void

Called when a 'context' event has occurred

void

AbstractTool.onContext

▸ Abstract onCursorMove(event): void

Called when a 'onCursorMove' event has occurred

void

▸ onDoubleClick(event): void

Called when a 'doubleclick' event has occurred

void

AbstractTool.onDoubleClick

▸ Abstract onDoubleTap(event): void

Called when a 'onDoubleTap' event has occurred

void

▸ Abstract onDrag(event): void

Called when a 'onDrag' event has occurred

void

▸ Abstract onDragEnd(event): void

Called when a 'onDragEnd' event has occurred

void

▸ Abstract onDragStart(event): void

Called when a 'onDragStart' event has occurred

void

▸ Abstract onKey(event): void

Called when a 'onKey' event has occurred

void

▸ onKeyDown(event): void

Called when a 'keydown' event has occurred

void

AbstractTool.onKeyDown

▸ Abstract onKeyEnd(event): void

Called when a 'onKeyEnd' event has occurred

void

▸ Abstract onKeyStart(event): void

Called when a 'onKeyStart' event has occurred

void

▸ onKeyUp(event): void

Called when a 'keyup' event has occurred

void

AbstractTool.onKeyUp

▸ onMouseDown(event): void

Called when a 'mousedown' event has occurred

void

AbstractTool.onMouseDown

▸ onMouseMove(event): void

Called when a 'mousemove' event has occurred

void

AbstractTool.onMouseMove

▸ onMouseOut(event): void

Called when a 'mouseout' event has occurred

void

AbstractTool.onMouseOut

▸ onMouseUp(event): void

Called when a 'mouseup' event has occurred

void

AbstractTool.onMouseUp

▸ Abstract onMouseWheel(event): void

Called when a 'mousewheel' event has occurred

void

AbstractTool.onMouseWheel

▸ Abstract onPinch(event): void

Called when a 'onPinch' event has occurred

void

▸ Abstract onPinchEnd(event): void

Called when a 'onPinchEnd' event has occurred

void

▸ Abstract onPinchStart(event): void

Called when a 'onPinchStart' event has occurred

void

▸ Abstract onSlide(event): void

Called when a 'onSlide' event has occurred

void

▸ Abstract onSlideEnd(event): void

Called when a 'onSlideEnd' event has occurred

void

▸ Abstract onSlideStart(event): void

Called when a 'onSlideStart' event has occurred

void

▸ Abstract onTap(event): void

Called when a 'onTap' event has occurred

void

▸ onTouchEnd(event): void

Called when a 'touchend' event has occurred

void

AbstractTool.onTouchEnd

▸ onTouchMove(event): void

Called when a 'touchmove' event has occurred

void

AbstractTool.onTouchMove

▸ onTouchStart(event): void

Called when a 'touchstart' event has occurred

void

AbstractTool.onTouchStart

▸ onVisibilityChanged(event): void

Called when a 'onVisibilityChanged' event has occurred

void

AbstractTool.onVisibilityChanged

▸ Abstract onVisibilityGained(event): void

Called when a 'onVisibilityGained' event has occurred

void

▸ Abstract onVisibilityLost(event): void

Called when a 'onVisibilityLost' event has occurred

void

▸ setOptions(options): AbstractGestureTool

Set options, the given json will be merged with the object's state so that only the given options will be changed.

AbstractGestureTool

this

AbstractTool.setOptions

▸ setSilent(bool): AbstractGestureTool

Set silent mode

AbstractGestureTool

this

AbstractTool.setSilent

▸ setup(deviceSupport): AbstractGestureTool

This function allows tools to bind their events to the device support

AbstractGestureTool

AbstractTool.setup

▸ Static getClassName(): string

string

AbstractTool.getClassName