Last updated

API / geotoolkit / welllog / multiwell / IWellTrack / IWellTrack

Class: IWellTrack

multiwell.IWellTrack.IWellTrack

Define an interface for well track

Interface

Deprecated

since 4.0. Use WellTrack directly

Hierarchy

Implemented by

Table of contents

Constructors
Methods

Contents

Constructors

new IWellTrack()

new IWellTrack()

Inherited from

IBaseWellTrack.constructor

Methods

addTrack

Abstract addTrack(track): LogTrack

Add a track to the back

Parameters

Name Type Description
trackInsertTracktrack to add or options to specify adding track

Returns

LogTrack


asNode

Abstract asNode(): Node

Return track as Node instance

Returns

Node

Inherited from

IBaseWellTrack.asNode


connectTool

Abstract connectTool(tool): IWellTrack

Connect a new tool with a tool name to the widget

Parameters

Name Type Description
toolAbstractTool | AbstractTool[]tool associated with the widget

Returns

IWellTrack

this


disconnectTool

Abstract disconnectTool(tool): IWellTrack

Disconnect the tool from the widget

Parameters

Name Type Description
toolAbstractTool | AbstractTool[]tool to disconnect

Returns

IWellTrack

this


fitToWidth

Abstract fitToWidth(): IWellTrack

Resize tracks to fit width of the well

Returns

IWellTrack


getBounds

Abstract getBounds(): Rect

Return track bounds

Returns

Rect

Inherited from

IBaseWellTrack.getBounds


getData

Abstract getData(): AbstractDataTable | DataSource

Returns data source

Returns

AbstractDataTable | DataSource


getDataBinding

Abstract getDataBinding(): DataBinding

Return the data binding

Returns

DataBinding


getDepthLimits

Abstract getDepthLimits(): Range

Returns depth range

Returns

Range

Inherited from

IBaseWellTrack.getDepthLimits


getDepthScale

Abstract getDepthScale(scaleUnit?, deviceUnit?): number

Return scale to device. How many scale units in one device unit.

Example

import {UnitFactory} from '@int/geotoolkit/util/UnitFactory';
//  to get the current depth scale of well.
const uf = UnitFactory.getInstance();
well.getDepthScale(uf.getUnit("cm"), uf.getUnit("cm"));

Parameters

Name Type Description
Optional scaleUnitstring | AbstractUnitscale unit of the display. if it is not specified then it takes from track container
Optional deviceUnitstring | AbstractUnitdevice unit of the display. if it is not specified then it takes from track container

Returns

number

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


getHeader

Abstract getHeader(): WellTrackHeader

Return track header for internal use only

Returns

WellTrackHeader


getLayoutStyle

Abstract getLayoutStyle(): LayoutStyle<string | number>

Returns layout style

Returns

LayoutStyle<string | number>

Inherited from

IBaseWellTrack.getLayoutStyle


getManipulatorLayer

Abstract getManipulatorLayer(): CompositeNode<Node>

Return track manipulator layer

Returns

CompositeNode<Node>

Inherited from

IBaseWellTrack.getManipulatorLayer


getMarkerLayer

Abstract getMarkerLayer(): Layer<Node>

Return a layer to display markers

Returns

Layer<Node>


getTag

Abstract getTag(): any

Returns Tag

Returns

any

Inherited from

IBaseWellTrack.getTag


getTitle

Abstract getTitle(): string

Return title

Returns

string

well title


getTool

Abstract getTool(): CompositeTool

Returns root tool associated to this widget

Returns

CompositeTool


getToolByName

Abstract getToolByName(name): AbstractTool

Return tool by name

Parameters

Name Type Description
namestringname of the tool

Returns

AbstractTool


getTrackAt

Abstract getTrackAt(index): LogTrack

Returns LogTrack at specified index

Parameters

Name Type Description
indexnumberindex to return track at

Returns

LogTrack


getTrackIndex

Abstract getTrackIndex(track): number

Return index of track

Parameters

Name Type Description
trackLogTrackto get index

Returns

number

index of the track


getTracksCount

Abstract getTracksCount(): number

Returns amount of tracks

Returns

number

amount of tracks


getVisible

Abstract getVisible(): boolean

Return a depth range, which is visible now

Returns

boolean


getVisibleDepthLimits

Abstract getVisibleDepthLimits(): Range

Return a depth range, which is visible now

Returns

Range

Overrides

IBaseWellTrack.getVisibleDepthLimits


insertTrack

Abstract insertTrack(index, track): LogTrack

Insert track to the container at specified index

Example

import {TrackType} from '@int/geotoolkit/welllog/TrackType';
// 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
const well = widget.insertTrack(1, {
'type': TrackType.LogTrack,
'width': 400
});

Parameters

Name Type Description
indexnumberindex of the track
trackInsertTracktrack to insert or type of track or track options

Returns

LogTrack


loadTemplate

Abstract loadTemplate(template, registry?): IWellTrack

Load template

Parameters

Name Type Description
templatestringtemplate to be applied to the widget
Optional registryRegistryregistry

Returns

IWellTrack

this


removeTrack

Abstract removeTrack(track): IWellTrack

Remove the track with headers and footers

Parameters

Name Type Description
trackLogTracktrack to remove

Returns

IWellTrack

this


saveTemplate

Abstract saveTemplate(registry?): string

Save template

Parameters

Name Type Description
Optional registryRegistryregistry

Returns

string

return template as a string


setBounds

Abstract setBounds(bounds): IWellTrack

Sets bounds of the node in the parent coordinates

Parameters

Name Type Description
boundsRectbound of the node in the parent coordinates

Returns

IWellTrack


setData

Abstract setData(data): IWellTrack

Sets a new data model

Parameters

Name Type Description
dataAbstractDataTable | DataSourcelogdata

Returns

IWellTrack

this


setDataBinding

Abstract setDataBinding(binding, silent?): IWellTrack

Sets the data binding

Parameters

Name Type Description
bindingDataBindingdata binding
Optional silentbooleansilent mode to forbid

Returns

IWellTrack

this


setDepthLimits

Abstract setDepthLimits(minIndex, maxIndex): IWellTrack

Sets depth limits for all tracks

Parameters

Name Type Description
minIndexnumbermin index limit
maxIndexnumbermax index limit

Returns

IWellTrack

Abstract setDepthLimits(range): IWellTrack

Sets depth limits for all tracks

Parameters

Name Type Description
rangeRangedepth range

Returns

IWellTrack

Abstract setDepthLimits(minIndex, maxIndex?): IWellTrack

Sets the same depth or time limits for all tracks

Example

// full depth limits or scrollable limits of your widget can be set as follows:
widget.setDepthLimits(minDepth, maxDepth);

Parameters

Name Type Description
minIndexnumber | Rangemin index limit
Optional maxIndexnumbermax index limit

Returns

IWellTrack

this


setDepthScale

Abstract setDepthScale(scale, scaleUnit?, deviceUnit?): IWellTrack

Sets a depth scale factor.

Throws

Will throw an error if the current scale is NaN

Example

import {UnitFactory} from '@int/geotoolkit/util/UnitFactory';
//  To set depth scale range as a ratio, you can use units as follows
const unitFactory = UnitFactory.getInstance();
well.setDepthScale(30, unitFactory.getUnit("feet"), unitFactory.getUnit("inch")); //1 inch == 30 feet

Parameters

Name Type Description
scalenumberA number of depth units in device unit.
Optional scaleUnitAbstractUnitscale unit of the display. if it is not specified then it takes from track container
Optional deviceUnitAbstractUnitdevice unit of the display. if it is not specified then it takes from track container

Returns

IWellTrack

this


setTitle

Abstract setTitle(title): IWellTrack

Sets well title

Parameters

Name Type Description
titlestringwell title

Returns

IWellTrack

this


setVisibleDepthLimits

Abstract setVisibleDepthLimits(fromIndex, toIndex?): IWellTrack

Sets visible depth limits

Parameters

Name Type Description
fromIndexRangedepth range
Optional toIndexbooleanoption to fit to container visible limits

Returns

IWellTrack

Abstract setVisibleDepthLimits(fromIndex, toIndex, fitHeight?): IWellTrack

Sets visible depth limits

Example

// Set visible limits to fit visible area of container
well.setVisibleDepthLimits(limits, true);

Parameters

Name Type Description
fromIndexnumberstart depth
toIndexnumberend range
Optional fitHeightbooleanoption to fit to container visible limits

Returns

IWellTrack

Abstract setVisibleDepthLimits(fromIndex, toIndex?, fitHeight?): IWellTrack

Sets visible depth limits By default it tries to fit depth based on the current visible limits of the well. If container limits should be used then specify the last parameter to true

Example

// Set visible limits to fit visible area of container
well.setVisibleDepthLimits(limits, true);

Parameters

Name Type Description
fromIndexnumber | Rangestart depth or depth range
Optional toIndexnumber | booleanend range or option to fit to container visible limits
Optional fitHeightbooleanoption to fit to container visible limits

Returns

IWellTrack