[API](/solutions/geotoolkit/geotoolkit_js/apis/readme) / [geotoolkit](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit) / [map](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map) / [tools](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#tools) / [AggregationSelection](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#aggregationselection) / AggregationSelection
# Class: AggregationSelection
[tools](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#tools).[AggregationSelection](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#aggregationselection).AggregationSelection
Helper class for aggregation selection
## Hierarchy
- [`Selection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection)
↳ **`AggregationSelection`**
## Table of contents
Constructors
- [new AggregationSelection(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection.md#new aggregationselection(options))
Methods
| [addListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#addlistener) | [captureMouseUp](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#capturemouseup) | [dispose](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#dispose) |
| --- | --- | --- |
| [fireEvent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#fireevent) | [getCircularMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getcircularmode) | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getclassname) |
| [getContainerModelLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getcontainermodellimits) | [getEndPoint](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getendpoint) | [getEventRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#geteventradius) |
| [getFillStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getfillstyle) | [getLineStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getlinestyle) | [getManipulatorLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getmanipulatorlayer) |
| [getMouseButtons](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getmousebuttons) | [getMouseRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getmouseradius) | [getName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getname) |
| [getNodeFilter](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getnodefilter) | [getParentTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getparenttool) | [getPointerMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getpointermode) |
| [getProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getproperties) | [getProperty](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getproperty) | [getPropertyKeys](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getpropertykeys) |
| [getRoot](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getroot) | [getRootNode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getrootnode) | [getRubberBandMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getrubberbandmode) |
| [getRubberBandRenderMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getrubberbandrendermode) | [getRubberBandShapeMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getrubberbandshapemode) | [getSelection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getselection) |
| [getSelectionMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getselectionmode) | [getStartPoint](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getstartpoint) | [getTextStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#gettextstyle) |
| [getTouchRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#gettouchradius) | [hasEventListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#haseventlistener) | [isActive](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#isactive) |
| [isAutoDisabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#isautodisabled) | [isDisposed](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#isdisposed) | [isDoubleClick](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#isdoubleclick) |
| [isEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#isenabled) | [isSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#issilent) | [isTouchEvent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#istouchevent) |
| [notify](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#notify) | [off](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#off) | [on](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#on) |
| [onActiveStateChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#onactivestatechanged) | [onDoubleClick](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#ondoubleclick) | [onEnabledStateChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#onenabledstatechanged) |
| [onMouseDown](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#onmousedown) | [onMouseMove](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#onmousemove) | [onMouseUp](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#onmouseup) |
| [pageToCanvas](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#pagetocanvas) | [pointToModel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#pointtomodel) | [removeListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#removelistener) |
| [setActive](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setactive) | [setAutoDisabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setautodisabled) | [setCircularMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setcircularmode) |
| [setEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setenabled) | [setFillStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setfillstyle) | [setLineStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setlinestyle) |
| [setMeasureCallback](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setmeasurecallback) | [setMouseButtons](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setmousebuttons) | [setMouseRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setmouseradius) |
| [setName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setname) | [setNodeFilter](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setnodefilter) | [setOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setoptions) |
| [setPointerMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setpointermode) | [setProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setproperties) | [setProperty](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setproperty) |
| [setRootNode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setrootnode) | [setRubberBandMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setrubberbandmode) | [setRubberBandRenderMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setrubberbandrendermode) |
| [setRubberBandShapeMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setrubberbandshapemode) | [setSelection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setselection) | [setSelectionMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setselectionmode) |
| [setSelectorCallback](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setselectorcallback) | [setSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setsilent) | [setSlotEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setslotenabled) |
| [setSlots](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setslots) | [setTextStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#settextstyle) | [setTouchRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#settouchradius) |
| [start](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#start) | [stop](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#stop) | [toggle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#toggle) |
| [canvasToClient](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#canvastoclient) | [clientToCanvas](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#clienttocanvas) | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getclassname-1) |
| [getExclusiveTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getexclusivetool) | [getNativeEventName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#getnativeeventname) | [isTouchEvent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#istouchevent-1) |
| [lock](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#lock) | [setDefaultMouseRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setdefaultmouseradius) | [setDefaultTouchRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#setdefaulttouchradius) |
| [unlock](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection#unlock) |
Css Properties
| Name | Type | Description |
| --- | --- | --- |
| `autodisabled` | `boolean` | True if selection automatically disabled on selection changed |
| `circularmode` | [`CircularMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#tools#circularmode#circularmode) | Tool circular selection mode |
| `enabled` | `boolean` | Enabled state |
| `fillstyle` | `string` | Rubber band selection fillstyle |
| `fillstyle` | [`FillStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.fillstyle.fillstyle#css-props) | Rubber band selection fillstyle |
| `fillstyle-color` | `string` | Color in CSS form |
| `fillstyle-evenoddmode` | `boolean` | Even-odd fill mode |
| `fillstyle-fillpattern` | [`Pattern`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.pattern.pattern#css-props) | Pattern |
| `fillstyle-fillpattern-containername` | `string` | An optional container name, which creates an image pattern. This
parameter is used for serialization if you want to save are reference to pattern instead of the pattern itself |
| `fillstyle-fillpattern-patternname` | `string` | Name of this pattern for indexing |
| `fillstyle-fillpattern-scalable` | `boolean` | Flag that sets scalability of the pattern
coordinates, or relative to the shape it is filling (It is not supported) |
| `fillstyle-foreground` | `string` | Foreground color |
| `fillstyle-pattern` | [`Pattern`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.pattern.pattern#css-props) | Pattern |
| `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 |
| `linestyle` | `string` | Rubber band selection linestyle |
| `linestyle` | [`LineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.linestyle.linestyle#css-props) | Rubber band selection linestyle |
| `linestyle-color` | `string` | Color in CSS form |
| `linestyle-fill` | `string` | Optional fill style to be used to fill lines generated with this style |
| `linestyle-fill` | [`FillStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.fillstyle.fillstyle#css-props) | Optional fill style to be used to fill lines generated with this style |
| `linestyle-linecap` | [`CapStyle`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes.linestyle#capstyle) | The line cap style |
| `linestyle-linedashoffset` | `number` | Line dash offset of dashed line |
| `linestyle-linejoin` | [`JoinStyle`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes.linestyle#joinstyle) | The line join style |
| `linestyle-pixelsnapmode` | `boolean` | Pixel Snap Mode, default( |
| `linestyle-scalable` | `boolean` | True if width should depend on transformation |
| `linestyle-unit` | `string` | Optional unit for the width |
| `linestyle-width` | `number | string` | The line thickness |
| `mode` | [`RubberBandRenderMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#tools#rubberbandrendermode#rubberbandrendermode) | Rubber mode |
| `mode` | [`SelectionMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#tools#selectionmode#selectionmode) | Selection mode |
| `mouseradius` | `number` | Device radius for mouse events |
| `name` | `string` | Name of the tool used like cross-hair etc |
| `pointermode` | [`PointerMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#tools#pointermode#pointermode) | Tool pointer selection mode |
| `rootnode` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#css-props) | A root node to start selection |
| `rootnode-cssclass` | `string` | The css class name of this node |
| `rootnode-id` | `string | number` | Id of the node, its a unique identifier |
| `rootnode-name` | `string` | Name of the node. It is often used for debugging purposes or to simplify queries |
| `rootnode-selectable` | `boolean` | Selectable node, a boolean to determine if selection should consider this node |
| `rootnode-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 |
| `rootnode-visible` | `boolean` | Visibility of the node, a boolean to determine if the node should be rendered or not |
| `rootnode-z-index` | `number` | Define node z-index |
| `rubberbandmode` | [`RubberBandMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#tools#rubberbandmode#rubberbandmode) | Tool rubberband selection mode |
| `rubberbandshapemode` | [`RubberBandShapeMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#tools#rubberbandshapemode#rubberbandshapemode) | Shape mode for the rubberband selection area |
| `selectionmode` | [`SelectionMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#tools#selectionmode#selectionmode) | Selection mode |
| `textstyle` | `string` | Rubber band selection distance textstyle |
| `textstyle` | [`TextStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.textstyle.textstyle#css-props) | Rubber band selection distance textstyle |
| `textstyle-alignment` | [`AlignmentStyle`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#textstyle#alignmentstyle) | Alignment |
| `textstyle-autosize` | `boolean` | Auto font size on high definition display |
| `textstyle-background` | `string` | Background style |
| `textstyle-background` | [`FillStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.fillstyle.fillstyle#css-props) | Background style |
| `textstyle-baseline` | [`BaseLineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#textstyle#baselinestyle) | Base line |
| `textstyle-color` | `string` | Color in CSS form |
| `textstyle-fill` | [`FillStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.fillstyle.fillstyle#css-props) | Text fill style |
| `textstyle-font` | `string` | Font see |
| `textstyle-fonturl` | `string` | The place from which the font will be loaded, if null - uses system fonts. It can be base64 with url keyword |
| `textstyle-lineheight` | `string | number` | Line height |
| `textstyle-multiline` | `boolean` | Allow multi-line text |
| `textstyle-outline` | `string` | Outline style |
| `textstyle-outline` | [`LineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.linestyle.linestyle#css-props) | Outline style |
| `textstyle-overflowwrap` | [`OverflowWrapStyle`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#textstyle#overflowwrapstyle) | Overflow wrap |
| `textstyle-strikethrough` | `string` | Strikethrough style |
| `textstyle-strikethrough` | [`LineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.linestyle.linestyle#css-props) | Strikethrough style |
| `textstyle-textoverflow` | [`TextOverflowStyle`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#textstyle#textoverflowstyle) | Text overflow |
| `textstyle-underline` | `string` | Underline style |
| `textstyle-underline` | [`LineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.linestyle.linestyle#css-props) | Underline style |
| `textstyle-underlineoffset` | `string | number` | Underline offset distance |
| `textstyle-whitespace` | [`WhiteSpaceStyle`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#textstyle#whitespacestyle) | White space |
| `textstyle-wordbreak` | [`WordBreakStyle`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#textstyle#wordbreakstyle) | Word break |
| `touchradius` | `number` | Device radius for touch events |
## Contents
Constructors
#### new AggregationSelection(options)
• **new AggregationSelection**(`options?`)
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `Optional` `options` | [`CompositeNode`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.compositenode.compositenode)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)> | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#abstractrubbertool#options) | used to display temporary shapes or tool options |
#### Overrides
Selection.constructor
Methods
#### addListener
▸ **addListener**(`eventName`, `listener`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
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
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[addListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#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
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[captureMouseUp](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#capturemouseup)
#### dispose
▸ **dispose**(): `void`
Dispose tool.
#### Returns
`void`
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[dispose](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#dispose)
#### 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
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[fireEvent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#fireevent)
#### getCircularMode
▸ **getCircularMode**(): [`CircularMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#circularmode)
Gets tool's circular selection mode
#### Returns
[`CircularMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#circularmode)
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getCircularMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#getcircularmode)
#### getClassName
▸ **getClassName**(): `string`
#### Returns
`string`
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#getclassname)
#### getContainerModelLimits
▸ `Protected` **getContainerModelLimits**(): [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect)
Return container model limits in which rubber band is drawn. By default it
returns manipulator layer visible model limits
#### Returns
[`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect)
area of model limits
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getContainerModelLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#getcontainermodellimits)
#### getEndPoint
▸ **getEndPoint**(): [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point)
Return end point of selection
#### Returns
[`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point)
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getEndPoint](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#getendpoint)
#### 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
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getEventRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#geteventradius)
#### getFillStyle
▸ **getFillStyle**(): [`FillStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.fillstyle.fillstyle)
Returns fill style
#### Returns
[`FillStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.fillstyle.fillstyle)
fill style
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getFillStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#getfillstyle)
#### getLineStyle
▸ **getLineStyle**(): [`LineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.linestyle.linestyle)
Returns line style
#### Returns
[`LineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.linestyle.linestyle)
line style
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getLineStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#getlinestyle)
#### 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
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getManipulatorLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#getmanipulatorlayer)
#### getMouseButtons
▸ **getMouseButtons**(): [`MouseButtons`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.dom#mousebuttons)
Gets mouse buttons set for selection
#### Returns
[`MouseButtons`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.dom#mousebuttons)
this
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getMouseButtons](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#getmousebuttons)
#### getMouseRadius
▸ **getMouseRadius**(): `number`
Returns current device radius for mouse events
#### Returns
`number`
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getMouseRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#getmouseradius)
#### getName
▸ **getName**(): `string`
return tool name if any
#### Returns
`string`
name of the tool
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#getname)
#### getNodeFilter
▸ **getNodeFilter**(): [`NodeFilterCallback`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#selection#nodefiltercallback)
Returns filter handler
#### Returns
[`NodeFilterCallback`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#selection#nodefiltercallback)
filter
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getNodeFilter](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#getnodefilter)
#### 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
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getParentTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#getparenttool)
#### getPointerMode
▸ **getPointerMode**(): [`PointerMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#pointermode)
Gets tool pointer selection mode
#### Returns
[`PointerMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#pointermode)
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getPointerMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#getpointermode)
#### getProperties
▸ **getProperties**(): [`OptionsOut`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#selection#optionsout)
Returns properties
#### Returns
[`OptionsOut`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#selection#optionsout)
properties
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#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
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getProperty](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#getproperty)
#### getPropertyKeys
▸ **getPropertyKeys**(): `string`[]
Returns known properties keys
#### Returns
`string`[]
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getPropertyKeys](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#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
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getRoot](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#getroot)
#### getRootNode
▸ **getRootNode**(): [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)
Return the root node to start selection. If it is not specified then root node is used
#### Returns
[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)
root node
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getRootNode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#getrootnode)
#### getRubberBandMode
▸ **getRubberBandMode**(): [`RubberBandMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#rubberbandmode)
Gets tool's rubberband selection mode
#### Returns
[`RubberBandMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#rubberbandmode)
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getRubberBandMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#getrubberbandmode)
#### getRubberBandRenderMode
▸ **getRubberBandRenderMode**(): [`RubberBandRenderMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#rubberbandrendermode)
Return the way the rectangle is displayed
#### Returns
[`RubberBandRenderMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#rubberbandrendermode)
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getRubberBandRenderMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#getrubberbandrendermode)
#### getRubberBandShapeMode
▸ **getRubberBandShapeMode**(): [`RubberBandShapeMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#rubberbandshapemode)
Gets tool's rubberband shape
#### Returns
[`RubberBandShapeMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#rubberbandshapemode)
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getRubberBandShapeMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#getrubberbandshapemode)
#### getSelection
▸ **getSelection**(): ([`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | [`SelectedItem`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.selection.selecteditem.selecteditem)<`any`>)[]
gets the currently selected items
#### Returns
([`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | [`SelectedItem`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.selection.selecteditem.selecteditem)<`any`>)[]
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getSelection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#getselection)
#### getSelectionMode
▸ **getSelectionMode**(): [`SelectionMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#selectionmode)
Returns tool selection mode
#### Returns
[`SelectionMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#selectionmode)
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getSelectionMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#getselectionmode)
#### getStartPoint
▸ **getStartPoint**(): [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point)
Return start point of selection
#### Returns
[`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point)
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getStartPoint](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#getstartpoint)
#### getTextStyle
▸ **getTextStyle**(): [`TextStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.textstyle.textstyle)
Returns text style
#### Returns
[`TextStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.textstyle.textstyle)
text style
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getTextStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#gettextstyle)
#### getTouchRadius
▸ **getTouchRadius**(): `number`
Returns current device radius for touch events
#### Returns
`number`
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getTouchRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#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
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[hasEventListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#haseventlistener)
#### isActive
▸ **isActive**(): `boolean`
return active state
#### Returns
`boolean`
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[isActive](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#isactive)
#### isAutoDisabled
▸ **isAutoDisabled**(): `boolean`
Get auto-disabled mode
#### Returns
`boolean`
does the selection automatically disable itself on selection changed
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[isAutoDisabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#isautodisabled)
#### isDisposed
▸ **isDisposed**(): `boolean`
Returns whether this object has been disposed
#### Returns
`boolean`
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[isDisposed](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#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
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[isDoubleClick](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#isdoubleclick)
#### isEnabled
▸ **isEnabled**(): `boolean`
returns enable state
#### Returns
`boolean`
state
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[isEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#isenabled)
#### isSilent
▸ **isSilent**(): `boolean`
Return true if the event dispatcher doesn't notify any events
#### Returns
`boolean`
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[isSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#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
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[isTouchEvent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#istouchevent)
#### notify
▸ **notify**<`E`>(`type`, `source`, `args?`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Notify listeners
#### Type parameters
| Name | Type |
| --- | --- |
| `E` | extends `string` |
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `type` | `E` | event types |
| `source` | [`Selection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection) | of the event |
| `Optional` `args` | [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#selection#eventmap)[`E`] | arguments of the event |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
this
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[notify](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#notify)
#### off
▸ **off**<`E`>(`type?`, `callback?`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
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`: [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection), `args`: [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#selection#eventmap)[`E`]) => `void` | function to be called |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
this
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[off](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#off)
#### on
▸ **on**<`E`>(`type`, `callback`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
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`: [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection), `args`: [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#selection#eventmap)[`E`]) => `void` | to be called |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[on](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#on)
#### onActiveStateChanged
▸ `Protected` **onActiveStateChanged**(): `void`
**`Fires`**
[Events.onStateChanged](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#tools#abstracttool#events#onstatechanged)
#### Returns
`void`
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[onActiveStateChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#onactivestatechanged)
#### onDoubleClick
▸ `Protected` **onDoubleClick**(`eventArgs`): `void`
Double click handler
Detects if double click happens on scrollbar and prevents propagation
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `eventArgs` | [`EventArgs`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.eventargs.eventargs) | event arguments |
#### Returns
`void`
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[onDoubleClick](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#ondoubleclick)
#### onEnabledStateChanged
▸ `Protected` **onEnabledStateChanged**(): `void`
**`Fires`**
[Events.onEnabledStateChanged](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#tools#abstracttool#events#onenabledstatechanged)
#### Returns
`void`
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[onEnabledStateChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#onenabledstatechanged)
#### onMouseDown
▸ `Protected` **onMouseDown**(`eventArgs`): `void`
mouse down function of selection tool
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `eventArgs` | [`EventArgs`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.eventargs.eventargs) | contains info about the event arguments |
#### Returns
`void`
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[onMouseDown](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#onmousedown)
#### onMouseMove
▸ `Protected` **onMouseMove**(`eventArgs`): `void`
mouse move function
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `eventArgs` | [`EventArgs`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.eventargs.eventargs) | contains info about the event arguments |
#### Returns
`void`
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[onMouseMove](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#onmousemove)
#### onMouseUp
▸ `Protected` **onMouseUp**(`eventArgs`): `void`
mouse up function of selection tool
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `eventArgs` | [`EventArgs`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.eventargs.eventargs) | contains info about the event arguments |
#### Returns
`void`
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[onMouseUp](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#onmouseup)
#### 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
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[pageToCanvas](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#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
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[pointToModel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#pointtomodel)
#### removeListener
▸ **removeListener**(`eventName`, `listener?`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
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
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[removeListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#removelistener)
#### setActive
▸ **setActive**(`active`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
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
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setActive](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setactive)
#### setAutoDisabled
▸ **setAutoDisabled**(`mode`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Set auto-disabled mode
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `mode` | `boolean` | does the selection automatically disable itself on selection changed |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
this
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setAutoDisabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setautodisabled)
#### setCircularMode
▸ **setCircularMode**(`mode`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Sets tool's circular selection mode
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `mode` | [`CircularMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#circularmode) | new circular selection mode |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
this
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setCircularMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setcircularmode)
#### setEnabled
▸ **setEnabled**(`enabled`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Sets enabled
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `enabled` | `boolean` | true, if enabled, else false |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
this
#### Overrides
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setenabled)
#### setFillStyle
▸ **setFillStyle**(`fillStyle`, `merge?`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Sets fill style
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `fillStyle` | [`Type`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#fillstyle#type) | a new fill style |
| `Optional` `merge` | `boolean` | true if you want to merge fillStyle with existing attribute, false by default |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
this this
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setFillStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setfillstyle)
#### setLineStyle
▸ **setLineStyle**(`lineStyle`, `merge?`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Sets line style
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `lineStyle` | [`Type`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes.linestyle#linestyle#type) | line style or options |
| `Optional` `merge` | `boolean` | true if you want to merge lineStyle with existing attribute, false by default |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
this
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setLineStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setlinestyle)
#### setMeasureCallback
▸ **setMeasureCallback**(`measureCallback`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Sets measure callback
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `measureCallback` | [`MeasureCallback`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#selection#measurecallback) | measure callback |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setMeasureCallback](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setmeasurecallback)
#### setMouseButtons
▸ **setMouseButtons**(`button`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Sets mouse buttons for selection
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `button` | [`MouseButtons`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.dom#mousebuttons) | mouse button |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
this
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setMouseButtons](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setmousebuttons)
#### setMouseRadius
▸ **setMouseRadius**(`radius`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Sets device radius for mouse events
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `radius` | `number` | radius for mouse events |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
this
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setMouseRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setmouseradius)
#### setName
▸ **setName**(`name`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
set tool name
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `name` | `string` | the tool name |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setname)
#### setNodeFilter
▸ **setNodeFilter**(`filter`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Sets filter handler
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `filter` | [`NodeFilterCallback`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#selection#nodefiltercallback) | This allows to filter selected nodes. |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setNodeFilter](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setnodefilter)
#### setOptions
▸ **setOptions**(`options?`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Sets selection options
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `Optional` `options` | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#selection#options) | options |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
this
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setoptions)
#### setPointerMode
▸ **setPointerMode**(`mode`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Sets tool pointer selection mode
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `mode` | [`PointerMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#pointermode) | tool pointer selection mode |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
this
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setPointerMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setpointermode)
#### setProperties
▸ **setProperties**(`properties`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Sets all the properties pertaining to this object
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `properties` | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#selection#options) | An object containing the properties to set |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
this
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setproperties)
#### setProperty
▸ **setProperty**(`name`, `value`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Sets dynamic property by name
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `name` | `string` | property name |
| `value` | `any` | property value |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
this
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setProperty](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setproperty)
#### setRootNode
▸ **setRootNode**(`root`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Specify a root node to start selection. If it is not specified then root node is used
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `root` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | root node |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
this
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setRootNode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setrootnode)
#### setRubberBandMode
▸ **setRubberBandMode**(`mode`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Sets tool rubberband selection mode
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `mode` | [`RubberBandMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#rubberbandmode) | tool rubberband selection mode |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
this
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setRubberBandMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setrubberbandmode)
#### setRubberBandRenderMode
▸ **setRubberBandRenderMode**(`mode`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Set the way the rectangle has to be displayed
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `mode` | [`RubberBandRenderMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#rubberbandrendermode) | the way the rectangle has to be displayed |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setRubberBandRenderMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setrubberbandrendermode)
#### setRubberBandShapeMode
▸ **setRubberBandShapeMode**(`mode`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Sets tool's rubberband shape mode
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `mode` | [`RubberBandShapeMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#rubberbandshapemode) | shape mode for the rubberband selection area |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
this
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setRubberBandShapeMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setrubberbandshapemode)
#### setSelection
▸ **setSelection**(`selection`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
sets the currently selected items
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `selection` | ([`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | [`SelectedItem`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.selection.selecteditem.selecteditem)<`any`>)[] | selection |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
this
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setSelection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setselection)
#### setSelectionMode
▸ **setSelectionMode**(`mode`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Sets tool selection mode
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `mode` | [`SelectionMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#selectionmode) | tool selection mode |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
this
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setSelectionMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setselectionmode)
#### setSelectorCallback
▸ **setSelectorCallback**(`selectorCallback`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Sets selector callback
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `selectorCallback` | [`SelectorCallback`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#selection#selectorcallback) | selector callback |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setSelectorCallback](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setselectorcallback)
#### setSilent
▸ **setSilent**(`bool`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Set silent mode
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `bool` | `boolean` | flag to enable silent mode |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
this
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setsilent)
#### setSlotEnabled
▸ **setSlotEnabled**(`eventName`, `value`, `target?`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Sets slot enabled
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `eventName` | `string` | eventName |
| `value` | `boolean` | value |
| `Optional` `target` | `EventTarget` | target |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setSlotEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setslotenabled)
#### setSlots
▸ **setSlots**(`slots?`, `merge?`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
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
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
this
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setSlots](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#setslots)
#### setTextStyle
▸ **setTextStyle**(`textStyle`, `merge?`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Sets measurement label text style
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `textStyle` | [`Type`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#textstyle#type) | a new shape text style |
| `Optional` `merge` | `boolean` | true if you want to merge textStyle with existing attribute, false by default |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
this
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setTextStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#settextstyle)
#### setTouchRadius
▸ **setTouchRadius**(`radius`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
Sets device radius for touch events
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `radius` | `number` | radius for touch events |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
this
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setTouchRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#settouchradius)
#### start
▸ `Protected` **start**(`eventArgs?`): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
start
#### Parameters
| Name | Type | Description |
| --- | --- | --- |
| `Optional` `eventArgs` | [`EventArgs`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.eventargs.eventargs) | event args |
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[start](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#start)
#### stop
▸ `Protected` **stop**(): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
stop
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[stop](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#stop)
#### toggle
▸ **toggle**(): [`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
switch enable state to opposite state
#### Returns
[`AggregationSelection`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.tools-1.aggregationselection.aggregationselection)
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[toggle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#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
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[canvasToClient](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#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
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[clientToCanvas](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#clienttocanvas)
#### getClassName
▸ `Static` **getClassName**(): `string`
#### Returns
`string`
#### Inherited from
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#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
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getExclusiveTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#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
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[getNativeEventName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#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
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[isTouchEvent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#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
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[lock](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#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
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setDefaultMouseRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#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
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[setDefaultTouchRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#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
[Selection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection).[unlock](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.selection.selection#unlock)