[API](/solutions/geotoolkit/geotoolkit_js/apis/readme) / [geotoolkit](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit) / [controls](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls) / [tools](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#tools) / [html](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#html) / [Editor](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#editor) / Editor # Class: Editor [html](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#html).[Editor](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#editor).Editor Creates default implementation of the inline-text editor Tool name: 'inline-editor' **`Example`** ```ts import {CompositeShape} from './ts/shapes/CompositeShape'; import {Events as SelectionEvents, Selection} from '@int/geotoolkit/controls/tools/Selection'; import {Editor, Events as EditorEvents} from '@int/geotoolkit/controls/tools/html/Editor'; import type {EditorEventArgs} from '@int/geotoolkit/controls/tools/html/EditorEventArgs'; private initializeDoubleClickSelection (manipulatorLayer: Layer) { const selectionTool = new Selection(manipulatorLayer) .setRootNode(manipulatorLayer.getRoot()) .on(SelectionEvents.onDoubleClick, (evt, sender, eventArgs) => { const visual: CompositeShape = sender.getSelection() .filter((node) => node instanceof CompositeShape)[0] as CompositeShape; if (visual != null) { const textGeometry: Editor.EditOptions = { node: visual, bounds: visual.getFrame(), text: visual.getText(), textstyle: visual.getTextStyle(), fillstyle: visual.getFillStyle(), linestyle: visual.getLineStyle(), padding: null }; eventArgs.stopPropagation(); this._inlineEditor.edit(textGeometry); } }); return selectionTool; } ... this._plot.getTool() .add([ this.initializeDoubleClickSelection(selectionLayer), this._inlineEditor = new Editor({ plot: this._plot }) .on(EditorEvents.onSubmit, (event: EditorEvents.onSubmit, sender: Editor, eventArgs: EditorEventArgs) => { const visual = sender.getNode(); if (visual instanceof CompositeShape) { visual.setText(eventArgs.getText()); } }) ]); ``` ## Hierarchy - [`AbstractTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool) ↳ **`Editor`** ## Table of contents Constructors - [new Editor(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.controls.tools.html.editor.editor.md#new editor(options)) Methods | [addListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#addlistener) | [captureMouseUp](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#capturemouseup) | [dispose](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#dispose) | | --- | --- | --- | | [edit](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#edit) | [fireEvent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#fireevent) | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#getclassname) | | [getEventRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#geteventradius) | [getLocalTransform](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#getlocaltransform) | [getManipulatorLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#getmanipulatorlayer) | | [getMouseRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#getmouseradius) | [getName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#getname) | [getNode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#getnode) | | [getParentTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#getparenttool) | [getPlot](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#getplot) | [getProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#getproperties) | | [getProperty](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#getproperty) | [getPropertyKeys](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#getpropertykeys) | [getRoot](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#getroot) | | [getTouchRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#gettouchradius) | [hasEventListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#haseventlistener) | [hideEditor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#hideeditor) | | [isActive](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#isactive) | [isDisposed](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#isdisposed) | [isDoubleClick](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#isdoubleclick) | | [isEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#isenabled) | [isSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#issilent) | [isTouchEvent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#istouchevent) | | [notify](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#notify) | [off](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#off) | [on](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#on) | | [onActiveStateChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#onactivestatechanged) | [onEnabledStateChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#onenabledstatechanged) | [pageToCanvas](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#pagetocanvas) | | [pointToModel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#pointtomodel) | [removeListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#removelistener) | [setActive](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#setactive) | | [setEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#setenabled) | [setMouseRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#setmouseradius) | [setName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#setname) | | [setPlot](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#setplot) | [setProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#setproperties) | [setProperty](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#setproperty) | | [setSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#setsilent) | [setSlotEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#setslotenabled) | [setSlots](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#setslots) | | [setTouchRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#settouchradius) | [start](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#start) | [stop](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#stop) | | [toggle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#toggle) | [canvasToClient](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#canvastoclient) | [clientToCanvas](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#clienttocanvas) | | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#getclassname-1) | [getExclusiveTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#getexclusivetool) | [getNativeEventName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#getnativeeventname) | | [isTouchEvent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#istouchevent-1) | [lock](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#lock) | [setDefaultMouseRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#setdefaultmouseradius) | | [setDefaultTouchRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#setdefaulttouchradius) | [unlock](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor#unlock) | Css Properties | Name | Type | Description | | --- | --- | --- | | `enabled` | `boolean` | Enabled state | | `layer` | [`CompositeNode`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.compositenode.compositenode#css-props) | Manipulator layer | | `layer-clipping` | `boolean` | Enable clipping, this does not consider the clipstyle, it is related to bounds-clipping | | `layer-clipstyle` | [`ClipStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.clipstyle.clipstyle#css-props) | Clipping style | | `layer-clipstyle-evenodd` | `boolean` | True if evenodd mode is on ('nonzero' mode otherwise) | | `layer-clipstyle-geometry` | [`GraphicsPath`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.graphicspath.graphicspath#css-props) | Clipping geometry | | `layer-clipstyle-geometry-bounds` | [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect#css-props) | Bounds | | `layer-clipstyle-geometry-bounds-height` | `number` | Height | | `layer-clipstyle-geometry-bounds-readonly` | `boolean` | Readonly | | `layer-clipstyle-geometry-bounds-width` | `number` | Width | | `layer-clipstyle-geometry-bounds-x` | `number` | Left | | `layer-clipstyle-geometry-bounds-y` | `number` | Top | | `layer-clipstyle` | [`GraphicsPath`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.graphicspath.graphicspath#css-props) | Clipping style | | `layer-cssclass` | `string` | The css class name of this node | | `layer-csscursor` | `string` | CSS cursor associated with node | | `layer-cssstyle` | `string` | CSS style to be applied to inserted elements | | `layer-id` | `string | number` | Id of the node, its a unique identifier | | `layer-infinity` | `boolean` | Mode to render outside the model limits | | `layer-localtransform` | [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation#css-props) | Local transformation | | `layer-localtransform-dx` | `number` | X axis translation | | `layer-localtransform-dy` | `number` | Y axis translation | | `layer-localtransform-xx` | `number` | X scale | | `layer-localtransform-xy` | `number` | Xy skew | | `layer-localtransform-yx` | `number` | Yx skew | | `layer-localtransform-yy` | `number` | Y scale | | `layer-margins` | `number | string` | It has properties for specifying the margins for each side | | `layer-name` | `string` | Name of the node. It is often used for debugging purposes or to simplify queries | | `layer-opacity` | `number` | Node opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context | | `layer-opacityblendmode` | [`BlendMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#blendmode#blendmode) | Node opacity mode to blend it | | `layer-scalescrollstrategy` | [`ScaleScrollStrategy`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.scalescrollstrategy.scalescrollstrategy#css-props) | Scale scroll strategy | | `layer-scalescrollstrategy-enabled` | `boolean` | Enable flag | | `layer-selectable` | `boolean` | Selectable node, a boolean to determine if selection should consider this node | | `layer-tag` | `any` | Custom information associated with node. It is a user object which can be used by client code to store information or attach an application object to the shape | | `layer-transform` | `string` | Additional CSS transformation applied to node or 'none' | | `layer-transform` | [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation#css-props) | Additional CSS transformation applied to node or 'none' | | `layer-visible` | `boolean` | Visibility of the node, a boolean to determine if the node should be rendered or not | | `layer-z-index` | `number` | Define node z-index | | `mouseradius` | `number` | Device radius for mouse events | | `name` | `string` | Name of the tool used like cross-hair etc | | `touchradius` | `number` | Device radius for touch events | ## Contents Constructors #### new Editor(options) • **new Editor**(`options?`) Creates instance of inline-text editor tool #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `options` | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#editor#options) | HTML Inline-Editor tool options | #### Overrides AbstractTool.constructor Methods #### addListener ▸ **addListener**(`eventName`, `listener`): [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) add event listener. The listener receives the message when the system event happens. **`Deprecated`** since 4.0 use .on() instead. Note that 3 args callback should be used in subscription via .on(): (eventType, source, args) #### Parameters | Name | Type | Description | | --- | --- | --- | | `eventName` | `string` | event name or unique event identifier | | `listener` | `Function` | the event listener | #### Returns [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[addListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#addlistener) #### captureMouseUp ▸ **captureMouseUp**(): `void` listen to window mouse events in order to catch a mouse up action outside of the tool container DOM element. useful for example when you pan and release click outside of DOM element. #### Returns `void` #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[captureMouseUp](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#capturemouseup) #### dispose ▸ **dispose**(): `void` Dispose tool. #### Returns `void` #### Overrides [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[dispose](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#dispose) #### edit ▸ **edit**(`options`, `eventArgs?`): [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) Start inline-text editor tool, with specific geometry and styles options #### Parameters | Name | Type | Description | | --- | --- | --- | | `options` | [`EditOptions`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#editor#editoptions) | text geometry options | | `Optional` `eventArgs` | [`EventArgs`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.eventargs.eventargs) | optional event args, in case if you start it manually from tools container | #### Returns [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) #### fireEvent ▸ **fireEvent**(`eventName`, `eventArgs?`): `void` This method is Protected. Fire an Event. **`Deprecated`** since 4.0 use .notify() instead. Note that 3 args callback should be used in subscription via .on() #### Parameters | Name | Type | Description | | --- | --- | --- | | `eventName` | `string` | event name | | `Optional` `eventArgs` | `any` | contains info of the event | #### Returns `void` #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[fireEvent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#fireevent) #### getClassName ▸ **getClassName**(): `string` #### Returns `string` #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#getclassname) #### getEventRadius ▸ `Protected` **getEventRadius**(`eventArgs`): `number` Returns device radius for the provided event #### Parameters | Name | Type | Description | | --- | --- | --- | | `eventArgs` | [`EventArgs`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.eventargs.eventargs) | contains info of the event | #### Returns `number` #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[getEventRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#geteventradius) #### getLocalTransform ▸ `Protected` **getLocalTransform**(`node`): [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation) Returns current node local transformation #### Parameters | Name | Type | | --- | --- | | `node` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | #### Returns [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation) #### getManipulatorLayer ▸ **getManipulatorLayer**(): [`CompositeNode`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.compositenode.compositenode)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> return manipulator layer #### Returns [`CompositeNode`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.compositenode.compositenode)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> layer #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[getManipulatorLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#getmanipulatorlayer) #### getMouseRadius ▸ **getMouseRadius**(): `number` Returns current device radius for mouse events #### Returns `number` #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[getMouseRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#getmouseradius) #### getName ▸ **getName**(): `string` return tool name if any #### Returns `string` name of the tool #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[getName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#getname) #### getNode ▸ **getNode**(): [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) Returns current node #### Returns [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) #### getParentTool ▸ **getParentTool**(): [`AbstractCompositeTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstractcompositetool.abstractcompositetool) Gets parent tool #### Returns [`AbstractCompositeTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstractcompositetool.abstractcompositetool) parent tool #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[getParentTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#getparenttool) #### getPlot ▸ **getPlot**(): [`Plot`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.plot.plot.plot) Returns plot #### Returns [`Plot`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.plot.plot.plot) plot #### getProperties ▸ **getProperties**(`context?`): [`OptionsOut`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#abstracttool#optionsout) Returns all the properties pertaining to this object #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `context` | [`ISerializationContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.persistence.iserializationcontext.iserializationcontext) | serialization context | #### Returns [`OptionsOut`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#abstracttool#optionsout) An object containing the properties #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[getProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#getproperties) #### getProperty ▸ **getProperty**(`name`): `any` Gets dynamic property by name. These properties can be used as a property bags #### Parameters | Name | Type | Description | | --- | --- | --- | | `name` | `string` | property name | #### Returns `any` #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[getProperty](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#getproperty) #### getPropertyKeys ▸ **getPropertyKeys**(): `string`[] Returns known properties keys #### Returns `string`[] #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[getPropertyKeys](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#getpropertykeys) #### getRoot ▸ **getRoot**(): [`AbstractCompositeTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstractcompositetool.abstractcompositetool) Gets root tool #### Returns [`AbstractCompositeTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstractcompositetool.abstractcompositetool) parent tool #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[getRoot](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#getroot) #### getTouchRadius ▸ **getTouchRadius**(): `number` Returns current device radius for touch events #### Returns `number` #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[getTouchRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#gettouchradius) #### hasEventListener ▸ **hasEventListener**(`type`, `callback?`): `boolean` Check if a list of event listeners for this type contains this listener #### Parameters | Name | Type | Description | | --- | --- | --- | | `type` | `string` | type of event or property | | `Optional` `callback` | `Function` | to be called, if null, check if any callback is registered | #### Returns `boolean` #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[hasEventListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#haseventlistener) #### hideEditor ▸ **hideEditor**(`submitValue`): [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) #### Parameters | Name | Type | Description | | --- | --- | --- | | `submitValue` | `boolean` | true if value should be submitted | #### Returns [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) #### isActive ▸ **isActive**(): `boolean` return active state #### Returns `boolean` #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[isActive](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#isactive) #### isDisposed ▸ **isDisposed**(): `boolean` Returns whether this object has been disposed #### Returns `boolean` #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[isDisposed](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#isdisposed) #### isDoubleClick ▸ `Protected` **isDoubleClick**(`point`, `eventArgs?`): `boolean` returns true if double clicked #### Parameters | Name | Type | Description | | --- | --- | --- | | `point` | [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) | Click point | | `Optional` `eventArgs` | [`EventArgs`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.eventargs.eventargs) | optional event args to verify double click | #### Returns `boolean` #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[isDoubleClick](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#isdoubleclick) #### isEnabled ▸ **isEnabled**(): `boolean` returns enable state #### Returns `boolean` state #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[isEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#isenabled) #### isSilent ▸ **isSilent**(): `boolean` Return true if the event dispatcher doesn't notify any events #### Returns `boolean` #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[isSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#issilent) #### isTouchEvent ▸ **isTouchEvent**(`eventArgs`): `boolean` return true if the event is a touch event and false otherwise. #### Parameters | Name | Type | Description | | --- | --- | --- | | `eventArgs` | `Event` | [`EventArgs`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.eventargs.eventargs) | contains info of the event | #### Returns `boolean` #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[isTouchEvent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#istouchevent) #### notify ▸ **notify**<`E`>(`type`, `source`, `args?`): [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) Notify listeners #### Type parameters | Name | Type | | --- | --- | | `E` | extends `string` | #### Parameters | Name | Type | Description | | --- | --- | --- | | `type` | `E` | event types | | `source` | [`AbstractTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool) | of the event | | `Optional` `args` | [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#abstracttool#eventmap)[`E`] | arguments of the event | #### Returns [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) this #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[notify](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#notify) #### off ▸ **off**<`E`>(`type?`, `callback?`): [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) 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. #### Type parameters | Name | Type | | --- | --- | | `E` | extends `string` | #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `type` | `E` | type of the event | | `Optional` `callback` | (`eventType`: `E`, `sender`: [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor), `args`: [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#abstracttool#eventmap)[`E`]) => `void` | function to be called | #### Returns [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) this #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[off](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#off) #### on ▸ **on**<`E`>(`type`, `callback`): [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) 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.

TypeScript hint: in case of creating derived tool with own events, EventMap should be extended and .on() and .notify() methods redeclared, see sample. **`Example`** ```ts // Using in derived tool import type {EventMap as EventMapBase} from '@int/geotoolkit/controls/tools/AbstractTool'; export type EventMap = EventMapBase & { [MyToolEvents.onValueChanged]: MyToolEventArgs } export enum MyToolEvents { onValueChanged = 'onValueChanged' } export class MyTool extends AbstractTool { public declare on: <E extends keyof EventMap>(type: E, callback: (eventType: E, sender: this, args: EventMap[E]) => void) => this; protected declare notify: <E extends keyof EventMap>(type: E, source: AbstractTool, args?: EventMap[E]) => this; public declare off: <E extends keyof EventMap>(type: E, callback?: (eventType: E, sender: this, args: EventMap[E]) => void) => this; // ... } ``` #### Type parameters | Name | Type | | --- | --- | | `E` | extends `string` | #### Parameters | Name | Type | Description | | --- | --- | --- | | `type` | `E` | type of event or property | | `callback` | (`eventType`: `E`, `sender`: [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor), `args`: [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#abstracttool#eventmap)[`E`]) => `void` | to be called | #### Returns [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[on](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#on) #### onActiveStateChanged ▸ `Protected` **onActiveStateChanged**(): `void` **`Fires`** [Events.onStateChanged](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#tools#abstracttool#events#onstatechanged) #### Returns `void` #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[onActiveStateChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#onactivestatechanged) #### onEnabledStateChanged ▸ `Protected` **onEnabledStateChanged**(): `void` **`Fires`** [Events.onEnabledStateChanged](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#tools#abstracttool#events#onenabledstatechanged) #### Returns `void` #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[onEnabledStateChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#onenabledstatechanged) #### pageToCanvas ▸ **pageToCanvas**(`eventArgs`, `externalPlot?`): `Object` return position relative to the canvas #### Parameters | Name | Type | Description | | --- | --- | --- | | `eventArgs` | `Event` | [`EventArgs`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.eventargs.eventargs) | parentElement the parent HTML element | | `Optional` `externalPlot` | [`Plot`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.plot.plot.plot) | plot | #### Returns `Object` | Name | Type | | --- | --- | | `x` | `number` | | `y` | `number` | #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[pageToCanvas](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#pagetocanvas) #### pointToModel ▸ **pointToModel**(`model`, `eventArgs`): [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) converts device coordinates to inner coordinates of node #### Parameters | Name | Type | Description | | --- | --- | --- | | `model` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | the model | | `eventArgs` | [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) | [`EventArgs`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.eventargs.eventargs) | arguments of the event OR point in device (plot) coordinates. | #### Returns [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[pointToModel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#pointtomodel) #### removeListener ▸ **removeListener**(`eventName`, `listener?`): [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) remove event listener. The listener reveives the message when the system event happens. **`Deprecated`** since 4.0 use .off() instead. #### Parameters | Name | Type | Description | | --- | --- | --- | | `eventName` | `string` | event name | | `Optional` `listener` | `Function` | `Function`[] | the event listener, if null, remove all listeners for the event | #### Returns [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[removeListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#removelistener) #### setActive ▸ **setActive**(`active`): [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) set active state **`Fires`** [Events.onStateChanged](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#tools#abstracttool#events#onstatechanged) #### Parameters | Name | Type | Description | | --- | --- | --- | | `active` | `boolean` | set active state | #### Returns [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[setActive](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#setactive) #### setEnabled ▸ **setEnabled**(`enabled`): [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) set enable state **`Fires`** [Events.onEnabledStateChanged](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#tools#abstracttool#events#onenabledstatechanged) **`Fires`** [Events.onStateChanged](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#tools#abstracttool#events#onstatechanged) #### Parameters | Name | Type | Description | | --- | --- | --- | | `enabled` | `boolean` | sets the enabled state | #### Returns [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) this #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[setEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#setenabled) #### setMouseRadius ▸ **setMouseRadius**(`radius`): [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) Sets device radius for mouse events #### Parameters | Name | Type | Description | | --- | --- | --- | | `radius` | `number` | radius for mouse events | #### Returns [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) this #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[setMouseRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#setmouseradius) #### setName ▸ **setName**(`name`): [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) set tool name #### Parameters | Name | Type | Description | | --- | --- | --- | | `name` | `string` | the tool name | #### Returns [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[setName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#setname) #### setPlot ▸ **setPlot**(`plot`): [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) Set plot #### Parameters | Name | Type | Description | | --- | --- | --- | | `plot` | [`Plot`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.plot.plot.plot) | plot container | #### Returns [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) #### setProperties ▸ **setProperties**(`properties?`, `context?`): [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) Sets all the properties pertaining to this object #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `properties` | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#abstracttool#options) | An object containing the properties to set | | `Optional` `context` | [`IDeserializationContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.persistence.ideserializationcontext.ideserializationcontext) | deserialization context | #### Returns [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) this #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[setProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#setproperties) #### setProperty ▸ **setProperty**(`name`, `value`): [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) Sets dynamic property by name #### Parameters | Name | Type | Description | | --- | --- | --- | | `name` | `string` | property name | | `value` | `any` | property value | #### Returns [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) this #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[setProperty](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#setproperty) #### setSilent ▸ **setSilent**(`bool`): [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) Set silent mode #### Parameters | Name | Type | Description | | --- | --- | --- | | `bool` | `boolean` | flag to enable silent mode | #### Returns [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) this #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[setSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#setsilent) #### setSlotEnabled ▸ **setSlotEnabled**(`eventName`, `value`, `target?`): [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) Sets slot enabled #### Parameters | Name | Type | Description | | --- | --- | --- | | `eventName` | `string` | eventName | | `value` | `boolean` | value | | `Optional` `target` | `EventTarget` | target | #### Returns [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[setSlotEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#setslotenabled) #### setSlots ▸ **setSlots**(`slots?`, `merge?`): [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) Sets new slots. **`Example`** ```ts const slots = { 'pointerdown': (event: EventArgs) => { // event is an instance of @int/geotoolkit/controls/tools/EventArgs ... } }; tool.setSlots(slots); ``` #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `slots` | `Record`<`string`, [`Slot`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#abstracttool#slot) | [`Slot`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#abstracttool#slot)[] | (`eventArgs`: [`EventArgs`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.eventargs.eventargs)) => `void`> | type of system events | | `Optional` `merge` | `boolean` | set to true if you want to merge with existing slots | #### Returns [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) this #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[setSlots](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#setslots) #### setTouchRadius ▸ **setTouchRadius**(`radius`): [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) Sets device radius for touch events #### Parameters | Name | Type | Description | | --- | --- | --- | | `radius` | `number` | radius for touch events | #### Returns [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) this #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[setTouchRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#settouchradius) #### start ▸ `Protected` **start**(`eventArgs?`): [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) start #### Parameters | Name | Type | Description | | --- | --- | --- | | `Optional` `eventArgs` | [`EventArgs`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.eventargs.eventargs) | event args | #### Returns [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[start](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#start) #### stop ▸ `Protected` **stop**(): [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) stop #### Returns [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[stop](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#stop) #### toggle ▸ **toggle**(): [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) switch enable state to opposite state #### Returns [`Editor`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.html.editor.editor) #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[toggle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#toggle) #### canvasToClient ▸ `Static` **canvasToClient**(`plotPoint`, `plot`): [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) Convert plot coordinates to global coordinates #### Parameters | Name | Type | Description | | --- | --- | --- | | `plotPoint` | [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) | point in plot coordinates | | `plot` | [`Plot`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.plot.plot.plot) | plot with canvas | #### Returns [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[canvasToClient](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#canvastoclient) #### clientToCanvas ▸ `Static` **clientToCanvas**(`nativeEvent`, `plot`): [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) Convert global coordinates to plot coordinates #### Parameters | Name | Type | Description | | --- | --- | --- | | `nativeEvent` | `Event` | native browser event | | `plot` | [`Plot`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.plot.plot.plot) | plot with canvas | #### Returns [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point) #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[clientToCanvas](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#clienttocanvas) #### getClassName ▸ `Static` **getClassName**(): `string` #### Returns `string` #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#getclassname-1) #### getExclusiveTool ▸ `Static` **getExclusiveTool**(`plot`): [`AbstractTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool) return exclusive tool associated with plot #### Parameters | Name | Type | Description | | --- | --- | --- | | `plot` | [`Plot`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.plot.plot.plot) | plot | #### Returns [`AbstractTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool) tool #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[getExclusiveTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#getexclusivetool) #### getNativeEventName ▸ `Static` **getNativeEventName**(`eventName`): `string`[] Returns native event name #### Parameters | Name | Type | Description | | --- | --- | --- | | `eventName` | `string` | W3C Pointer Events Recommendation name | #### Returns `string`[] #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[getNativeEventName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#getnativeeventname) #### isTouchEvent ▸ `Static` **isTouchEvent**(`eventArgs`): eventArgs is TouchEvent return true if the event is a touch event and false otherwise. #### Parameters | Name | Type | Description | | --- | --- | --- | | `eventArgs` | `Event` | [`EventArgs`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.eventargs.eventargs) | contains info of the event | #### Returns eventArgs is TouchEvent #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[isTouchEvent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#istouchevent-1) #### lock ▸ `Static` **lock**(`plot`, `tool`): `void` Set exclusive tool for plot #### Parameters | Name | Type | Description | | --- | --- | --- | | `plot` | [`Plot`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.plot.plot.plot) | plot | | `tool` | [`AbstractTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool) | tool | #### Returns `void` #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[lock](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#lock) #### setDefaultMouseRadius ▸ `Static` **setDefaultMouseRadius**(`radius`): `void` Sets default device radius for mouse events #### Parameters | Name | Type | Description | | --- | --- | --- | | `radius` | `number` | radius for mouse events | #### Returns `void` #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[setDefaultMouseRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#setdefaultmouseradius) #### setDefaultTouchRadius ▸ `Static` **setDefaultTouchRadius**(`radius`): `void` Sets default device radius for touch events #### Parameters | Name | Type | Description | | --- | --- | --- | | `radius` | `number` | radius for touch events | #### Returns `void` #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[setDefaultTouchRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#setdefaulttouchradius) #### unlock ▸ `Static` **unlock**(`value`): `void` Remove exclusive tool from plot #### Parameters | Name | Type | Description | | --- | --- | --- | | `value` | [`AbstractTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool) | [`Plot`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.plot.plot.plot) | value | #### Returns `void` #### Inherited from [AbstractTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool).[unlock](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.abstracttool.abstracttool#unlock)