[API](/solutions/geotoolkit/geotoolkit_js/apis/readme) / [geotoolkit](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit) / [welllog](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog) / [widgets](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog#widgets) / [tools](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog#tools) / [DepthShiftingTool](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool) / DepthShiftingTool

# Class: DepthShiftingTool

[tools](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog#tools).[DepthShiftingTool](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool).DepthShiftingTool

<p>
Implements a tool capable of editing log curve depth shifting points.
</p>

## Hierarchy

- [`AbstractLogVisualEditingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool)
↳ **`DepthShiftingTool`**


## Table of contents

Constructors
- [new DepthShiftingTool(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool.md#new depthshiftingtool(options))


Methods
| [addDepthMapping](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#adddepthmapping) | [addHandle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#addhandle) | [addListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#addlistener) |
|  --- | --- | --- |
| [captureMouseUp](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#capturemouseup) | [clearDepthMapping](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#cleardepthmapping) | [clearHandles](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#clearhandles) |
| [dispose](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#dispose) | [fireEvent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#fireevent) | [getActiveHandle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getactivehandle) |
| [getCachedManipulatorLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getcachedmanipulatorlayer) | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getclassname) | [getDepthLabel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getdepthlabel) |
| [getDepthMapping](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getdepthmapping) | [getDepthMappings](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getdepthmappings) | [getDepthMappingsCount](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getdepthmappingscount) |
| [getDeviceXY](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getdevicexy) | [getEventRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#geteventradius) | [getHandle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#gethandle) |
| [getHandlePainter](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#gethandlepainter) | [getHandleSize](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#gethandlesize) | [getHandleStyles](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#gethandlestyles) |
| [getHandlesCount](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#gethandlescount) | [getHideGhostOnDrop](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#gethideghostondrop) | [getManipulatorLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getmanipulatorlayer) |
| [getMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getmode) | [getMouseRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getmouseradius) | [getName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getname) |
| [getParentTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getparenttool) | [getPosition](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getposition) | [getProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getproperties) |
| [getProperty](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getproperty) | [getPropertyKeys](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getpropertykeys) | [getRange](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getrange) |
| [getRoot](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getroot) | [getShape](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getshape) | [getShowGhost](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getshowghost) |
| [getTouchRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#gettouchradius) | [hasEventListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#haseventlistener) | [isActive](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#isactive) |
| [isDisposed](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#isdisposed) | [isDoubleClick](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#isdoubleclick) | [isEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#isenabled) |
| [isSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#issilent) | [isTouchEvent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#istouchevent) | [makeSelection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#makeselection) |
| [notify](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#notify) | [off](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#off) | [on](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#on) |
| [onActiveStateChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#onactivestatechanged) | [onEnabledStateChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#onenabledstatechanged) | [onMouseDown](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#onmousedown) |
| [onMouseMove](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#onmousemove) | [onMouseUp](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#onmouseup) | [pageToCanvas](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#pagetocanvas) |
| [pointToModel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#pointtomodel) | [removeDepthMapping](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#removedepthmapping) | [removeHandle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#removehandle) |
| [removeListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#removelistener) | [setActive](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#setactive) | [setActiveHandle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#setactivehandle) |
| [setDepthLabelCallback](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#setdepthlabelcallback) | [setEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#setenabled) | [setHandlePainter](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#sethandlepainter) |
| [setHandleSize](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#sethandlesize) | [setHandleStyles](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#sethandlestyles) | [setHandlesVisible](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#sethandlesvisible) |
| [setHideGhostOnDrop](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#sethideghostondrop) | [setMode](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#setmode) | [setMouseRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#setmouseradius) |
| [setName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#setname) | [setPosition](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#setposition) | [setProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#setproperties) |
| [setProperty](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#setproperty) | [setRange](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#setrange) | [setShape](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#setshape) |
| [setShowGhost](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#setshowghost) | [setSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#setsilent) | [setSlotEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#setslotenabled) |
| [setSlots](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#setslots) | [setTouchRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#settouchradius) | [start](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#start) |
| [stop](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#stop) | [toggle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#toggle) | [update](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#update) |
| [canvasToClient](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#canvastoclient) | [clientToCanvas](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#clienttocanvas) | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getclassname-1) |
| [getExclusiveTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getexclusivetool) | [getNativeEventName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#getnativeeventname) | [isTouchEvent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#istouchevent-1) |
| [lock](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#lock) | [mapDepths](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#mapdepths) | [setDefaultMouseRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#setdefaultmouseradius) |
| [setDefaultTouchRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#setdefaulttouchradius) | [unlock](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool#unlock) |


Css Properties
| Name  | Type  | Description |
|  --- | --- | --- |
| `cachedlayer` | [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group#css-props) | Layer to which handles will be added. Cache enabled |
| `cachedlayer-automodellimitsmode` | `boolean` | Auto model limits mode |
| `cachedlayer-bounds` | [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect#css-props) | Define position of the group in the parent |
| `cachedlayer-bounds-height` | `number` | Height |
| `cachedlayer-bounds-readonly` | `boolean` | Readonly |
| `cachedlayer-bounds-width` | `number` | Width |
| `cachedlayer-bounds-x` | `number` | Left |
| `cachedlayer-bounds-y` | `number` | Top |
| `cachedlayer-clipping` | `boolean` | Enable clipping, this does not consider the clipstyle, it is related to bounds-clipping |
| `cachedlayer-clipstyle` | [`ClipStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.clipstyle.clipstyle#css-props) | Clipping style |
| `cachedlayer-clipstyle-evenodd` | `boolean` | True if evenodd mode is on (&#x27;nonzero&#x27; mode otherwise) |
| `cachedlayer-clipstyle-geometry` | [`GraphicsPath`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.graphicspath.graphicspath#css-props) | Clipping geometry |
| `cachedlayer-clipstyle-geometry-bounds` | [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect#css-props) | Bounds |
| `cachedlayer-clipstyle` | [`GraphicsPath`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.graphicspath.graphicspath#css-props) | Clipping style |
| `cachedlayer-contentorientation` | [`Orientation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#orientation#orientation) | Content orientation |
| `cachedlayer-cssclass` | `string` | The css class name of this node |
| `cachedlayer-csscursor` | `string` | CSS cursor associated with node |
| `cachedlayer-cssstyle` | `string` | CSS style to be applied to inserted elements |
| `cachedlayer-fillstyle` | `string` | Fill style |
| `cachedlayer-fillstyle` | [`FillStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.fillstyle.fillstyle#css-props) | Fill style |
| `cachedlayer-fillstyle-color` | `string` | Color in CSS form |
| `cachedlayer-fillstyle-evenoddmode` | `boolean` | Even-odd fill mode |
| `cachedlayer-fillstyle-fillpattern` | [`Pattern`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.pattern.pattern#css-props) | Pattern |
| `cachedlayer-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 |
| `cachedlayer-fillstyle-fillpattern-patternname` | `string` | Name of this pattern for indexing |
| `cachedlayer-fillstyle-fillpattern-scalable` | `boolean` | Flag that sets scalability of the pattern
coordinates, or relative to the shape it is filling (It is not supported) |
| `cachedlayer-fillstyle-foreground` | `string` | Foreground color |
| `cachedlayer-fillstyle-pattern` | [`Pattern`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.pattern.pattern#css-props) | Pattern |
| `cachedlayer-horizontalflip` | `boolean` | Horizontal axis goes from right to left |
| `cachedlayer-id` | `string | number` | Id of the node, its a unique identifier |
| `cachedlayer-infinity` | `boolean` | Mode to render outside the model limits |
| `cachedlayer-layoutstyle` | [`LayoutStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.layout.layoutstyle.layoutstyle#css-props) | Layout style to be used for parent layout |
| `cachedlayer-layoutstyle-constraint` | [`SizeConstraint`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.layout#sizeconstraint#sizeconstraint) | Layout constrains |
| `cachedlayer-layoutstyle-flexgrow` | `number` | Number specifying how much the item will grow relative to the rest of the items inside the same container |
| `cachedlayer-layoutstyle-flexshrink` | `number` | Number specifying how much the item will shrink relative to the rest of the items inside the same container |
| `cachedlayer-layoutstyle-float` | `string` | Float position |
| `cachedlayer-layoutstyle-position` | `string` | Layout position |
| `cachedlayer-layoutstyle-size` | `number | string` | Layout size |
| `cachedlayer-linestyle` | `string` | Line style |
| `cachedlayer-linestyle` | [`LineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.linestyle.linestyle#css-props) | Line style |
| `cachedlayer-linestyle-color` | `string` | Color in CSS form |
| `cachedlayer-linestyle-fill` | `string` | Optional fill style to be used to fill lines generated with this style |
| `cachedlayer-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 |
| `cachedlayer-linestyle-linecap` | [`CapStyle`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes.linestyle#capstyle) | The line cap style |
| `cachedlayer-linestyle-linedashoffset` | `number` | Line dash offset of dashed line |
| `cachedlayer-linestyle-linejoin` | [`JoinStyle`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes.linestyle#joinstyle) | The line join style |
| `cachedlayer-linestyle-pixelsnapmode` | `boolean` | Pixel Snap Mode, default( |
| `cachedlayer-linestyle-scalable` | `boolean` | True if width should depend on transformation |
| `cachedlayer-linestyle-unit` | `string` | Optional unit for the width |
| `cachedlayer-linestyle-width` | `number | string` | The line thickness |
| `cachedlayer-localtransform` | [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation#css-props) | Local transformation |
| `cachedlayer-localtransform-dx` | `number` | X axis translation |
| `cachedlayer-localtransform-dy` | `number` | Y axis translation |
| `cachedlayer-localtransform-xx` | `number` | X scale |
| `cachedlayer-localtransform-xy` | `number` | Xy skew |
| `cachedlayer-localtransform-yx` | `number` | Yx skew |
| `cachedlayer-localtransform-yy` | `number` | Y scale |
| `cachedlayer-margins` | `number | string` | It has properties for specifying the margins for each side |
| `cachedlayer-modellimits` | [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect#css-props) | Define inner model coordinates of the group |
| `cachedlayer-name` | `string` | Name of the node. It is often used for debugging purposes or to simplify queries |
| `cachedlayer-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 |
| `cachedlayer-opacityblendmode` | [`BlendMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#blendmode#blendmode) | Node opacity mode to blend it |
| `cachedlayer-padding` | `number | string` | It has properties for specifying the padding for each side |
| `cachedlayer-pickingchildren` | `boolean` | Enable picking children |
| `cachedlayer-scalescrollstrategy` | [`ScaleScrollStrategy`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.scalescrollstrategy.scalescrollstrategy#css-props) | Scale scroll strategy |
| `cachedlayer-scalescrollstrategy-enabled` | `boolean` | Enable flag |
| `cachedlayer-selectable` | `boolean` | Selectable node, a boolean to determine if selection should consider this node |
| `cachedlayer-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 |
| `cachedlayer-transform` | `string` | Additional CSS transformation applied to node or &#x27;none&#x27; |
| `cachedlayer-transform` | [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation#css-props) | Additional CSS transformation applied to node or &#x27;none&#x27; |
| `cachedlayer-verticalflip` | `boolean` | Vertical axis goes from bottom to top |
| `cachedlayer-viewcache` | `boolean` | View cache to cache child nodes |
| `cachedlayer-visible` | `boolean` | Visibility of the node, a boolean to determine if the node should be rendered or not |
| `cachedlayer-z-index` | `number` | Define node z-index |
| `cachedlayer` | [`Layer`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.layer.layer#css-props) | Layer to which handles will be added. Cache enabled |
| `cachedlayer-clipping` | `boolean` | Enable clipping, this does not consider the clipstyle, it is related to bounds-clipping |
| `cachedlayer-clipstyle` | [`ClipStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.clipstyle.clipstyle#css-props) | Clipping style |
| `cachedlayer-clipstyle` | [`GraphicsPath`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.graphicspath.graphicspath#css-props) | Clipping style |
| `cachedlayer-cssclass` | `string` | The css class name of this node |
| `cachedlayer-csscursor` | `string` | CSS cursor associated with node |
| `cachedlayer-cssstyle` | `string` | CSS style to be applied to inserted elements |
| `cachedlayer-id` | `string | number` | Id of the node, its a unique identifier |
| `cachedlayer-infinity` | `boolean` | Mode to render outside the model limits |
| `cachedlayer-localtransform` | [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation#css-props) | Local transformation |
| `cachedlayer-margins` | `number | string` | It has properties for specifying the margins for each side |
| `cachedlayer-name` | `string` | Name of the node. It is often used for debugging purposes or to simplify queries |
| `cachedlayer-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 |
| `cachedlayer-opacityblendmode` | [`BlendMode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#blendmode#blendmode) | Node opacity mode to blend it |
| `cachedlayer-scalescrollstrategy` | [`ScaleScrollStrategy`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.scalescrollstrategy.scalescrollstrategy#css-props) | Scale scroll strategy |
| `cachedlayer-selectable` | `boolean` | Selectable node, a boolean to determine if selection should consider this node |
| `cachedlayer-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 |
| `cachedlayer-transform` | `string` | Additional CSS transformation applied to node or &#x27;none&#x27; |
| `cachedlayer-transform` | [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation#css-props) | Additional CSS transformation applied to node or &#x27;none&#x27; |
| `cachedlayer-visible` | `boolean` | Visibility of the node, a boolean to determine if the node should be rendered or not |
| `cachedlayer-z-index` | `number` | Define node z-index |
| `enabled` | `boolean` | Enabled state |
| `handlesize` | `number` | Handle size |
| `handlestyles` | [`HandleStyles`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog#widgets-4#tools-5#abstractlogvisualeditingtool#abstractlogvisualeditingtool#handlestyles) | Object containing stylings for different types of handle states |
| `handlestyles-activefillstyle` | `string` | Fill Style of the handle when it is selected and active |
| `handlestyles-activefillstyle` | [`FillStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.fillstyle.fillstyle#css-props) | Fill Style of the handle when it is selected and active |
| `handlestyles-activelinestyle` | `string` | Line Style of the handle when it is active |
| `handlestyles-activelinestyle` | [`LineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.linestyle.linestyle#css-props) | Line Style of the handle when it is active |
| `handlestyles-ghostfillstyle` | `string` | Fill Style of the handle when it is in ghost state |
| `handlestyles-ghostfillstyle` | [`FillStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.fillstyle.fillstyle#css-props) | Fill Style of the handle when it is in ghost state |
| `handlestyles-ghostlinestyle` | `string` | Line Style of the handle when it is in ghost state |
| `handlestyles-ghostlinestyle` | [`LineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.linestyle.linestyle#css-props) | Line Style of the handle when it is in ghost state |
| `handlestyles-inactivefillstyle` | `string` | Fill Style of the handle when it is selected and inactive |
| `handlestyles-inactivefillstyle` | [`FillStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.fillstyle.fillstyle#css-props) | Fill Style of the handle when it is selected and inactive |
| `handlestyles-inactivelinestyle` | `string` | Line Style of the handle when it is inactive |
| `handlestyles-inactivelinestyle` | [`LineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.linestyle.linestyle#css-props) | Line Style of the handle when it is inactive |
| `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` | [`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-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-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 &#x27;none&#x27; |
| `layer-transform` | [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation#css-props) | Additional CSS transformation applied to node or &#x27;none&#x27; |
| `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 DepthShiftingTool(options)

• **new DepthShiftingTool**(`options?`)

#### Parameters

| Name  | Type  |
|  --- | --- |
| `Optional` `options` | [`CompositeNode`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.compositenode.compositenode)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)&gt; | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool#depthshiftingtool#options) |


#### Overrides

AbstractLogVisualEditingTool.constructor

Methods
#### addDepthMapping

▸ **addDepthMapping**(`mapping`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Sets depth mapping array

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `mapping` | { `from`: `number` ; `to`: `number`  } | { `from`: `number` ; `to`: `number`  }[] | array of depth mappings |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

this

#### addHandle

▸ `Protected` **addHandle**(`handle`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Add editor handle

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `handle` | [`GhostBearingHandle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.editing.ghostbearinghandle.ghostbearinghandle) | editor handle |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

this

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[addHandle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#addhandle)

#### addListener

▸ **addListener**(`eventName`, `listener`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

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

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[addListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#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

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[captureMouseUp](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#capturemouseup)

#### clearDepthMapping

▸ **clearDepthMapping**(): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Remove all depth mappings from this tool

#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

this

#### clearHandles

▸ `Protected` **clearHandles**(): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Clears all the handles from the adapter and manipulator layer

#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

#### dispose

▸ **dispose**(): `void`

Dispose tool.

#### Returns

`void`

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[dispose](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#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

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[fireEvent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#fireevent)

#### getActiveHandle

▸ **getActiveHandle**(): [`GhostBearingHandle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.editing.ghostbearinghandle.ghostbearinghandle)

Returns currently active handle,if exists, otherwise null

#### Returns

[`GhostBearingHandle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.editing.ghostbearinghandle.ghostbearinghandle)

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getActiveHandle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#getactivehandle)

#### getCachedManipulatorLayer

▸ **getCachedManipulatorLayer**(): [`CompositeNode`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.compositenode.compositenode)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)&gt;

Gets the manipulator layer with contains handles

**`Deprecated`**

since 4.0. Use [AbstractLogVisualEditingTool#getManipulatorLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#getmanipulatorlayer) instead

#### Returns

[`CompositeNode`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.compositenode.compositenode)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)&gt;

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getCachedManipulatorLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#getcachedmanipulatorlayer)

#### getClassName

▸ **getClassName**(): `string`

#### Returns

`string`

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#getclassname)

#### getDepthLabel

▸ `Protected` **getDepthLabel**(`mapping`): `string`

Returns depth label text

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `mapping` | `Object` | depth mapping |
| `mapping.from` | `number` | - 
 |
| `mapping.to` | `number` | - 
 |


#### Returns

`string`

depth label

#### getDepthMapping

▸ **getDepthMapping**(`index`): `Object`

Return depth mapping by specified index

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `index` | `number` | depth mapping index |


#### Returns

`Object`

depth mapping

| Name | Type |
|  --- | --- |
| `from` | `number` |
| `to` | `number` |


#### getDepthMappings

▸ **getDepthMappings**(): { `from`: `number` ; `to`: `number`  }[]

#### Returns

{ `from`: `number` ; `to`: `number`  }[]

depth mappings

#### getDepthMappingsCount

▸ **getDepthMappingsCount**(): `number`

Returns depth mappings count

#### Returns

`number`

depth mappings count

#### getDeviceXY

▸ `Protected` **getDeviceXY**(`args`): [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point)

Returns a point in model coordinates, edits one of the util points

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `args` | [`EventArgs`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.eventargs.eventargs) | Event arguments |


#### Returns

[`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point)

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getDeviceXY](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#getdevicexy)

#### 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

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getEventRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#geteventradius)

#### getHandle

▸ `Protected` **getHandle**(`index`): [`GhostBearingHandle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.editing.ghostbearinghandle.ghostbearinghandle)

#### Parameters

| Name  | Type  |
|  --- | --- |
| `index` | `number` |


#### Returns

[`GhostBearingHandle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.editing.ghostbearinghandle.ghostbearinghandle)

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getHandle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#gethandle)

#### getHandlePainter

▸ **getHandlePainter**(): [`Painter`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene#symbolshape#painter)

Gets the shape painter with which is used to render handles. Format is the same as in [SymbolShape](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.shapes.symbolshape.symbolshape)
Redraws all handles

#### Returns

[`Painter`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene#symbolshape#painter)

painter

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getHandlePainter](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#gethandlepainter)

#### getHandleSize

▸ **getHandleSize**(): `number`

Get the size of the handles

#### Returns

`number`

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getHandleSize](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#gethandlesize)

#### getHandleStyles

▸ **getHandleStyles**(): [`HandleStylesOut`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool#depthshiftingtool#handlestylesout)

Returns registered styles for active, inactive, and ghost states of all handles

#### Returns

[`HandleStylesOut`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool#depthshiftingtool#handlestylesout)

object containing stylings for different types of handle states

#### Overrides

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getHandleStyles](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#gethandlestyles)

#### getHandlesCount

▸ `Protected` **getHandlesCount**(): `number`

Return number of handles

#### Returns

`number`

number of handles

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getHandlesCount](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#gethandlescount)

#### getHideGhostOnDrop

▸ **getHideGhostOnDrop**(): `boolean`

Gets a flag defining if the ghost should be reset after it has been dropped

#### Returns

`boolean`

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getHideGhostOnDrop](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#gethideghostondrop)

#### getManipulatorLayer

▸ **getManipulatorLayer**(): [`CompositeNode`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.compositenode.compositenode)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)&gt;

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)&gt;

layer

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getManipulatorLayer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#getmanipulatorlayer)

#### getMode

▸ **getMode**(): [`Mode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool#mode)

Retrieves the type of editing that this adapter is doing

#### Returns

[`Mode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool#mode)

#### getMouseRadius

▸ **getMouseRadius**(): `number`

Returns current device radius for mouse events

#### Returns

`number`

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getMouseRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#getmouseradius)

#### getName

▸ **getName**(): `string`

return tool name if any

#### Returns

`string`

name of the tool

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#getname)

#### 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

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getParentTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#getparenttool)

#### getPosition

▸ **getPosition**(): [`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point)

Returns the last registered position of the mouse in device space

#### Returns

[`Point`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.point.point)

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getPosition](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#getposition)

#### getProperties

▸ **getProperties**(): [`OptionsOut`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog#abstractlogvisualeditingtool#optionsout)

Returns all the properties pertaining to this object

#### Returns

[`OptionsOut`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog#abstractlogvisualeditingtool#optionsout)

An object containing the properties

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#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

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getProperty](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#getproperty)

#### getPropertyKeys

▸ **getPropertyKeys**(): `string`[]

Returns known properties keys

#### Returns

`string`[]

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getPropertyKeys](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#getpropertykeys)

#### getRange

▸ **getRange**(): [`Range`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.range.range)

Return depth range model limits

#### Returns

[`Range`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.range.range)

depth range model limits

#### 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

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getRoot](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#getroot)

#### getShape

▸ **getShape**(): [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)

Returns the shape which this tool is manipulating

#### Returns

[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getShape](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#getshape)

#### getShowGhost

▸ **getShowGhost**(): `boolean`

Returns the flag defining if a ghost should be moved instead of the actual object

#### Returns

`boolean`

showGhost Show ghost flag

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getShowGhost](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#getshowghost)

#### getTouchRadius

▸ **getTouchRadius**(): `number`

Returns current device radius for touch events

#### Returns

`number`

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getTouchRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#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

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[hasEventListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#haseventlistener)

#### isActive

▸ **isActive**(): `boolean`

return active state

#### Returns

`boolean`

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[isActive](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#isactive)

#### isDisposed

▸ **isDisposed**(): `boolean`

Returns whether this object has been disposed

#### Returns

`boolean`

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[isDisposed](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#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

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[isDoubleClick](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#isdoubleclick)

#### isEnabled

▸ **isEnabled**(): `boolean`

returns enable state

#### Returns

`boolean`

state

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[isEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#isenabled)

#### isSilent

▸ **isSilent**(): `boolean`

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

#### Returns

`boolean`

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[isSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#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

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[isTouchEvent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#istouchevent)

#### makeSelection

▸ `Protected` **makeSelection**(`x`, `y`): [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)[]

Makes a selection according to current position of the pointer

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `x` | `number` | X coordinate of the pointer |
| `y` | `number` | Y coordinate of the pointer |


#### Returns

[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)[]

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[makeSelection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#makeselection)

#### notify

▸ **notify**<`E`&gt;(`type`, `source`, `args?`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Notify listeners

#### Type parameters

| Name | Type |
|  --- | --- |
| `E` | extends `string` |


#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `type` | `E` | event types |
| `source` | [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool) | of the event |
| `Optional` `args` | [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool#depthshiftingtool#eventmap)[`E`] | arguments of the event |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

this

#### Overrides

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[notify](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#notify)

#### off

▸ **off**<`E`&gt;(`type?`, `callback?`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

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`: [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool), `args`: [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool#depthshiftingtool#eventmap)[`E`]) => `void` | function to be called |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

this

#### Overrides

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[off](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#off)

#### on

▸ **on**<`E`&gt;(`type`, `callback`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Attach listener on event that will be called whenever the specified event is delivered to the target
<p>
If the callback function is already in the list of event listeners for this target, the function is not added a second time.
</p>
<p>
If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.
</p>
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 &amp; {
&#91;MyToolEvents.onValueChanged&#93;: MyToolEventArgs
}
export enum MyToolEvents {
onValueChanged = 'onValueChanged'
}
export class MyTool extends AbstractTool {
public declare on: &lt;E extends keyof EventMap&gt;(type: E, callback: (eventType: E, sender: this, args: EventMap&#91;E&#93;) =&gt; void) =&gt; this;
protected declare notify: &lt;E extends keyof EventMap&gt;(type: E, source: AbstractTool, args?: EventMap&#91;E&#93;) =&gt; this;
public declare off: &lt;E extends keyof EventMap&gt;(type: E, callback?: (eventType: E, sender: this, args: EventMap&#91;E&#93;) =&gt; void) =&gt; this;
// ...
}
```

#### Type parameters

| Name | Type |
|  --- | --- |
| `E` | extends `string` |


#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `type` | `E` | type of event or property |
| `callback` | (`eventType`: `E`, `sender`: [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool), `args`: [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool#depthshiftingtool#eventmap)[`E`]) => `void` | to be called |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

#### Overrides

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[on](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#on)

#### onActiveStateChanged

▸ `Protected` **onActiveStateChanged**(): `void`

**`Fires`**

[Events.onStateChanged](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.controls#tools#abstracttool#events#onstatechanged)

#### Returns

`void`

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[onActiveStateChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#onactivestatechanged)

#### onEnabledStateChanged

▸ `Protected` **onEnabledStateChanged**(): `void`

Called when the tool is enabled or disabled

#### Returns

`void`

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[onEnabledStateChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#onenabledstatechanged)

#### onMouseDown

▸ **onMouseDown**(`eventArgs`): `void`

Handles the event caused by user pressing the mouse button

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `eventArgs` | [`EventArgs`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.eventargs.eventargs) | Native event arguments received from EventDispatcher |


#### Returns

`void`

#### Overrides

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[onMouseDown](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#onmousedown)

#### onMouseMove

▸ **onMouseMove**(`eventArgs`): `void`

Handles the event caused by user moving the mouse

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `eventArgs` | [`EventArgs`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.eventargs.eventargs) | Native event arguments received from EventDispatcher |


#### Returns

`void`

#### Overrides

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[onMouseMove](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#onmousemove)

#### onMouseUp

▸ **onMouseUp**(`eventArgs`): `void`

Handles the event caused by user releasing the mouse button

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `eventArgs` | [`EventArgs`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.eventargs.eventargs) | Native event arguments received from EventDispatcher |


#### Returns

`void`

#### Overrides

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[onMouseUp](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#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

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[pageToCanvas](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#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

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[pointToModel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#pointtomodel)

#### removeDepthMapping

▸ **removeDepthMapping**(`index`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Remove depth maooing at specified index

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `index` | `number` | depth mapping index |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

this

#### removeHandle

▸ `Protected` **removeHandle**(`handle`, `disposeHandles?`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Remove handles

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `handle` | [`GhostBearingHandle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.editing.ghostbearinghandle.ghostbearinghandle) | [`GhostBearingHandle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.editing.ghostbearinghandle.ghostbearinghandle)[] | handle or array of handles to be removed |
| `Optional` `disposeHandles` | `boolean` | - 
 |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

this

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[removeHandle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#removehandle)

#### removeListener

▸ **removeListener**(`eventName`, `listener?`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

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

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[removeListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#removelistener)

#### setActive

▸ **setActive**(`active`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

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

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[setActive](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#setactive)

#### setActiveHandle

▸ **setActiveHandle**(`handle`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Sets the handle currently active

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `handle` | [`GhostBearingHandle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.editing.ghostbearinghandle.ghostbearinghandle) | The handle to be active |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[setActiveHandle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#setactivehandle)

#### setDepthLabelCallback

▸ **setDepthLabelCallback**(`callback`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Set visuals filter callback

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `callback` | [`DepthLabelCallback`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool#depthshiftingtool#depthlabelcallback) | visuals filter callback |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

this

#### setEnabled

▸ **setEnabled**(`enabled`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

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

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

this

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[setEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#setenabled)

#### setHandlePainter

▸ **setHandlePainter**(`painter`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Sets the shape painter with which the handles will be drawn. Format is the same as in
geotoolkit.scene.shapes.SymbolShape
Redraws all handles

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `painter` | [`Painter`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene#symbolshape#painter) | The painter which will be used to draw the handles for linearly interpolated curves |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[setHandlePainter](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#sethandlepainter)

#### setHandleSize

▸ **setHandleSize**(`size`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Sets the pixel side of the handles to which a size is applicable (anchored handles)

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `size` | `number` | The size of the handles in device coordinates (pixels) |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[setHandleSize](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#sethandlesize)

#### setHandleStyles

▸ **setHandleStyles**(`styles`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Sets styles for active, inactive, and ghost states of all handles, and redraws each handle (this will lose edited handles position)

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `styles` | [`HandleStyles`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool#depthshiftingtool#handlestyles) | object containing stylings for different types of handle states |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

#### Overrides

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[setHandleStyles](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#sethandlestyles)

#### setHandlesVisible

▸ `Protected` **setHandlesVisible**(`visible`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Iterates through handles and sets the provided visibility.
If the visibility is to hide, hides the ghosts as well

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `visible` | `boolean` | Visibility flag for handles |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[setHandlesVisible](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#sethandlesvisible)

#### setHideGhostOnDrop

▸ **setHideGhostOnDrop**(`hide`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Gets a flag defining if the ghost should be reset after it has been dropped

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `hide` | `boolean` | True to hide ghosts when dropped |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[setHideGhostOnDrop](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#sethideghostondrop)

#### setMode

▸ **setMode**(`mode`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Sets what kind of edition this adapter has to do for the curve

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `mode` | [`Mode`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool#mode) | The new mode in which this tool will work |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

#### setMouseRadius

▸ **setMouseRadius**(`radius`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Sets device radius for mouse events

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `radius` | `number` | radius for mouse events |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

this

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[setMouseRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#setmouseradius)

#### setName

▸ **setName**(`name`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

set tool name

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `name` | `string` | the tool name |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[setName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#setname)

#### setPosition

▸ **setPosition**(`x`, `y`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Sets the last registered position of the mouse in device space

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `x` | `number` | The new X position |
| `y` | `number` | The new Y position |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[setPosition](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#setposition)

#### setProperties

▸ **setProperties**(`properties?`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Sets all the properties pertaining to this object

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `Optional` `properties` | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog#abstractlogvisualeditingtool#options) | An object containing the properties to set |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

this

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[setProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#setproperties)

#### setProperty

▸ **setProperty**(`name`, `value`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Sets dynamic property by name

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `name` | `string` | property name |
| `value` | `any` | property value |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

this

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[setProperty](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#setproperty)

#### setRange

▸ **setRange**(`limits`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Sets depth range model limits

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `limits` | [`Range`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.range.range) | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#range#options) | depth range model limits |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

this

#### setShape

▸ **setShape**(`curve`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Sets the shape which this tool has to manipulate and calculate its handles from.

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `curve` | [`LogCurve`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.logcurve.logcurve) | The new shape to set for manipulation |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

#### Overrides

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[setShape](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#setshape)

#### setShowGhost

▸ **setShowGhost**(`showGhost`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Sets the flag defining if a ghost should be moved instead of the actual handle

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `showGhost` | `boolean` | Show ghost flag |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[setShowGhost](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#setshowghost)

#### setSilent

▸ **setSilent**(`bool`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Set silent mode

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `bool` | `boolean` | flag to enable silent mode |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

this

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[setSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#setsilent)

#### setSlotEnabled

▸ **setSlotEnabled**(`eventName`, `value`, `target?`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Sets slot enabled

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `eventName` | `string` | eventName |
| `value` | `boolean` | value |
| `Optional` `target` | `EventTarget` | target |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[setSlotEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#setslotenabled)

#### setSlots

▸ **setSlots**(`slots?`, `merge?`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Sets new slots.

**`Example`**

```ts
const slots = {
'pointerdown': (event: EventArgs) =&gt; {
// 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`&gt; | type of system events |
| `Optional` `merge` | `boolean` | set to true if you want to merge with existing slots |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

this

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[setSlots](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#setslots)

#### setTouchRadius

▸ **setTouchRadius**(`radius`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

Sets device radius for touch events

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `radius` | `number` | radius for touch events |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

this

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[setTouchRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#settouchradius)

#### start

▸ `Protected` **start**(`eventArgs?`): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

start

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `Optional` `eventArgs` | [`EventArgs`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.tools.eventargs.eventargs) | event args |


#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[start](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#start)

#### stop

▸ `Protected` **stop**(): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

stop

#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[stop](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#stop)

#### toggle

▸ **toggle**(): [`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

switch enable state to opposite state

#### Returns

[`DepthShiftingTool`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.depthshiftingtool.depthshiftingtool)

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[toggle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#toggle)

#### update

▸ **update**(): `void`

Updates tool

#### Returns

`void`

#### Overrides

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[update](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#update)

#### 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

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[canvasToClient](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#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

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[clientToCanvas](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#clienttocanvas)

#### getClassName

▸ `Static` **getClassName**(): `string`

#### Returns

`string`

#### Inherited from

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#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

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getExclusiveTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#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

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[getNativeEventName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#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

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[isTouchEvent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#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

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[lock](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#lock)

#### mapDepths

▸ `Static` **mapDepths**(`limits`, `mapping`, `depths`): `number`[]

Interpolate specified depths with specified depth mappings array

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `limits` | [`Range`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.range.range) | depth range model limits |
| `mapping` | { `from`: `number` ; `to`: `number`  }[] | depth mappings |
| `depths` | `number`[] | array of depths to interpolate |


#### Returns

`number`[]

interpolated depths array

#### 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

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[setDefaultMouseRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#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

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[setDefaultTouchRadius](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#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

[AbstractLogVisualEditingTool](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool).[unlock](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.widgets-4.tools-5.abstractlogvisualeditingtool.abstractlogvisualeditingtool#unlock)