Class: TopCorrelation

• new TopCorrelation(options)

• new TopCorrelation(options?)

CompositeCorrelation.constructor

▸ addCssClass(cssclass): TopCorrelation

Adds new css class to node

TopCorrelation

this

CompositeCorrelation.addCssClass

▸ addInvalidateHandler(handler): TopCorrelation

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

TopCorrelation

this

CompositeCorrelation.addInvalidateHandler

▸ checkCollision(context): boolean

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

boolean

true if object is inside of renderable area

CompositeCorrelation.checkCollision

▸ clone(): Node

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

Node

clone

CompositeCorrelation.clone

▸ connectStyle(style, type, callback): TopCorrelation

Connects style.

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

TopCorrelation

this

CompositeCorrelation.connectStyle

▸ Protected copyConstructor(src, deepCopy?): TopCorrelation

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

TopCorrelation

this

CompositeCorrelation.copyConstructor

▸ disconnectStyle(style, type, callback): TopCorrelation

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

TopCorrelation

this

CompositeCorrelation.disconnectStyle

▸ dispose(): void

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

void

CompositeCorrelation.dispose

▸ enableEventPropagation(enable): TopCorrelation

Enable event propagation from the node hierarchy from bottom to top

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.

Example

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) => {
// Got notifications from all children of parent group
});
childGroup.invalidate();

TopCorrelation

this

CompositeCorrelation.enableEventPropagation

▸ execute(delegate): TopCorrelation

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

Example

// 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");
});

TopCorrelation

The result if any or this

CompositeCorrelation.execute

▸ execute<T>(delegate): T

T

CompositeCorrelation.execute

▸ getClassName(): string

string

CompositeCorrelation.getClassName

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

CompositeCorrelation.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

CompositeCorrelation.getCssClasses

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

CompositeCorrelation.getId

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

CompositeCorrelation.getInvalidateMethod

▸ getLeftWell(): ITrack

Return left well

ITrack

CompositeCorrelation.getLeftWell

▸ getLineDecoration(): ILineDecoration

Return Correlation Marker Line Decoration Style

ILineDecoration

▸ getLineStyle(): LineStyle

Returns line style of correlation.

LineStyle

CompositeCorrelation.getLineStyle

▸ getName(): string

Returns the node name

string

The node name

CompositeCorrelation.getName

▸ getNames(visual): Record<string, string>

Get correlation names

Record<string, string>

CompositeCorrelation.getNames

▸ getParent(): Node

Return parent node

Node

parent node

CompositeCorrelation.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties object

CompositeCorrelation.getProperties

▸ getProperty(name): any

Gets dynamic property by name. These properties can be used as a property bags

any

CompositeCorrelation.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

CompositeCorrelation.getPropertyKeys

▸ getRightWell(): ITrack

Return right well

ITrack

CompositeCorrelation.getRightWell

▸ getRoot(): Node

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

Node

the root node

CompositeCorrelation.getRoot

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

CompositeCorrelation.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

CompositeCorrelation.getTag

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

CompositeCorrelation.getVisible

▸ getWorldTransform(): Transformation

getWorldTransform retrieves the local transformation of the inner node coordinates to parent coordinates.

Transformation

the world transform.

CompositeCorrelation.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

CompositeCorrelation.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

CompositeCorrelation.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

CompositeCorrelation.hasEventListener

▸ invalidate(bounds?, force?): TopCorrelation

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

TopCorrelation

this

CompositeCorrelation.invalidate

▸ Protected invalidateParent(bounds?, force?): TopCorrelation

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

Fires

Events.Invalidate

TopCorrelation

this

CompositeCorrelation.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

CompositeCorrelation.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

CompositeCorrelation.isEventPropagationEnabled

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

CompositeCorrelation.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

CompositeCorrelation.isSelectable

▸ isSilent(): boolean

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

boolean

CompositeCorrelation.isSilent

▸ notify<E>(event, source, args?): TopCorrelation

Notify listeners of the Node

TopCorrelation

this

CompositeCorrelation.notify

▸ off<E>(type?, callback?): TopCorrelation

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.

TopCorrelation

this

CompositeCorrelation.off

▸ on<E>(type, callback): TopCorrelation

Attach listener on event that will be called whenever the specified event is delivered to the target

If the callback function is already in the list of event listeners for this target, the function is not added a second time.

If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.

TopCorrelation

this

CompositeCorrelation.on

▸ Protected onParentChanged(node): TopCorrelation

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

TopCorrelation

this

CompositeCorrelation.onParentChanged

▸ Protected onVisibilityChanged(): void

This method is called if visibility is changed. Send event Events.VisibilityChanged

void

CompositeCorrelation.onVisibilityChanged

▸ rebuildCorrelation(): void

Rebuild correlation

void

CompositeCorrelation.rebuildCorrelation

▸ removeCssClass(cssclass): TopCorrelation

Removes css class from node

TopCorrelation

this

CompositeCorrelation.removeCssClass

▸ removeInvalidateHandler(handler): TopCorrelation

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

TopCorrelation

this

CompositeCorrelation.removeInvalidateHandler

▸ render(context): void

Renders node

void

CompositeCorrelation.render

▸ renderAsync(context, callback): void

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

void

CompositeCorrelation.renderAsync

▸ renderContent(localContext, leftTrack, rightTrack, correlationDesc): void

Render correlation

void

CompositeCorrelation.renderContent

▸ setCssClass(name): TopCorrelation

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

TopCorrelation

this

CompositeCorrelation.setCssClass

▸ setId(id): TopCorrelation

Allows the user to associate any identifier

TopCorrelation

this

CompositeCorrelation.setId

▸ setLineDecoration(lineDecoration): TopCorrelation

Specify Correlation Marker Line Decoration style

TopCorrelation

this

▸ setLineStyle(lineStyle, merge?): TopCorrelation

Sets correlation marker style

TopCorrelation

this

CompositeCorrelation.setLineStyle

▸ setName(name): TopCorrelation

Sets name of the node

TopCorrelation

this

CompositeCorrelation.setName

▸ setNotification(notify, force?): TopCorrelation

set notification state

TopCorrelation

this

CompositeCorrelation.setNotification

▸ setProperties(properties?): TopCorrelation

Sets all the properties pertaining to this object

TopCorrelation

CompositeCorrelation.setProperties

▸ setProperty(name, value): TopCorrelation

Sets dynamic property by name

TopCorrelation

this

CompositeCorrelation.setProperty

▸ setSelectable(selectable): TopCorrelation

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

TopCorrelation

this

CompositeCorrelation.setSelectable

▸ setSilent(bool): TopCorrelation

Set silent mode

TopCorrelation

this

CompositeCorrelation.setSilent

▸ setTag(tag): TopCorrelation

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

TopCorrelation

this

CompositeCorrelation.setTag

▸ setVisible(value): TopCorrelation

Sets visibility of the node. Send event Events.VisibilityChanged

TopCorrelation

this

CompositeCorrelation.setVisible

▸ setWells(leftWell, rightWell): TopCorrelation

Sets left and right well

TopCorrelation

this

CompositeCorrelation.setWells

▸ setZIndex(value): TopCorrelation

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

TopCorrelation

this

CompositeCorrelation.setZIndex

▸ toString(): string

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

string

A string representation

CompositeCorrelation.toString

▸ transformDepth(track, depth): number

Transform depth

number

CompositeCorrelation.transformDepth

▸ updateSceneTransformation(): TopCorrelation

Update scene transformation

TopCorrelation

this

CompositeCorrelation.updateSceneTransformation

▸ updateState(regions?, changes?): TopCorrelation

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

TopCorrelation

this

CompositeCorrelation.updateState

▸ Protected updateTimeStamp(): TopCorrelation

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

TopCorrelation

this

CompositeCorrelation.updateTimeStamp

▸ Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

void

CompositeCorrelation.enableSceneGraphNotification

▸ Static findParent<T>(node, classType, filter?): InstanceType<T>

Find root of the node with specified type

InstanceType<T>

CompositeCorrelation.findParent

▸ Static findParent(node, classType, filter?): Node

Find root of the node with specified type

Node

CompositeCorrelation.findParent

▸ Static getClassName(): string

string

CompositeCorrelation.getClassName

▸ Static isSceneGraphNotificationEnabled(): boolean

Return status of the global notification for all nodes.

boolean

CompositeCorrelation.isSceneGraphNotificationEnabled