API / geotoolkit / welllog / multiwell / IWellTrack / IWellTrack
multiwell.IWellTrack.IWellTrack
Define an interface for well track
Interface
Deprecated
since 4.0. Use WellTrack directly
↳
IWellTrack
Constructors
Methods
Methods
▸ Abstract addTrack(track): LogTrack
Add a track to the back
| Name | Type | Description |
|---|---|---|
track | InsertTrack | track to add or options to specify adding track |
▸ Abstract asNode(): Node
Return track as Node instance
▸ Abstract connectTool(tool): IWellTrack
Connect a new tool with a tool name to the widget
| Name | Type | Description |
|---|---|---|
tool | AbstractTool | AbstractTool[] | tool associated with the widget |
this
▸ Abstract disconnectTool(tool): IWellTrack
Disconnect the tool from the widget
| Name | Type | Description |
|---|---|---|
tool | AbstractTool | AbstractTool[] | tool to disconnect |
this
▸ Abstract fitToWidth(): IWellTrack
Resize tracks to fit width of the well
▸ Abstract getBounds(): Rect
Return track bounds
▸ Abstract getData(): AbstractDataTable | DataSource
Returns data source
AbstractDataTable | DataSource
▸ Abstract getDataBinding(): DataBinding
Return the data binding
▸ Abstract getDepthLimits(): Range
Returns depth range
▸ 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"));| Name | Type | Description |
|---|---|---|
Optional scaleUnit | string | AbstractUnit | scale unit of the display. if it is not specified then it takes from track container |
Optional deviceUnit | string | AbstractUnit | device unit of the display. if it is not specified then it takes from track container |
number
a index scale to device or NaN if scale if not available
▸ Abstract getHeader(): WellTrackHeader
Return track header for internal use only
▸ Abstract getLayoutStyle(): LayoutStyle<string | number>
Returns layout style
LayoutStyle<string | number>
▸ Abstract getManipulatorLayer(): CompositeNode<Node>
Return track manipulator layer
IBaseWellTrack.getManipulatorLayer
▸ Abstract getMarkerLayer(): Layer<Node>
Return a layer to display markers
▸ Abstract getTag(): any
Returns Tag
any
▸ Abstract getTitle(): string
Return title
string
well title
▸ Abstract getTool(): CompositeTool
Returns root tool associated to this widget
▸ Abstract getToolByName(name): AbstractTool
Return tool by name
| Name | Type | Description |
|---|---|---|
name | string | name of the tool |
▸ Abstract getTrackAt(index): LogTrack
Returns LogTrack at specified index
| Name | Type | Description |
|---|---|---|
index | number | index to return track at |
▸ Abstract getTrackIndex(track): number
Return index of track
| Name | Type | Description |
|---|---|---|
track | LogTrack | to get index |
number
index of the track
▸ Abstract getTracksCount(): number
Returns amount of tracks
number
amount of tracks
▸ Abstract getVisible(): boolean
Return a depth range, which is visible now
boolean
▸ Abstract getVisibleDepthLimits(): Range
Return a depth range, which is visible now
IBaseWellTrack.getVisibleDepthLimits
▸ 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
});| Name | Type | Description |
|---|---|---|
index | number | index of the track |
track | InsertTrack | track to insert or type of track or track options |
▸ Abstract loadTemplate(template, registry?): IWellTrack
Load template
| Name | Type | Description |
|---|---|---|
template | string | template to be applied to the widget |
Optional registry | Registry | registry |
this
▸ Abstract removeTrack(track): IWellTrack
Remove the track with headers and footers
| Name | Type | Description |
|---|---|---|
track | LogTrack | track to remove |
this
▸ Abstract saveTemplate(registry?): string
Save template
| Name | Type | Description |
|---|---|---|
Optional registry | Registry | registry |
string
return template as a string
▸ Abstract setBounds(bounds): IWellTrack
Sets bounds of the node in the parent coordinates
| Name | Type | Description |
|---|---|---|
bounds | Rect | bound of the node in the parent coordinates |
▸ Abstract setData(data): IWellTrack
Sets a new data model
| Name | Type | Description |
|---|---|---|
data | AbstractDataTable | DataSource | logdata |
this
▸ Abstract setDataBinding(binding, silent?): IWellTrack
Sets the data binding
| Name | Type | Description |
|---|---|---|
binding | DataBinding | data binding |
Optional silent | boolean | silent mode to forbid |
this
▸ Abstract setDepthLimits(minIndex, maxIndex): IWellTrack
Sets depth limits for all tracks
| Name | Type | Description |
|---|---|---|
minIndex | number | min index limit |
maxIndex | number | max index limit |
▸ Abstract setDepthLimits(range): IWellTrack
Sets depth limits for all tracks
| Name | Type | Description |
|---|---|---|
range | Range | depth range |
▸ 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);| Name | Type | Description |
|---|---|---|
minIndex | number | Range | min index limit |
Optional maxIndex | number | max index limit |
this
▸ 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| Name | Type | Description |
|---|---|---|
scale | number | A number of depth units in device unit. |
Optional scaleUnit | AbstractUnit | scale unit of the display. if it is not specified then it takes from track container |
Optional deviceUnit | AbstractUnit | device unit of the display. if it is not specified then it takes from track container |
this
▸ Abstract setTitle(title): IWellTrack
Sets well title
| Name | Type | Description |
|---|---|---|
title | string | well title |
this
▸ Abstract setVisibleDepthLimits(fromIndex, toIndex?): IWellTrack
Sets visible depth limits
| Name | Type | Description |
|---|---|---|
fromIndex | Range | depth range |
Optional toIndex | boolean | option to fit to container visible limits |
▸ Abstract setVisibleDepthLimits(fromIndex, toIndex, fitHeight?): IWellTrack
Sets visible depth limits
Example
// Set visible limits to fit visible area of container
well.setVisibleDepthLimits(limits, true);| Name | Type | Description |
|---|---|---|
fromIndex | number | start depth |
toIndex | number | end range |
Optional fitHeight | boolean | option to fit to container visible limits |
▸ 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);| Name | Type | Description |
|---|---|---|
fromIndex | number | Range | start depth or depth range |
Optional toIndex | number | boolean | end range or option to fit to container visible limits |
Optional fitHeight | boolean | option to fit to container visible limits |