[API](/solutions/geotoolkit/geotoolkit_js/apis/readme) / [geotoolkit](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit) / [welllog](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog) / [multiwell](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog#multiwell) / [correlation](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog#correlation) / [Correlation](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog#correlation) / Correlation

# Class: Correlation

[correlation](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog#correlation).[Correlation](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog#correlation).Correlation

Define an abstract correlation to displayed in the correlation track

## Hierarchy

- [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)
↳ **`Correlation`**
↳↳ [`CompositeCorrelation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.compositecorrelation.compositecorrelation)
↳↳ [`CorrelationMarker`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlationmarker.correlationmarker)
↳↳ [`CorrelationRange`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlationrange.correlationrange)


## Table of contents

Constructors
- [new Correlation(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation.md#new correlation(options))


Methods
| [addCssClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#addcssclass) | [addInvalidateHandler](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#addinvalidatehandler) | [checkCollision](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#checkcollision) |
|  --- | --- | --- |
| [clone](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#clone) | [connectStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#connectstyle) | [copyConstructor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#copyconstructor) |
| [disconnectStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#disconnectstyle) | [dispose](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#dispose) | [enableEventPropagation](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#enableeventpropagation) |
| [execute](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#execute) | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#getclassname) | [getCssClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#getcssclass) |
| [getCssClasses](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#getcssclasses) | [getId](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#getid) | [getInvalidateMethod](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#getinvalidatemethod) |
| [getLeftWell](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#getleftwell) | [getLineStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#getlinestyle) | [getName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#getname) |
| [getParent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#getparent) | [getProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#getproperties) | [getProperty](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#getproperty) |
| [getPropertyKeys](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#getpropertykeys) | [getRightWell](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#getrightwell) | [getRoot](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#getroot) |
| [getSceneTransform](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#getscenetransform) | [getTag](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#gettag) | [getVisible](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#getvisible) |
| [getWorldTransform](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#getworldtransform) | [getZIndex](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#getzindex) | [hasCssClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#hascssclass) |
| [hasEventListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#haseventlistener) | [invalidate](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#invalidate) | [invalidateParent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#invalidateparent) |
| [isDisposed](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#isdisposed) | [isEventPropagationEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#iseventpropagationenabled) | [isNotificationEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#isnotificationenabled) |
| [isSelectable](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#isselectable) | [isSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#issilent) | [notify](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#notify) |
| [off](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#off) | [on](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#on) | [onParentChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#onparentchanged) |
| [onVisibilityChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#onvisibilitychanged) | [removeCssClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#removecssclass) | [removeInvalidateHandler](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#removeinvalidatehandler) |
| [render](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#render) | [renderAsync](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#renderasync) | [setCssClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#setcssclass) |
| [setId](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#setid) | [setLineStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#setlinestyle) | [setName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#setname) |
| [setNotification](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#setnotification) | [setParent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#setparent) | [setProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#setproperties) |
| [setProperty](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#setproperty) | [setSelectable](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#setselectable) | [setSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#setsilent) |
| [setTag](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#settag) | [setVisible](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#setvisible) | [setWells](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#setwells) |
| [setZIndex](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#setzindex) | [toString](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#tostring) | [updateSceneTransformation](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#updatescenetransformation) |
| [updateState](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#updatestate) | [updateTimeStamp](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#updatetimestamp) | [enableSceneGraphNotification](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#enablescenegraphnotification) |
| [findParent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#findparent) | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#getclassname-1) | [isSceneGraphNotificationEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation#isscenegraphnotificationenabled) |


Css Properties
| Name  | Type  | Description |
|  --- | --- | --- |
| `cssclass` | `string` | The css class name of this node |
| `id` | `string | number` | Id of the node, its a unique identifier |
| `linestyle` | `string` | Applied style |
| `linestyle` | [`LineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.linestyle.linestyle#css-props) | Applied style |
| `linestyle-color` | `string` | Color in CSS form |
| `linestyle-fill` | `string` | Optional fill style to be used to fill lines generated with this style |
| `linestyle-fill` | [`FillStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.fillstyle.fillstyle#css-props) | Optional fill style to be used to fill lines generated with this style |
| `linestyle-fill-color` | `string` | Color in CSS form |
| `linestyle-fill-evenoddmode` | `boolean` | Even-odd fill mode |
| `linestyle-fill-fillpattern` | [`Pattern`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.pattern.pattern#css-props) | Pattern |
| `linestyle-fill-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 |
| `linestyle-fill-fillpattern-patternname` | `string` | Name of this pattern for indexing |
| `linestyle-fill-fillpattern-scalable` | `boolean` | Flag that sets scalability of the pattern
coordinates, or relative to the shape it is filling (It is not supported) |
| `linestyle-fill-foreground` | `string` | Foreground color |
| `linestyle-fill-pattern` | [`Pattern`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.pattern.pattern#css-props) | Pattern |
| `linestyle-linecap` | [`CapStyle`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes.linestyle#capstyle) | The line cap style |
| `linestyle-linedashoffset` | `number` | Line dash offset of dashed line |
| `linestyle-linejoin` | [`JoinStyle`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes.linestyle#joinstyle) | The line join style |
| `linestyle-pixelsnapmode` | `boolean` | Pixel Snap Mode, default( |
| `linestyle-scalable` | `boolean` | True if width should depend on transformation |
| `linestyle-unit` | `string` | Optional unit for the width |
| `linestyle-width` | `number | string` | The line thickness |
| `name` | `string` | Name of the node. It is often used for debugging purposes or to simplify queries |
| `selectable` | `boolean` | Selectable node, a boolean to determine if selection should consider this node |
| `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 |
| `visible` | `boolean` | Visibility of the node, a boolean to determine if the node should be rendered or not |
| `z-index` | `number` | Define node z-index |


## Contents

Constructors
#### new Correlation(options)

• `Protected` **new Correlation**(`options?`)

Creates correlation

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `Optional` `options` | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.welllog#correlation#options) | options to create correlation |


#### Overrides

Node.constructor

Methods
#### addCssClass

▸ **addCssClass**(`cssclass`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Adds new css class to node

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `cssclass` | `string` | `string`[] | css class name('s) |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[addCssClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#addcssclass)

#### addInvalidateHandler

▸ **addInvalidateHandler**(`handler`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Add invalidate handler

**`Deprecated`**

since 4.0, use Node.on instead

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `handler` | `Function` | handler to be notified about invalidation |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[addInvalidateHandler](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#addinvalidatehandler)

#### checkCollision

▸ **checkCollision**(`context`): `boolean`

Check if this node is within the area being rendered by the context

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `context` | [`RenderingContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.renderingcontext.renderingcontext) | Rendering Context |


#### Returns

`boolean`

true if object is inside of renderable area

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[checkCollision](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#checkcollision)

#### clone

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

All subclasses should override copyConstructor or provide custom implementation for this method

#### Returns

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

clone

#### Inherited from

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

#### connectStyle

▸ **connectStyle**(`style`, `type`, `callback`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Connects style.<br>
<br>
This convenience method subscribes a listener to given style for the specified type.<br>
And automatically un-subscribes listener if node is disposed to prevent memory leaks

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `style` | [`EventDispatcher`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher) | connect style |
| `type` | `string` | type of event or property |
| `callback` | [`AttributeCallback`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#istylelistener#attributecallback)<[`EventDispatcher`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher)&gt; | function to be called |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[connectStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#connectstyle)

#### copyConstructor

▸ `Protected` **copyConstructor**(`src`, `deepCopy?`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Copy constructor function.<br>
Function used as part of the cloning mechanism.<br>
Implementations should copy the given instance state to this instance.<br>

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `src` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | Source to copy from |
| `Optional` `deepCopy` | `boolean` | deep copy |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[copyConstructor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#copyconstructor)

#### disconnectStyle

▸ **disconnectStyle**(`style`, `type`, `callback`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Disconnect style
<br>
This convenience method un-subscribes a listener to given style for the specified type.<br>

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `style` | [`EventDispatcher`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher) | connect style |
| `type` | `string` | type of event or property |
| `callback` | [`AttributeCallback`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#istylelistener#attributecallback)<[`EventDispatcher`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher)&gt; | function to be called |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[disconnectStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#disconnectstyle)

#### dispose

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

Disposes this node, once disposes a node should not be used anymore.<br>
Clear all listeners, and disconnect styles to avoid memory leaks.<br>
Also aggressively 'cleanup' this node by setting some of its members to null.

#### Returns

`void`

#### Inherited from

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

#### enableEventPropagation

▸ **enableEventPropagation**(`enable`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Enable event propagation from the node hierarchy from bottom to top
<p>
This option is similar to DOM Event bubbling, which allows
to get any event from child node. By default it is disabled
for better performance.
</p>

**`Example`**

```ts
import {Group} from '@int/geotoolkit/scene/Group';
import {Events as SceneEvents} from '@int/geotoolkit/scene/Node';
const parentGroup = new Group()
.setName('ParentGroup')
.enableEventPropagation(true);
const childGroup = new Group()
.setName('ChildGroup');

parentGroup.addChild(childGroup);
parentGroup.on(SceneEvents.Invalidate, (eventName, sender, args) =&gt; {
// Got notifications from all children of parent group
});
childGroup.invalidate();
```

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `enable` | `boolean` | enable |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[enableEventPropagation](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#enableeventpropagation)

#### execute

▸ **execute**(`delegate`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Executes delegate and return the result. It allows us to keep all initialization calls in one place, <br>
and we do not need to scroll up or down in IDE to find how and where it was initialized.

**`Example`**

```ts
// All setters (.setName() for example) returns reference to the this.
// In order to modify inner object like LineStyle or Pattern, to get this object (property) we should call getter to get object reference.
// Then modify it as shown below in Option 1 or you can use execute methods shown in Option 2.
import {Group} from '@int/geotoolkit/scene/Group';
import {Rect} from '@int/geotoolkit/util/Rect';
// Option 1
const group = new Group()
.setName('MyGroup')
.setBounds(new Rect(0, 0, 42, 16))
.enableClipping(true)
.setTag({'type': 'sometype'});

group.getLineStyle().setPattern('pattern');
return group;

// Options 2 ( using execute method )
return group
.execute(function () {
this.getLineStyle()
.setPattern("pattern");
});
```

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `delegate` | (`this`: [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)) => `void` | Function to execute |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

The result if any or this

#### Inherited from

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

▸ **execute**<`T`&gt;(`delegate`): `T`

#### Type parameters

| Name |
|  --- |
| `T` |


#### Parameters

| Name  | Type  |
|  --- | --- |
| `delegate` | (`this`: [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)) => `T` |


#### Returns

`T`

#### Inherited from

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

#### getClassName

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

#### Returns

`string`

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#getclassname)

#### getCssClass

▸ **getCssClass**(): `string`

Returns css class name to be used to apply CSS style

#### Returns

`string`

the css class name

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[getCssClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#getcssclass)

#### getCssClasses

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

Gets list of css class names which applied to this node

#### Returns

`string`[]

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[getCssClasses](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#getcssclasses)

#### getId

▸ **getId**(): `string` | `number`

Returns the associated identifier of the node

#### Returns

`string` | `number`

The node's id

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[getId](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#getid)

#### getInvalidateMethod

▸ `Protected` **getInvalidateMethod**(): [`AttributeCallback`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#istylelistener#attributecallback)<[`EventDispatcher`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher)&gt;

Gets invalidate method

#### Returns

[`AttributeCallback`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#istylelistener#attributecallback)<[`EventDispatcher`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher)&gt;

method to invalidate this object

#### getLeftWell

▸ **getLeftWell**(): [`ITrack`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.itrack.itrack)

Return left well

#### Returns

[`ITrack`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.itrack.itrack)

#### getLineStyle

▸ **getLineStyle**(): [`LineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.linestyle.linestyle)

Returns line style of correlation.

#### Returns

[`LineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.linestyle.linestyle)

#### getName

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

Returns the node name

#### Returns

`string`

The node name

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[getName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#getname)

#### getParent

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

Return parent node

#### Returns

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

parent node

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[getParent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#getparent)

#### getProperties

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

Gets all the properties pertaining to this object

#### Parameters

| Name  | Type  |
|  --- | --- |
| `Optional` `context` | [`ISerializationContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.persistence.iserializationcontext.iserializationcontext) |


#### Returns

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

properties object

#### Overrides

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[getProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#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

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[getProperty](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#getproperty)

#### getPropertyKeys

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

Returns known properties keys

#### Returns

`string`[]

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[getPropertyKeys](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#getpropertykeys)

#### getRightWell

▸ **getRightWell**(): [`ITrack`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.itrack.itrack)

Return right well

#### Returns

[`ITrack`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.itrack.itrack)

#### getRoot

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

Returns root node. <br>
If node doesn't have parent then it returns itself.

#### Returns

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

the root node

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[getRoot](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#getroot)

#### getSceneTransform

▸ **getSceneTransform**(): [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation)

Returns transformation from node to root scene

#### Returns

[`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation)

a transformation from node to root scene

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[getSceneTransform](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#getscenetransform)

#### getTag

▸ **getTag**(): `any`

Returns the object associated with the node by user.

#### Returns

`any`

The node's user-object

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[getTag](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#gettag)

#### getVisible

▸ **getVisible**(): `boolean`

Return visibility of the node

#### Returns

`boolean`

true if node is visible

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[getVisible](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#getvisible)

#### getWorldTransform

▸ **getWorldTransform**(): [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation)

<code>getWorldTransform</code> retrieves the local transformation
of the inner node coordinates to parent coordinates.

#### Returns

[`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation)

the world transform.

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[getWorldTransform](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#getworldtransform)

#### getZIndex

▸ **getZIndex**(): `number`

Returns node z-index (null if not set)

#### Returns

`number`

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[getZIndex](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#getzindex)

#### hasCssClass

▸ **hasCssClass**(`cssClass`): `boolean`

Check if node has specified css class

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `cssClass` | `string` | css class name |


#### Returns

`boolean`

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[hasCssClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#hascssclass)

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

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[hasEventListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#haseventlistener)

#### invalidate

▸ **invalidate**(`bounds?`, `force?`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Invalidate area of the shape.  This method invalidates parent by default. invalidated from parent to root node.

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `Optional` `bounds` | [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) | bounds of the invalid rectangle in the inner node coordinates |
| `Optional` `force` | `boolean` | true if parent should be invalidated immediately if null is provided then cache (if any will be completely refreshed) otherwise only specified rect or node.bounds will be refreshed |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

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

#### invalidateParent

▸ `Protected` **invalidateParent**(`bounds?`, `force?`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Invalidate parent and notify all listeners.
NOTE: Don't keep arguments of the event, because instance can be changed

**`Fires`**

[Events.Invalidate](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene.node#events#invalidate)

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `Optional` `bounds` | [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect) | bounds of the invalid rectangle in the inner node coordinates |
| `Optional` `force` | `boolean` | force rendering |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[invalidateParent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#invalidateparent)

#### isDisposed

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

Returns whether this object has been disposed

#### Returns

`boolean`

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[isDisposed](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#isdisposed)

#### isEventPropagationEnabled

▸ **isEventPropagationEnabled**(): `boolean`

Return true if event propagation is enabled from child to parent

#### Returns

`boolean`

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[isEventPropagationEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#iseventpropagationenabled)

#### isNotificationEnabled

▸ **isNotificationEnabled**(): `boolean`

return state of notification

#### Returns

`boolean`

current notification state

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[isNotificationEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#isnotificationenabled)

#### isSelectable

▸ **isSelectable**(): `boolean`

Returns true if node can be picked/selected.

#### Returns

`boolean`

The selectable flag

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[isSelectable](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#isselectable)

#### isSilent

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

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

#### Returns

`boolean`

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[isSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#issilent)

#### notify

▸ **notify**<`E`&gt;(`event`, `source`, `args?`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Notify listeners of the Node

#### Type parameters

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


#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `event` | `E` | type of event |
| `source` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | source who called the event |
| `Optional` `args` | [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene.node#node#eventmap)[`E`] | event arguments |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

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

#### off

▸ **off**<`E`&gt;(`type?`, `callback?`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

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`: [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation), `args`: [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene.node#node#eventmap)[`E`]) => `void` | function to be called |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

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

#### on

▸ **on**<`E`&gt;(`type`, `callback`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

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>

#### Type parameters

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


#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `type` | `E` | type of event or property |
| `callback` | (`eventType`: `E`, `sender`: [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation), `args`: [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene.node#node#eventmap)[`E`]) => `void` | to be called |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

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

#### onParentChanged

▸ `Protected` **onParentChanged**(`node`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

This method is called when parent changes. Do not call it directly.

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `node` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | node to change parent |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[onParentChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#onparentchanged)

#### onVisibilityChanged

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

This method is called if visibility is changed.  Send event [Events.VisibilityChanged](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene.node#events#visibilitychanged)

#### Returns

`void`

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[onVisibilityChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#onvisibilitychanged)

#### removeCssClass

▸ **removeCssClass**(`cssclass`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Removes css class from node

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `cssclass` | `string` | `string`[] | css class name('s) |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[removeCssClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#removecssclass)

#### removeInvalidateHandler

▸ **removeInvalidateHandler**(`handler`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Remove invalidate handler

**`Deprecated`**

since 4.0, use Node.off instead

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `handler` | `Function` | handler to be notified about invalidation |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[removeInvalidateHandler](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#removeinvalidatehandler)

#### render

▸ `Abstract` **render**(`context`): `void`

Renders node

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `context` | [`RenderingContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.renderingcontext.renderingcontext) | The rendering context to be used to draw the node |


#### Returns

`void`

#### Inherited from

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

#### renderAsync

▸ **renderAsync**(`context`, `callback`): `void`

Render node in asynchronous mode. Default implementation creates call method "render" inside

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `context` | [`RenderingContext`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.renderer.renderingcontext.renderingcontext) | The rendering context to be used to draw the node |
| `callback` | () => `void` | callback function |


#### Returns

`void`

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[renderAsync](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#renderasync)

#### setCssClass

▸ **setCssClass**(`name`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Sets css class name of the node to be used to apply CSS style

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `name` | `string` | css class name of the node |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[setCssClass](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#setcssclass)

#### setId

▸ **setId**(`id`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Allows the user to associate any identifier

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `id` | `string` | `number` | object id |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[setId](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#setid)

#### setLineStyle

▸ **setLineStyle**(`lineStyle`, `merge?`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Sets correlation marker style

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `lineStyle` | [`Type`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes.linestyle#linestyle#type) | line style or options |
| `Optional` `merge` | `boolean` | true if you want to merge lineStyle with existing attribute, false by default |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### setName

▸ **setName**(`name`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Sets name of the node

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `name` | `string` | The node name |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[setName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#setname)

#### setNotification

▸ **setNotification**(`notify`, `force?`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

set notification state

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `notify` | `boolean` | flag set to invalidate parent or not |
| `Optional` `force` | `boolean` | true if parent should be invalidated immediately |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[setNotification](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#setnotification)

#### setParent

▸ **setParent**(`parent`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Sets parent node. Don't call this method directly.
It is internal method.

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `parent` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | a parent node |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[setParent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#setparent)

#### setProperties

▸ **setProperties**(`properties?`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Sets all the properties pertaining to this object

#### Parameters

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


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

#### Overrides

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[setProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#setproperties)

#### setProperty

▸ **setProperty**(`name`, `value`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Sets dynamic property by name

#### Parameters

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


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[setProperty](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#setproperty)

#### setSelectable

▸ **setSelectable**(`selectable`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Allows to select node. If node is not selectable then child node is
not selectable.

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `selectable` | `boolean` | flag to allow node selection |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[setSelectable](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#setselectable)

#### setSilent

▸ **setSilent**(`bool`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Set silent mode

#### Parameters

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


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[setSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#setsilent)

#### setTag

▸ **setTag**(`tag`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Allows the user to associate any arbitrary object with the node.

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `tag` | `any` | The object to be associated with the node. |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[setTag](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#settag)

#### setVisible

▸ **setVisible**(`value`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Sets visibility of the node.
Send event [Events.VisibilityChanged](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene.node#events#visibilitychanged)

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `value` | `boolean` | flag specifying visibility of the node |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[setVisible](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#setvisible)

#### setWells

▸ **setWells**(`leftWell`, `rightWell`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Sets left and right well

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `leftWell` | [`ITrack`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.itrack.itrack) | left well |
| `rightWell` | [`ITrack`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.itrack.itrack) | right well |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### setZIndex

▸ **setZIndex**(`value`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Sets z-index for node (set null for default)

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `value` | `number` | index determining node z-position |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[setZIndex](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#setzindex)

#### toString

▸ **toString**(): `string`

Returns a string representation of this object (generally the classname)

#### Returns

`string`

A string representation

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[toString](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#tostring)

#### updateSceneTransformation

▸ **updateSceneTransformation**(): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Update scene transformation

#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[updateSceneTransformation](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#updatescenetransformation)

#### updateState

▸ **updateState**(`regions?`, `changes?`): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Update state. These methods reset node state and update state for children. this method is useful to
refresh a scene graph

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `Optional` `regions` | [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect)[] | optional array to return invalid rectangles in the parent coordinates |
| `Optional` `changes` | [`StateChanges`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.scene.node#statechanges) | optional parameter to specify a reason of changes |


#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[updateState](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#updatestate)

#### updateTimeStamp

▸ `Protected` **updateTimeStamp**(): [`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

Update time stamp to indicate that Node or Children has been changed.

#### Returns

[`Correlation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.multiwell.correlation.correlation.correlation)

this

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[updateTimeStamp](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#updatetimestamp)

#### enableSceneGraphNotification

▸ `Static` **enableSceneGraphNotification**(`enabled`): `void`

Enable / disable all notifications

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `enabled` | `boolean` | sets if this object sends notifications |


#### Returns

`void`

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[enableSceneGraphNotification](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#enablescenegraphnotification)

#### findParent

▸ `Static` **findParent**<`T`&gt;(`node`, `classType`, `filter?`): `InstanceType`<`T`&gt;

Find root of the node with specified type

#### Type parameters

| Name | Type |
|  --- | --- |
| `T` | extends [`Constructor`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.base#constructor)<`any`&gt; |


#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `node` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | node to start search |
| `classType` | `T` | type of the class to search for |
| `Optional` `filter` | (`node`: [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)) => `boolean` | additional filter to apply |


#### Returns

`InstanceType`<`T`&gt;

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[findParent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#findparent)

▸ `Static` **findParent**(`node`, `classType`, `filter?`): [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)

Find root of the node with specified type

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `node` | [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node) | node to start search |
| `classType` | `string` | interface name to search for |
| `Optional` `filter` | (`node`: [`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)) => `boolean` | additional filter to apply |


#### Returns

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

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[findParent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#findparent)

#### getClassName

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

#### Returns

`string`

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#getclassname-1)

#### isSceneGraphNotificationEnabled

▸ `Static` **isSceneGraphNotificationEnabled**(): `boolean`

Return status of the global notification for all nodes.

#### Returns

`boolean`

#### Inherited from

[Node](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node).[isSceneGraphNotificationEnabled](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node#isscenegraphnotificationenabled)