Class: MultiWellWidget

• new MultiWellWidget(options)

• new MultiWellWidget(options?)

Creates MultiWellWidget

BaseWidget.constructor

▸ addAnnotation(name, item): MultiWellWidget

Add annotation to annotation container

MultiWellWidget

▸ addBaseLayer(baseLayer): MultiWellWidget

Add baseLayer to container

MultiWellWidget

this

BaseWidget.addBaseLayer

▸ addChild(node): MultiWellWidget

Add a child node

MultiWellWidget

this

BaseWidget.addChild

▸ addCssClass(cssclass): MultiWellWidget

Adds new css class to node

MultiWellWidget

this

BaseWidget.addCssClass

▸ addInvalidateHandler(handler): MultiWellWidget

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

MultiWellWidget

this

BaseWidget.addInvalidateHandler

▸ addOverlay(overlay): MultiWellWidget

Add overlay to container

MultiWellWidget

this

BaseWidget.addOverlay

▸ addTrack(track, options?): CorrelationTrack

Add track, well to the container.

By default well track track has size specified in the range options and depth range specified in the options welllog

Example

// The code below shows how to create a well track with position from 0 to 300 in the model coordinates and depth range from 500 to 1000
import {TrackType} from '@int/geotoolkit/welllog/multiwell/TrackType';
import {Range} from '@int/geotoolkit/util/Range';
const well = widget.addTrack(TrackType.WellTrack, {
'width': 400,
'range': new Range(0, 300),
'welllog': {
'range': new Range(500, 1000)
}
});

Example

// The code below shows how to create a well track to provide the first parameter
import {TrackType} from '@int/geotoolkit/welllog/multiwell/TrackType';
import {Range} from '@int/geotoolkit/util/Range';
const well = widget.addTrack({
'type': TrackType.WellTrack
'width': 400,
'range': new Range(0, 300),
'welllog': {
'range': new Range(500, 1000)
}
});

CorrelationTrack

▸ addTrack(track, options?): WellTrack

WellTrack

▸ addTrack(track, options?): ProxyWellTrack

ProxyWellTrack

▸ addTrack(track): ITrack

ITrack

▸ addTrack(track, options?): ITrack

ITrack

▸ addTrack(track, options?): ITrack[]

ITrack[]

▸ adjustEqualDistance(width): MultiWellWidget

Set all correlation tracks of equal width

MultiWellWidget

this

▸ adjustPosition(area?, vAlign?, hAlign?): MultiWellWidget

Adjust position of node to specified area

MultiWellWidget

this

BaseWidget.adjustPosition

▸ adjustProportionalDistance(scale): MultiWellWidget

Set correlation track widths proportional to well distanse

MultiWellWidget

this

▸ alignToDepth(depth, alignment?, containment?): MultiWellWidget

Distributes the same alignment to all tracks with regard to the top, the bottom or center of wells.

MultiWellWidget

this

▸ alignToMarker(name, alignment?): MultiWellWidget

Distributes the same alignment to all tracks with regard to the top, the bottom or center of wells by marker name. If track doesnt' have specified marker then it will be scrolled to top.

MultiWellWidget

this

▸ alignToMarkers(names?): MultiWellWidget

Level the tops to adjust or "flat" them so that they lie level across all the well tracks. This may involve stretching or squeezing the spaces between the tops to level them.

MultiWellWidget

this

▸ alignTracks(offset?, alignment?): MultiWellWidget

Align tracks by the top position

MultiWellWidget

this

▸ Protected applyOpacity(context): MultiWellWidget

This method is called to apply opacity if it is specified on the rendering context. The default implementation sets global alpha on the rendering context

MultiWellWidget

this

BaseWidget.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

BaseWidget.applyResponsiveStyle

▸ beginExport(): MultiWellWidget

Used to prepare object before exporting

MultiWellWidget

this

IExportable.beginExport

▸ changeBaseLayerOrder(overlay, order, anchor?): MultiWellWidget

Changes the z-order of the baseLayer.

MultiWellWidget

this

BaseWidget.changeBaseLayerOrder

▸ changeChildOrder(node, order, anchor?): MultiWellWidget

changes the z-order of the nodes being rendered.

MultiWellWidget

this

BaseWidget.changeChildOrder

▸ changeOverlayOrder(overlay, order, anchor?): MultiWellWidget

Changes the z-order of the overlay.

MultiWellWidget

this

BaseWidget.changeOverlayOrder

▸ changeTrackOrder(track, order, anchor?): MultiWellWidget

changes the layout order of the tracks being rendered.

MultiWellWidget

this

▸ checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

boolean

true if node is collided

BaseWidget.checkCollision

▸ clearBaseLayers(disposeBaseLayers?): MultiWellWidget

Remove all child baseLayers from group

MultiWellWidget

this

BaseWidget.clearBaseLayers

▸ clearCache(): MultiWellWidget

Clear cache

MultiWellWidget

this

BaseWidget.clearCache

▸ clearChildren(disposeChildren?): MultiWellWidget

Remove all child nodes from this composite group

MultiWellWidget

this

BaseWidget.clearChildren

▸ clearOverlays(disposeOverlays?): MultiWellWidget

Remove all child overlays from group

MultiWellWidget

this

BaseWidget.clearOverlays

▸ clearTracks(disposeTracks?): MultiWellWidget

Remove all tracks from this widget

MultiWellWidget

this

▸ clone(): Group<Node>

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

Group<Node>

clone

BaseWidget.clone

▸ connect(object, orientation?): MultiWellWidget

Synchronizes axis or group with a track container model

MultiWellWidget

▸ connectStyle(style, type, callback): MultiWellWidget

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

MultiWellWidget

this

BaseWidget.connectStyle

▸ connectTool(tool): MultiWellWidget

Connect a new tool with a toolname to the widget

MultiWellWidget

this

BaseWidget.connectTool

▸ convertModelDepthToTrackDepth(track, depth): number

Convert track container vertical space to track depth

number

▸ convertTrackDepthToModelDepth(track, depth): number

Convert track depth to container vertical model space

number

▸ Protected copyConstructor(src, deepCopy?): MultiWellWidget

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

MultiWellWidget

this

BaseWidget.copyConstructor

▸ createTrack(track, options?): CorrelationTrack

A factory method to create an instance of the track

See

WellLogWidget for all available options for wellllog properties of the well track

Example

title supports templates with HTML
import {TrackType} from '@int/geotoolkit/welllog/TrackType';
_multiWellWidget.createTrack(TrackType.WellTrack, {
'title': '<b>Well ' + (_wellIndex++) + '</b><p>1 ${deviceUnit} : ${scaleValue} ${scaleUnit}</p>'
});
Supported keywords:
${name} - track name
${deviceUnit} - device unit symbol
${scaleValue} - scale value
${scaleUnit} - scale unit symbol

CorrelationTrack

▸ createTrack(track, options?): WellTrack

WellTrack

▸ createTrack(track, options?): ProxyWellTrack

ProxyWellTrack

▸ createTrack(type, options?): ITrack

ITrack

▸ disconnectStyle(style, type, callback): MultiWellWidget

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

MultiWellWidget

this

BaseWidget.disconnectStyle

▸ disconnectTool(tool): MultiWellWidget

Disconnect the tool from the widget

MultiWellWidget

this

BaseWidget.disconnectTool

▸ dispose(): void

Dispose node. Clear all listeners and disconnect style to avoid memory leaks

void

BaseWidget.dispose

▸ Protected drawBorder(localContext, bounds?): MultiWellWidget

Draws a rectangle at the bounding box (in parent coordinates)

MultiWellWidget

this

BaseWidget.drawBorder

▸ enableClipping(doClip): MultiWellWidget

Enables or disables clipping of this node. If enabled, shapes will not be rendered outside of its bounds.

MultiWellWidget

this

BaseWidget.enableClipping

▸ enableEventPropagation(enable): MultiWellWidget

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();

MultiWellWidget

this

BaseWidget.enableEventPropagation

▸ enablePickingChildren(enable): MultiWellWidget

Enables or disables picking children

MultiWellWidget

this

BaseWidget.enablePickingChildren

▸ endExport(): MultiWellWidget

Used to restore object's state after exporting

MultiWellWidget

this

IExportable.endExport

▸ enumerateNodes(callback, target?): void

Executes a provided function once for each child node

void

BaseWidget.enumerateNodes

▸ execute(delegate): MultiWellWidget

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

MultiWellWidget

The result if any or this

BaseWidget.execute

▸ execute<T>(delegate): T

T

BaseWidget.execute

▸ exportToPdf(options?): Promise<IWritable>

Exports the widget content as a PDF file, user has option to select the scale of track in pdf.

Promise<IWritable>

promise with output stream

▸ Protected filter(context): boolean

Filter node

boolean

flag filter flag ("true" to render node; "false" otherwise)

BaseWidget.filter

▸ fitToHeight(): MultiWellWidget

Fit the whole tracks height in the visible area

MultiWellWidget

this

▸ fitToWidth(tracksWidth?): MultiWellWidget

Resize widget width to fit it in visible area

MultiWellWidget

this

▸ forEachVisual(callback): void

Enumeratisual in track container

void

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

BaseWidget.getAnimationStyle

▸ getAnnotation(location): Group<Node>

Gets annotation at specified location

Group<Node>

▸ getAutoModelLimitsMode(): boolean

Get Model Limits Logics to use when no Model Limits have been set set to true: will use parents width and height, starting at 0 set to false: will use parents bounds

boolean

mode

BaseWidget.getAutoModelLimitsMode

▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy

Get Model Limits Logics Strategy

ModelLimitsStrategy

strategy

BaseWidget.getAutoModelLimitsStrategy

▸ getBaseLayer(index): Node

Return baseLayer at specified index

Node

track

BaseWidget.getBaseLayer

▸ getBaseLayers<S>(predicate, modify?): Iterator<Node>

Return iterator by baseLayers nodes

Iterator<Node>

BaseWidget.getBaseLayers

▸ getBaseLayers(filter?, modify?): Iterator<Node>

Returns an iterator for child baseLayers. The iterator does not support adding or deleting items from overlays by default. If it is necessary to modify a collection of overlays, pass true as the last parameter.

Example

// Gets a writable iterator
const it = node.getOverlays(null, true);

Iterator<Node>

An iterator for child overlays.

BaseWidget.getBaseLayers

▸ getBaseLayersCount(): number

Returns amount of baseLayers

number

BaseWidget.getBaseLayersCount

▸ getBounds(): Rect

Get the bounds in the parents model space. If bounds are not set, then parent model limits are used.

Rect

current bounds

BaseWidget.getBounds

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache

BaseWidget.getCache

▸ getCenterDepthLimits(): Range

Returns depth range of the center container.

Range

▸ getCenterModelLimits(): Rect

Return center model limits

Rect

model limits of the tracks

▸ getCenterVisibleDepthLimits(): Range

Return a depth range, which is visible now of the center container

Range

▸ getCenterVisibleModelLimits(): Rect

Returns visible center model limits

Rect

visible center model limits

▸ getChild(i): Node

Return node by index

Node

BaseWidget.getChild

▸ getChildren<S>(predicate, modify?): Iterator<S>

Return iterator by child nodes

Iterator<S>

BaseWidget.getChildren

▸ getChildren(filter?, modify?): Iterator<Node>

Returns an iterator for child nodes. The iterator does not support adding or deleting items from children by default. If it is necessary to modify a collection of children, pass true as the last parameter.

Example

// Gets a writable iterator
const it = node.getChildren(null, true);

Iterator<Node>

An iterator for child nodes.

BaseWidget.getChildren

▸ getChildrenCount(): number

Return number of child nodes

number

BaseWidget.getChildrenCount

▸ getClassName(): string

string

IExportable.getClassName

BaseWidget.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

BaseWidget.getClipStyle

▸ getContentOrientation(): Orientation

Return content orientation

Orientation

content orientation

BaseWidget.getContentOrientation

▸ getContentsArea(transformation?): Rect

Return area without paddings. Model limits are mapped to content area, where children are layout.

Rect

BaseWidget.getContentsArea

▸ getContentsTransform(): Transformation

getContentsTransform() retrieves the world transformation of the node.

Transformation

transformation from model coordinates to bounds of the group

BaseWidget.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

BaseWidget.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

BaseWidget.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

BaseWidget.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

BaseWidget.getCssTransform

▸ getData(): AbstractDataTable | DataSource

returns data source

AbstractDataTable | DataSource

BaseWidget.getData

▸ getDataBinding(): DataBinding

Return the data binding

DataBinding

▸ getDesiredHeight(): string | number

Returns desired height of the group as a layoutable object This method is a helper method to get access to getLayoutStyle()

string | number

desired height ("undefined" by default)

BaseWidget.getDesiredHeight

▸ getDesiredWidth(): string | number

Returns desired width of the group as a layoutable object. This method is a helper method to get access to getLayoutStyle()

string | number

desired width ("undefined" by default)

BaseWidget.getDesiredWidth

▸ getDeviceLimits(): Rect

Return device limits

Rect

BaseWidget.getDeviceLimits

▸ getDistanceStrategy(): AbstractDistanceStrategy

Returns strategy to compute distance between wells

AbstractDistanceStrategy

distance strategy

▸ getExportElement(options?): AbstractDocumentElement

Returns exportable element

AbstractDocumentElement

return exportable element

IExportable.getExportElement

▸ getExportLimits(): Rect

Return export model limits

Rect

▸ getExportScale(): Object

Return export scale

Object

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

BaseWidget.getFillStyle

▸ getFixedTracksWidth(): boolean

Returns mode to keep fixed width of tracks and wells for horizontal scale

boolean

▸ getFooterContainer(): HeaderContainer<Node>

Returns footer container. Note that container's bounds are not necessary match with its visible limits as it can reside in other container. To get/set device footer size, use get/set FooterHeight() method. if footer visible option is 'none' then equals to null

HeaderContainer<Node>

▸ getFooterHeight(options?): number

Returns actual footer height or model height whenever 'auto' is specified

number

▸ getHeaderContainer(): HeaderContainer<Node>

Returns header container. Note that container's bounds are not necessary match with its visible limits as it can reside in other container. To get/set device header size, use get/set HeaderHeight() method. if header visible option is 'none' then equals to null

HeaderContainer<Node>

▸ getHeaderHeight(options?): number

Returns actual header height or model height whenever 'auto' is specified

number

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

BaseWidget.getId

▸ getIndexUnit(): AbstractUnit

Gets index unit

AbstractUnit

▸ getInfiniteMode(): boolean

Return infinity mode flag

boolean

flag

BaseWidget.getInfiniteMode

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

BaseWidget.getInvalidateMethod

▸ getLayout(): Layout

Returns layout associated with the group

Layout

layout

BaseWidget.getLayout

▸ getLayoutStyle(): LayoutStyle<string | number>

return desired layout style

LayoutStyle<string | number>

BaseWidget.getLayoutStyle

▸ getLineStyle(): LineStyle

Return border style

LineStyle

BaseWidget.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

BaseWidget.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

BaseWidget.getMarginsStyle

▸ getModelDepthScale(scaleUnit?, deviceUnit?): number

Return scale of model context to device. How many scale units in one device unit in the vertical direction.

Example

// How to get the current depth scale of multiwell widget.
import {UnitFactory} from '@int/geotoolkit/util/UnitFactory';
const uf = UnitFactory.getInstance();
WellLogWidget.getModelDepthScale(uf.getUnit('cm'), uf.getUnit('cm'));

number

a index scale to device or NaN if scale is not available

▸ getModelLimits(): Rect

Gets model limits, the limits of this groups inside space

Rect

the current model limits

BaseWidget.getModelLimits

▸ getModelTrackSize(track): Rect

Return model track size and position in the model coordinates consider offset and scale.

Rect

return model position and size

▸ getName(): string

Returns the node name

string

The node name

BaseWidget.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

BaseWidget.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

BaseWidget.getOpacityBlendMode

▸ getOptions(): OptionsOut

Returns widget options It is a same as getProperties

OptionsOut

▸ getOrientation(): Orientation

Orientation

▸ getOverlay(index): Node

Return overlay at specified index

Node

track

BaseWidget.getOverlay

▸ getOverlayAt(index): Node

Return overlay at specified index

Deprecated

since 4.2 use getOverlay instead

Node

track

BaseWidget.getOverlayAt

▸ getOverlayLayer(): Layer<Node>

Returns manipulator overlay to draw shapes that should move with the model

Layer<Node>

BaseWidget.getOverlayLayer

▸ getOverlays<S>(predicate, modify?): Iterator<Node>

Return iterator by overlays nodes

Iterator<Node>

BaseWidget.getOverlays

▸ getOverlays(filter?, modify?): Iterator<Node>

Returns an iterator for child overlays. The iterator does not support adding or deleting items from overlays by default. If it is necessary to modify a collection of overlays, pass true as the last parameter.

Example

// Gets a writable iterator
const it = node.getOverlays(null, true);

Iterator<Node>

An iterator for child overlays.

BaseWidget.getOverlays