Class: AbstractTool

• [new AbstractTool(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.tool.abstracttool.abstracttool.md#new abstracttool(options))

• Protected new AbstractTool(options)

EventDispatcher.constructor

▸ dispose(): void

Disposes the tool

void

EventDispatcher.dispose

▸ getClassName(): string

string

EventDispatcher.getClassName

▸ getName(): string

Returns the tool name.

string

The tool's name

▸ getOptions(): Required<Options&gt;

Get abstract tool options

Required<Options&gt;

options

▸ getPlot(): Plot

Get the plot of this Tool.

Plot

▸ hasEventListener(type, callback?): boolean

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

boolean

EventDispatcher.hasEventListener

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

EventDispatcher.isDisposed

▸ isSilent(): boolean

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

boolean

EventDispatcher.isSilent

▸ isTouchEvent(eventArgs): boolean

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

boolean

▸ notify<E&gt;(type, source, args?): AbstractTool

Notify listeners

AbstractTool

this

EventDispatcher.notify

▸ off<E&gt;(type?, callback?): AbstractTool

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.

AbstractTool

this

EventDispatcher.off

▸ on<E&gt;(type, callback): AbstractTool

Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> 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. </p>

AbstractTool

this

EventDispatcher.on

▸ Abstract onContext(event): void

Called when a 'context' event has occurred

void

▸ Abstract onDoubleClick(event): void

Called when a 'doubleclick' event has occurred

void

▸ Abstract onKeyDown(event): void

Called when a 'keydown' event has occurred

void

▸ Abstract onKeyUp(event): void

Called when a 'keyup' event has occurred

void

▸ Abstract onMouseDown(event): void

Called when a 'mousedown' event has occurred

void

▸ Abstract onMouseMove(event): void

Called when a 'mousemove' event has occurred

void

▸ Abstract onMouseOut(event): void

Called when a 'mouseout' event has occurred

void

▸ Abstract onMouseUp(event): void

Called when a 'mouseup' event has occurred

void

▸ Abstract onMouseWheel(event): void

Called when a 'mousewheel' event has occurred

void

▸ Abstract onTouchEnd(event): void

Called when a 'touchend' event has occurred

void

▸ Abstract onTouchMove(event): void

Called when a 'touchmove' event has occurred

void

▸ Abstract onTouchStart(event): void

Called when a 'touchstart' event has occurred

void

▸ Abstract onVisibilityChanged(event): void

Called when a 'onVisibilityChanged' event has occurred

void

▸ setOptions(options): AbstractTool

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

AbstractTool

this

▸ setSilent(bool): AbstractTool

Set silent mode

AbstractTool

this

EventDispatcher.setSilent

▸ setup(deviceSupport): AbstractTool

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

AbstractTool

▸ Static getClassName(): string

string

EventDispatcher.getClassName