API / geotoolkit / welllog / multiwell / WellTrack / WellTrack
The WellTrack class is an implementation of an abstract well track, designed to represent and manage well track data in the context of MultiWellWidget for creating correlation or cross-section displays. It encapsulates WellLogWidget functionality and represents a track container with its own depth limits and depth scale.
See
↳
WellTrack
Constructors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
automodellimitsmode | boolean | Auto model limits mode |
border | Options | Border |
border-cssclass | string | The css class name of this node |
border-id | string | number | Id of the node, its a unique identifier |
border-name | string | Name of the node. It is often used for debugging purposes or to simplify queries |
border-selectable | boolean | Selectable node, a boolean to determine if selection should consider this node |
border-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 |
border-visible | boolean | Visibility of the node, a boolean to determine if the node should be rendered or not |
border-z-index | number | Define node z-index |
border | Options | Border |
border-clipstyle | ClipStyle | Clipping style |
border-clipstyle-evenodd | boolean | True if evenodd mode is on ('nonzero' mode otherwise) |
border-clipstyle-geometry | GraphicsPath | Clipping geometry |
border-clipstyle-geometry-bounds | Rect | Bounds |
border-clipstyle-geometry-bounds-height | number | Height |
border-clipstyle-geometry-bounds-readonly | boolean | Readonly |
border-clipstyle-geometry-bounds-width | number | Width |
border-clipstyle-geometry-bounds-x | number | Left |
border-clipstyle-geometry-bounds-y | number | Top |
border-clipstyle | GraphicsPath | Clipping style |
border-csscursor | string | CSS cursor associated with node |
border-cssstyle | string | CSS style to be applied to inserted elements |
border-localtransform | Transformation | Local transformation |
border-localtransform-dx | number | X axis translation |
border-localtransform-dy | number | Y axis translation |
border-localtransform-xx | number | X scale |
border-localtransform-xy | number | Xy skew |
border-localtransform-yx | number | Yx skew |
border-localtransform-yy | number | Y scale |
border-margins | number | string | It has properties for specifying the margins for each side |
border-opacity | number | Node opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context |
border-opacityblendmode | BlendMode | Node opacity mode to blend it |
border-scalescrollstrategy | ScaleScrollStrategy | Scale scroll strategy |
border-scalescrollstrategy-enabled | boolean | Enable flag |
border-transform | string | Additional CSS transformation applied to node or 'none' |
border-transform | Transformation | Additional CSS transformation applied to node or 'none' |
border | Options | Border |
border-fillstyle | string | Style applied on fill |
border-fillstyle | FillStyle | Style applied on fill |
border-fillstyle-color | string | Color in CSS form |
border-fillstyle-evenoddmode | boolean | Even-odd fill mode |
border-fillstyle-fillpattern | Pattern | Pattern |
border-fillstyle-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 |
border-fillstyle-fillpattern-patternname | string | Name of this pattern for indexing |
border-fillstyle-fillpattern-scalable | boolean | Flag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported) |
border-fillstyle-foreground | string | Foreground color |
border-fillstyle-pattern | Pattern | Pattern |
border-linestyle | string | Style applied on outline |
border-linestyle | LineStyle | Style applied on outline |
border-linestyle-color | string | Color in CSS form |
border-linestyle-fill | string | Optional fill style to be used to fill lines generated with this style |
border-linestyle-fill | FillStyle | Optional fill style to be used to fill lines generated with this style |
border-linestyle-linecap | CapStyle | The line cap style |
border-linestyle-linedashoffset | number | Line dash offset of dashed line |
border-linestyle-linejoin | JoinStyle | The line join style |
border-linestyle-pixelsnapmode | boolean | Pixel Snap Mode, default( |
border-linestyle-scalable | boolean | True if width should depend on transformation |
border-linestyle-unit | string | Optional unit for the width |
border-linestyle-width | number | string | The line thickness |
border | Options | Border |
border-borders | Visible | Style applied on borders, by default is |
border-borders-bottom | boolean | Visibility of bottom part |
border-borders-left | boolean | Visibility of left part |
border-borders-right | boolean | Visibility of right part |
border-borders-top | boolean | Visibility of top part |
border-borderstyle | BorderStyle | Style applied on borders |
border-linestyles | Styles | Object with line styles |
border-linestyles-bottom | string | Bottom border style |
border-linestyles-bottom | LineStyle | Bottom border style |
border-linestyles-left | string | Left border style |
border-linestyles-left | LineStyle | Left border style |
border-linestyles-right | string | Right border style |
border-linestyles-right | LineStyle | Right border style |
border-linestyles-top | string | Top border style |
border-linestyles-top | LineStyle | Top border style |
borderstrategy | BorderStrategy | Border rendering strategy |
bounds | Rect | Define position of the group in the parent |
clipping | boolean | Enable clipping, this does not consider the clipstyle, it is related to bounds-clipping |
clipstyle | ClipStyle | Clipping style |
clipstyle | GraphicsPath | Clipping style |
contentorientation | Orientation | Content orientation |
cssclass | string | The css class name of this node |
csscursor | string | CSS cursor associated with node |
cssstyle | string | CSS style to be applied to inserted elements |
fillstyle | string | Fill style |
fillstyle | FillStyle | Fill style |
horizontalflip | boolean | Horizontal axis goes from right to left |
id | string | number | Id of the node, its a unique identifier |
id | string | number | Well id |
infinity | boolean | Mode to render outside the model limits |
layoutstyle | LayoutStyle | Layout style to be used for parent layout |
layoutstyle-constraint | SizeConstraint | Layout constrains |
layoutstyle-flexgrow | number | Number specifying how much the item will grow relative to the rest of the items inside the same container |
layoutstyle-flexshrink | number | Number specifying how much the item will shrink relative to the rest of the items inside the same container |
layoutstyle-float | string | Float position |
layoutstyle-position | string | Layout position |
layoutstyle-size | number | string | Layout size |
linestyle | string | Line style |
linestyle | LineStyle | Line style |
localtransform | Transformation | Local transformation |
margins | number | string | It has properties for specifying the margins for each side |
modellimits | Rect | Define inner model coordinates of the group |
name | string | Name of the node. It is often used for debugging purposes or to simplify queries |
opacity | number | Node opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context |
opacityblendmode | BlendMode | Node opacity mode to blend it |
padding | number | string | It has properties for specifying the padding for each side |
pickingchildren | boolean | Enable picking children |
range | Range | Position in container |
range-high | number | Upper range boundary |
range-low | number | Lower range boundary |
range-max | number | |
range-min | number | |
scalescrollstrategy | ScaleScrollStrategy | Scale scroll strategy |
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 |
title | string | Well track title |
transform | string | Additional CSS transformation applied to node or 'none' |
transform | Transformation | Additional CSS transformation applied to node or 'none' |
verticalflip | boolean | Vertical axis goes from bottom to top |
viewcache | boolean | View cache to cache child nodes |
visible | boolean | Visibility of the node, a boolean to determine if the node should be rendered or not |
welllog | OptionsBase | Options for well log |
welllog-indent | number | Indent between tracks |
welllog-verticalscrollable | boolean | |
welllog | Options | Options for well log |
welllog-border | BorderOptions | Defines properties for widget outer border |
welllog-border-borders | Visible | Borders visibility option |
welllog-border-color | string | Color of border |
welllog-border-linestyle | string | Border line style |
welllog-border-linestyle | LineStyle | Border line style |
welllog-border-visible | boolean | Visibility of the border |
welllog-depthlimitsoptions | DepthLimitsOptions | Depth limits options |
welllog-depthlimitsoptions-neatlimits | boolean | Auto neat depth limits |
welllog-depthlimitsoptions-type | DepthLimitsTypes | Depth limits type |
welllog-deviceunit | string | Primary device unit |
welllog-direction | TrackRenderDirection | Set track render direction |
welllog-gridlinestyle | string | Grid line style |
welllog-gridlinestyle | LineStyle | Grid line style |
welllog-horizontalscrollable | boolean | Defines if plot displays horizontal scrollbars |
welllog-indextype | IndexType | Primary index types |
welllog-indexunit | string | Primary index unit |
welllog-marker | MarkerOptions | Marker options |
welllog-marker-datetimeformat | Options | Date time format in case if track container scale unit belongs to 'time' |
welllog-marker-datetimeformat-format | string | Date time format |
welllog-marker-datetimeformat-timezone | TimeZone | Time zone |
welllog-marker-enabledinterpolatedvalues | boolean | Display symbol for interpolated values |
welllog-marker-fillstyle | string | Marker shape fill style |
welllog-marker-fillstyle | FillStyle | Marker shape fill style |
welllog-marker-indexvisible | boolean | Visibility of the marker index value label |
welllog-marker-labelvisible | boolean | Visibility of the marker shape label |
welllog-marker-linestyle | string | Marker shape line style |
welllog-marker-linestyle | LineStyle | Marker shape line style |
welllog-marker-symbol | SymbolShape | Symbol to use as depth index marker |
welllog-marker-symbol-alignment | AnchorType | Alignment according to the anchor point |
welllog-marker-symbol-alignment | AnchorType | Anchor type of symbol |
welllog-marker-symbol-ax | number | Anchor x position |
welllog-marker-symbol-ay | number | Anchor y position |
welllog-marker-symbol-cache | boolean | Set it to true if you want to cache complex geometry to raster |
welllog-marker-symbol-clipstyle | ClipStyle | Clipping style |
welllog-marker-symbol-clipstyle | GraphicsPath | Clipping style |
welllog-marker-symbol-cssclass | string | The css class name of this node |
welllog-marker-symbol-csscursor | string | CSS cursor associated with node |
welllog-marker-symbol-cssstyle | string | CSS style to be applied to inserted elements |
welllog-marker-symbol-fillstyle | string | Style applied on fill |
welllog-marker-symbol-fillstyle | FillStyle | Style applied on fill |
welllog-marker-symbol-height | number | Shape height |
welllog-marker-symbol-id | string | number | Id of the node, its a unique identifier |
welllog-marker-symbol-ispointingup | boolean | Defines whether the shape is always pointing up |
welllog-marker-symbol-layoutstyle | LayoutStyle | Layout style to specify how to lay out shape |
welllog-marker-symbol-linestyle | string | Style applied on outline |
welllog-marker-symbol-linestyle | LineStyle | Style applied on outline |
welllog-marker-symbol-localtransform | Transformation | Local transformation |
welllog-marker-symbol-margins | number | string | It has properties for specifying the margins for each side |
welllog-marker-symbol-maxdimension | Dimension | Maximum size for rendering |
welllog-marker-symbol-maxdimension-height | number | Height of dimension |
welllog-marker-symbol-maxdimension-width | number | Width of dimension or properties |
welllog-marker-symbol-mindimension | Dimension | Minimum size for rendering |
welllog-marker-symbol-name | string | Name of the node. It is often used for debugging purposes or to simplify queries |
welllog-marker-symbol-opacity | number | Node opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context |
welllog-marker-symbol-opacityblendmode | BlendMode | Node opacity mode to blend it |
welllog-marker-symbol-painter | string | A function with has parameters: symbol, box, context |
welllog-marker-symbol-painterproperties | any | Symbol's painter's properties |
welllog-marker-symbol-preserveaspectratio | boolean | Preserve aspect ratio of the anchored shape |
welllog-marker-symbol-preservereadingorientation | boolean | Preserve reading orientation for local transform |
welllog-marker-symbol-preserverightangle | boolean | Preserve right angle for local transformation |
welllog-marker-symbol-rotationangle | number | Rotation angle at anchor |
welllog-marker-symbol-scalescrollstrategy | ScaleScrollStrategy | Scale scroll strategy |
welllog-marker-symbol-selectable | boolean | Selectable node, a boolean to determine if selection should consider this node |
welllog-marker-symbol-sizeisindevicespace | boolean | Is coordinate in device space |
welllog-marker-symbol-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 |
welllog-marker-symbol-transform | string | Additional CSS transformation applied to node or 'none' |
welllog-marker-symbol-transform | Transformation | Additional CSS transformation applied to node or 'none' |
welllog-marker-symbol-useminmaxdimensions | boolean | Use the min max dimensions to limit visual size |
welllog-marker-symbol-visible | boolean | Visibility of the node, a boolean to determine if the node should be rendered or not |
welllog-marker-symbol-width | number | Shape width |
welllog-marker-symbol-z-index | number | Define node z-index |
welllog-orientation | Orientation | Set orientation of the well log widget |
welllog-range | Range | Min and max depth range |
welllog-timezone | TimeZone | Time zone for time axis |
welllog-timezoneoffset | number | Time zone offset for date time axis |
welllog-verticalscrollable | boolean | Defines if plot displays vertical scrollbars |
welllog-viewcache | boolean | Define view cache for tracks |
width | number | Well width |
z-index | number | Define node z-index |
Constructors
• new WellTrack(options?)
Creates well track
| Name | Type | Description |
|---|---|---|
Optional options | Options | additional options |
AbstractWellTrack.constructor
Methods
▸ addBaseLayer(baseLayer): WellTrack
Add baseLayer to container
this
AbstractWellTrack.addBaseLayer
▸ addChild(node): WellTrack
Add a child node
this
▸ addCssClass(cssclass): WellTrack
Adds new css class to node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
▸ addInvalidateHandler(handler): WellTrack
Add invalidate handler
Deprecated
since 4.0, use Node.on instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
AbstractWellTrack.addInvalidateHandler
▸ addOverlay(overlay): WellTrack
Add overlay to container
this
▸ addTrack(track): LogTrack
Add a track
| Name | Type | Description |
|---|---|---|
track | InsertTrack | track to add or options to specify adding track |
▸ adjustPosition(area?, vAlign?, hAlign?): WellTrack
Adjust position of node to specified area
| Name | Type | Description |
|---|---|---|
Optional area | Rect | specified area. Default to Parent Model Limits |
Optional vAlign | string | vertical alignment. It can be "top", "bottom", "center". Defaults to "top". |
Optional hAlign | string | horizontal alignment It can be "left", "right", "center". Defaults to "left". |
this
AbstractWellTrack.adjustPosition
▸ Protected applyOpacity(context): WellTrack
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
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
this
AbstractWellTrack.applyOpacity
▸ Protected applyResponsiveStyle(): void
Apply a responsive style rules it is exists
void
AbstractWellTrack.applyResponsiveStyle
▸ asNode(): Node
Return track as Node instance
▸ beginExport(): WellTrack
Prepares object before exporting and saving state
this
▸ changeBaseLayerOrder(overlay, order, anchor?): WellTrack
Changes the z-order of the baseLayer.
| Name | Type | Description |
|---|---|---|
overlay | Node | |
order | NodeOrder | position to be added |
Optional anchor | Node | anchor node to specify changeOrder with respect to this node |
this
AbstractWellTrack.changeBaseLayerOrder
▸ changeChildOrder(node, order, anchor?): WellTrack
changes the z-order of the nodes being rendered.
| Name | Type | Description |
|---|---|---|
node | Node | any child added in the Composite node |
order | NodeOrder | position to be added |
Optional anchor | Node | anchor node to specify changeOrder with respect to this node |
this
AbstractWellTrack.changeChildOrder
▸ changeOverlayOrder(overlay, order, anchor?): WellTrack
Changes the z-order of the overlay.
| Name | Type | Description |
|---|---|---|
overlay | Node | child overlay |
order | NodeOrder | position to be added |
Optional anchor | Node | anchor node to specify changeOrder with respect to this node |
this
AbstractWellTrack.changeOverlayOrder
▸ changeTrackOrder(track, order, anchor?): WellTrack
changes the layout order of the trakcs being rendered.
| Name | Type | Description |
|---|---|---|
track | LogTrack | child track in the WellTrack |
order | NodeOrder | position to be added |
Optional anchor | LogTrack | anchor track to specify changeOrder with respect to this track |
this
▸ checkCollision(context): boolean
Check culling Returns true if object is inside of renderable area
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
true if node is collided
AbstractWellTrack.checkCollision
▸ clearBaseLayers(disposeBaseLayers?): WellTrack
Remove all child baseLayers from group
| Name | Type | Description |
|---|---|---|
Optional disposeBaseLayers | boolean | automatically dispose baseLayers. If it is true then method dispose is called for each baseLayer, false by default |
this
AbstractWellTrack.clearBaseLayers
▸ clearCache(): WellTrack
Clear cache
this
▸ clearChildren(disposeChildren?): WellTrack
Remove all child nodes from this composite group
| Name | Type | Description |
|---|---|---|
Optional disposeChildren | boolean | automatically dispose children. If it is true then method dispose is called for each child. |
this
AbstractWellTrack.clearChildren
▸ clearOverlays(disposeOverlays?): WellTrack
Remove all child overlays from group
| Name | Type | Description |
|---|---|---|
Optional disposeOverlays | boolean | automatically dispose overlays. If it is true then method dispose is called for each overlay, false by default |
this
AbstractWellTrack.clearOverlays
▸ clearTracks(disposeTracks?): WellTrack
Remove all tracks from this well track
| Name | Type | Description |
|---|---|---|
Optional disposeTracks | boolean | automatically dispose tracks. If it is true then method dispose is called for each track. |
this
▸ clone(): WellTrack
All subclasses should override copyConstructor or provide custom implementation for this method
clone
▸ connectStyle(style, type, callback): WellTrack
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
| Name | Type | Description |
|---|---|---|
style | EventDispatcher | connect style |
type | string | type of event or property |
callback | AttributeCallback<EventDispatcher> | function to be called |
this
AbstractWellTrack.connectStyle
▸ connectTool(tool): WellTrack
Connect a new tool with a toolname to the widget
| Name | Type | Description |
|---|---|---|
tool | AbstractTool | AbstractTool[] | tool associated with the widget |
this
▸ Protected convertDepthToBounds(depth): number
Converts depth to position inside of the bounds
| Name | Type | Description |
|---|---|---|
depth | number | depth |
number
vertical position inside of the bounds
AbstractWellTrack.convertDepthToBounds
▸ Protected copyConstructor(src, deepCopy?): WellTrack
Copy constructor function.
Function used as part of the cloning mechanism.
Implementations should copy the given instance state to this instance.
| Name | Type | Description |
|---|---|---|
src | WellTrack | Source to copy from |
Optional deepCopy | boolean | deep copy |
this
AbstractWellTrack.copyConstructor
▸ disconnectStyle(style, type, callback): WellTrack
Disconnect style
This convenience method un-subscribes a listener to given style for the specified type.
| Name | Type | Description |
|---|---|---|
style | EventDispatcher | connect style |
type | string | type of event or property |
callback | AttributeCallback<EventDispatcher> | function to be called |
this
AbstractWellTrack.disconnectStyle
▸ disconnectTool(tool): WellTrack
Disconnect the tool from the widget
| Name | Type | Description |
|---|---|---|
tool | AbstractTool | AbstractTool[] | tool to disconnect |
this
▸ dispose(): void
Dispose node. Clear all listeners and disconnect style to avoid memory leaks
void
▸ Protected drawBorder(localContext, bounds?): WellTrack
Draws a rectangle at the bounding box (in parent coordinates)
| Name | Type | Description |
|---|---|---|
localContext | RenderingContext | The local rendering context |
Optional bounds | Rect | group bounds |
this
▸ enableClipping(doClip): WellTrack
Enables or disables clipping of this node. If enabled, shapes will not be rendered outside of its bounds.
| Name | Type | Description |
|---|---|---|
doClip | boolean | enable clipping on this node |
this
AbstractWellTrack.enableClipping
▸ enableEventPropagation(enable): WellTrack
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();| Name | Type | Description |
|---|---|---|
enable | boolean | enable |
this
AbstractWellTrack.enableEventPropagation
▸ enableNavigation(enabled): WellTrack
Enable navigation tool after track instantiation. By default it is enabled
| Name | Type | Description |
|---|---|---|
enabled | boolean | flag to enable/disable navigation |
▸ enablePickingChildren(enable): WellTrack
Enables or disables picking children
| Name | Type | Description |
|---|---|---|
enable | boolean | enable picking children |
this
AbstractWellTrack.enablePickingChildren
▸ endExport(): WellTrack
Used to restore object's state after exporting
this
▸ enumerateNodes(callback, target?): void
Executes a provided function once for each child node
| Name | Type | Description |
|---|---|---|
callback | Callback<Node> | provided function |
Optional target | QueryBuilder<any> | target to pass to callback as a second parameter |
void
AbstractWellTrack.enumerateNodes
▸ execute(delegate): WellTrack
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");
});| Name | Type | Description |
|---|---|---|
delegate | (this: WellTrack) => void | Function to execute |
The result if any or this
▸ execute<T>(delegate): T
| Name |
|---|
T |
| Name | Type |
|---|---|
delegate | (this: WellTrack) => T |
T
▸ Protected filter(context): boolean
Filter node
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
flag filter flag ("true" to render node; "false" otherwise)
▸ fitToWidth(): WellTrack
Resize tracks to fit width of the well
▸ getAnimationStyle(): AnimationStyle
Return animation style
animationStyle current animation style
AbstractWellTrack.getAnimationStyle
▸ 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
AbstractWellTrack.getAutoModelLimitsMode
▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy
Get Model Limits Logics Strategy
strategy
AbstractWellTrack.getAutoModelLimitsStrategy
▸ getBaseLayer(index): Node
Return baseLayer at specified index
| Name | Type | Description |
|---|---|---|
index | number | index at which to get the baseLayer for |
track
AbstractWellTrack.getBaseLayer
▸ getBaseLayers<S>(predicate, modify?): Iterator<Node>
Return iterator by baseLayers nodes
| Name | Type |
|---|---|
S | extends Node<S> |
| Name | Type | Description |
|---|---|---|
predicate | (value: Node) => value is S | a filter function |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
AbstractWellTrack.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);| Name | Type | Description |
|---|---|---|
Optional filter | (node: Node) => boolean | A filter function. Returns all overlays if null. |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
An iterator for child overlays.
AbstractWellTrack.getBaseLayers
▸ getBaseLayersCount(): number
Returns amount of baseLayers
number
AbstractWellTrack.getBaseLayersCount
▸ getBounds(): Rect
Get the bounds in the parents model space. If bounds are not set, then parent model limits are used.
current bounds
▸ getCache(): Cache
Return cache strategy to be used to cache children nodes
cache
▸ getChild(i): Node
Return node by index
| Name | Type | Description |
|---|---|---|
i | number | index of the node |
▸ getChildren<S>(predicate, modify?): Iterator<S>
Return iterator by child nodes
| Name | Type |
|---|---|
S | extends Node<S> |
| Name | Type | Description |
|---|---|---|
predicate | (value: Node) => value is S | a filter function |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
Iterator<S>
▸ 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);| Name | Type | Description |
|---|---|---|
Optional filter | (node: Node) => boolean | A filter function. Returns all nodes if null. |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
An iterator for child nodes.
▸ getChildrenCount(): number
Return number of child nodes
number
AbstractWellTrack.getChildrenCount
▸ getClassName(): string
string
AbstractWellTrack.getClassName
▸ getClipStyle(): ClipStyle
Gets the current clipping style
clipping style
AbstractWellTrack.getClipStyle
▸ getContentOrientation(): Orientation
Return content orientation
content orientation
AbstractWellTrack.getContentOrientation
▸ getContentsArea(transformation?): Rect
Return area without paddings. Model limits are mapped to content area, where children are layout.
| Name | Type | Description |
|---|---|---|
Optional transformation | Transformation | scene transformation |
AbstractWellTrack.getContentsArea
▸ getContentsTransform(): Transformation
getContentsTransform() retrieves the world transformation of the node.
transformation from model coordinates to bounds of the group
AbstractWellTrack.getContentsTransform
▸ getCss(): CssStyle
Return CSS style
▸ getCssClass(): string
Returns css class name to be used to apply CSS style
string
the css class name
▸ getCssClasses(): string[]
Gets list of css class names which applied to this node
string[]
AbstractWellTrack.getCssClasses
▸ getCssTransform(): string
Returns CSS transformation
string
AbstractWellTrack.getCssTransform
▸ getData(): AbstractDataTable | DataSource
Gets a data model
AbstractDataTable | DataSource
▸ getDataBinding(): DataBinding | DataBindingRegistry
Return the data binding
DataBinding | DataBindingRegistry
AbstractWellTrack.getDataBinding
▸ getDepthLimits(): Range
Retrieves the depth range associated with well track. The depth range defines the minimum and maximum depth values represented within the track
AbstractWellTrack.getDepthLimits
▸ getDepthScale(scaleUnit?, deviceUnit?): number
Return scale to device. How many scale units in one device unit.
Example
// to get the current depth scale of welllog widget.
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
AbstractWellTrack.getDepthScale
▸ 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)
AbstractWellTrack.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)
AbstractWellTrack.getDesiredWidth
▸ getDeviceLimits(): Rect
Return device limits
AbstractWellTrack.getDeviceLimits
▸ getDeviceUnit(): AbstractUnit
Gets device unit
unit
▸ getExportElement(): AbstractDocumentElement
Returns exportable element
return exportable element
▸ getFillStyle(): FillStyle
Return fill style
fillStyle current fill style
AbstractWellTrack.getFillStyle
▸ getFooter(): WellTrackHeader
Return Well Footer
▸ getFooterTitle(): LogTrackVisualHeader<WellTrack>
Returns well footer title
LogTrackVisualHeader<WellTrack>
well footer title
▸ getHeader(): WellTrackHeader
Return Well Header
▸ getHeaderTitle(): LogTrackVisualHeader<WellTrack>
Returns well header title
LogTrackVisualHeader<WellTrack>
well header title
▸ getId(): string | number
Returns the associated identifier of the node
string | number
The node's id
▸ getIndexUnit(): AbstractUnit
Gets index unit of the current well
unit
▸ getInfiniteMode(): boolean
Return infinity mode flag
boolean
flag
AbstractWellTrack.getInfiniteMode
▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>
Gets invalidate method
AttributeCallback<EventDispatcher>
method to invalidate this object
AbstractWellTrack.getInvalidateMethod
▸ getLayout(): Layout
Returns layout associated with the group
layout
▸ getLayoutStyle(): LayoutStyle<string | number>
return desired layout style
LayoutStyle<string | number>
AbstractWellTrack.getLayoutStyle
▸ getLineStyle(): LineStyle
Return border style
AbstractWellTrack.getLineStyle
▸ getLocalTransform(): Transformation
Retrieves the transformation of bounds to parent
transform the local transform.
AbstractWellTrack.getLocalTransform
▸ getManipulatorLayer(): CompositeNode<Node>
Returns manipulator layer
layer
IWellTrack.getManipulatorLayer
AbstractWellTrack.getManipulatorLayer
▸ getMarginsStyle(): SpaceStyle<string | number>
Return margins style
SpaceStyle<string | number>
AbstractWellTrack.getMarginsStyle
▸ getMarkerLayer(): Layer<Node>
Return a layer to display markers
AbstractWellTrack.getMarkerLayer
▸ getModelLimits(): Rect
Gets model limits, the limits of this groups inside space
the current model limits
AbstractWellTrack.getModelLimits
▸ getName(): string
Returns the node name
string
The node name
▸ getOpacity(): number
Returns current node opacity
number
opacity
▸ getOpacityBlendMode(): BlendMode
Returns current node opacity
opacity blend mode
AbstractWellTrack.getOpacityBlendMode
▸ getOverlay(index): Node
Return overlay at specified index
| Name | Type | Description |
|---|---|---|
index | number | index at which to get the overlay for |
track
▸ getOverlayAt(index): Node
Return overlay at specified index
Deprecated
since 4.2 use getOverlay instead
| Name | Type | Description |
|---|---|---|
index | number | index at which to get the overlay for |
track
AbstractWellTrack.getOverlayAt
▸ getOverlays<S>(predicate, modify?): Iterator<Node>
Return iterator by overlays nodes
| Name | Type |
|---|---|
S | extends Node<S> |
| Name | Type | Description |
|---|---|---|
predicate | (value: Node) => value is S | a filter function |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
▸ 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);| Name | Type | Description |
|---|---|---|
Optional filter | (node: Node) => boolean | A filter function. Returns all overlays if null. |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
An iterator for child overlays.
▸ getOverlaysCount(): number
Returns amount of overlays
number
AbstractWellTrack.getOverlaysCount
▸ getPaddingStyle(): SpaceStyle<string | number>
Return padding style
SpaceStyle<string | number>
padding
AbstractWellTrack.getPaddingStyle
▸ getParent(): Node
Return parent node
parent node
▸ getPreferredSize(): Rect
Return preferred size to layout children
AbstractWellTrack.getPreferredSize
▸ getProperties(): OptionsOut
Gets all the properties pertaining to this object
See
properties object
AbstractWellTrack.getProperties
▸ getProperty(name): any
Gets dynamic property by name. These properties can be used as a property bags
| Name | Type | Description |
|---|---|---|
name | string | property name |
any
▸ getPropertyKeys(): string[]
Returns known properties keys
string[]
AbstractWellTrack.getPropertyKeys
▸ getRenderingFilter(): IFilter
Return filter to be used for rendering and picking
current filter
AbstractWellTrack.getRenderingFilter
▸ getResponsiveStyle(): ResponsiveStyle
Return responsive style
AbstractWellTrack.getResponsiveStyle
▸ getRoot(): Node
Returns root node.
If node doesn't have parent then it returns itself.
the root node
▸ getScaleScrollStrategy(): Delegate
Gets scale scroll strategy
scale scroll strategy
AbstractWellTrack.getScaleScrollStrategy
▸ getSceneTransform(): Transformation
Returns transformation from node to root scene
a transformation from node to root scene
AbstractWellTrack.getSceneTransform
▸ getSelectedTracks(): LogTrack[]
Return selected track collection
LogTrack[]
▸ getSelectedVisuals(track?): Node[]
Return an array of the selected visuals for the specified track. if track is not specified then all selected visuals are returned. This method is a helper method and uses selected visuals from 'pick' tool. The code below shows how to get access to all selected tracks and visuals instead
| Name | Type | Description |
|---|---|---|
Optional track | LogTrack | track to return selected visuals specified by node filter |
Node[]
▸ getSelection(): Node[]
Return the currently selected items
Node[]
array of selected object
AbstractWellTrack.getSelection
▸ getTag(): any
Returns the object associated with the node by user.
any
The node's user-object
▸ getTitle(): string
Return title
string
well title
▸ getTool(): CompositeTool
Returns root tool associated to this widget
▸ getToolByName<Name>(toolName): Tools[Name]
Returns the tool matching the given name.
This function also accepts tool 'path' instead of absolute name.
For example:
getToolByName("compositeTool.panningTools.trackPanning.TrackPanning")
Would return the same tool than
getToolByName("TrackPanning")
As long as there is only one tool named "TrackPanning" in this composite
See listToolsNames()
| Name | Type |
|---|---|
Name | extends string |
| Name | Type | Description |
|---|---|---|
toolName | Name | The tool name or path |
Tools[Name]
▸ getTrack(index): LogTrack
Returns LogTrack at specified index
| Name | Type | Description |
|---|---|---|
index | number | index to return track at |
▸ getTrackAt(index): LogTrack
Returns LogTrack at specified index
Deprecated
since 4.2 use getTrack instead
| Name | Type | Description |
|---|---|---|
index | number | index to return track at |
▸ getTrackIndex(track): number
Return index of track
Deprecated
since 4.2 use indexOfTrack instead
| Name | Type | Description |
|---|---|---|
track | LogTrack | to get index |
number
index of the track
▸ getTrackOptions(track): TrackOptionsOut
Returns track options
| Name | Type | Description |
|---|---|---|
track | LogTrack | track to get options |
track options
▸ getTracks(filter?, modify?): Iterator<LogTrack>
Return iterator by child tracks
| Name | Type | Description |
|---|---|---|
Optional filter | (node: LogTrack) => boolean | a filter function. Returns all tracks if null |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
▸ getTracksCount(): number
Returns amount of tracks
number
amount of tracks
▸ getTracksSize(): number
Calculate a real size of tracks
number
total width of the tracks
▸ getVisible(): boolean
Return visibility of the node
boolean
true if node is visible
▸ getVisibleDepthLimits(): Range
Return a depth range, which is visible now
IWellTrack.getVisibleDepthLimits
AbstractWellTrack.getVisibleDepthLimits
▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect
Return visible device limits
| Name | Type | Description |
|---|---|---|
Optional ignoreModelLimits | boolean | flag defines whether to ignore ModelLimits or not |
AbstractWellTrack.getVisibleDeviceLimits
▸ getVisibleModelLimits(ignoreModelLimits?): Rect
Return visible model limits
| Name | Type | Description |
|---|---|---|
Optional ignoreModelLimits | boolean | flag defines whether to ignore ModelLimits or not |
AbstractWellTrack.getVisibleModelLimits
▸ getWidth(): number
Returns well track width
number
▸ getWorldTransform(): Transformation
Retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.
AbstractWellTrack.getWorldTransform
▸ getZIndex(): number
Returns node z-index (null if not set)
number
Return a layer to display zones
▸ hasCssClass(cssClass): boolean
Check if node has specified css class
| Name | Type | Description |
|---|---|---|
cssClass | string | css class name |
boolean
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
AbstractWellTrack.hasEventListener
▸ highlightVisual(visual, highlight): WellTrack
Highlights a visual or track. Called whenever a visual is selected to highlight it.
If user selects a curve and the track, the curve,track and header are highlighted. Programmatically deselecting a track doesn't automatically deselect curves.
Deselect all selected tracks and visuals using the example shown below.
Example
well.highlightVisual(visual, false);| Name | Type | Description |
|---|---|---|
visual | LogAbstractVisual | LogTrack | The visual to highlight |
highlight | boolean | the status of the highlight |
this
▸ indexOfBaseLayer(baseLayer): number
Return index of overlay ( index of the specified child or -1 if baseLayer is not found)
| Name | Type | Description |
|---|---|---|
baseLayer | Node | baseLayer to check index |
number
AbstractWellTrack.indexOfBaseLayer
▸ indexOfChild(node): number
Return index of child ( index of the specified child or -1 if node is not found)
| Name | Type | Description |
|---|---|---|
node | Node | node to check index |
number
AbstractWellTrack.indexOfChild
▸ indexOfOverlay(overlay): number
Return index of overlay ( index of the specified child or -1 if overlay is not found)
| Name | Type | Description |
|---|---|---|
overlay | Node | overlay to check index |
number
AbstractWellTrack.indexOfOverlay
▸ indexOfTrack(track): number
Return index of track
| Name | Type | Description |
|---|---|---|
track | LogTrack | to get index |
number
index of the track
▸ insertBaseLayer(index, baseLayer): WellTrack
Insert child baseLayer at specified index
| Name | Type | Description |
|---|---|---|
index | number | specified index |
baseLayer | Node | a baseLayer to add |
this
AbstractWellTrack.insertBaseLayer
▸ insertChild(index, node): WellTrack
Insert child node at specified index
| Name | Type | Description |
|---|---|---|
index | number | specified index |
node | Node | a child node to add |
this
▸ insertOverlay(index, overlay): WellTrack
Insert child overlay at specified index
| Name | Type | Description |
|---|---|---|
index | number | specified index |
overlay | Node | a overlay to add |
this
AbstractWellTrack.insertOverlay
▸ insertTrack(index, track): LogTrack
Insert track to the container at specified index
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
const well = widget.insertTrack(1, {
'type': LogTrack
'width': 400
});| Name | Type | Description |
|---|---|---|
index | number | index of the track |
track | InsertTrack | track to add or options to specify adding track |
▸ invalidate(bounds?, force?): WellTrack
Invalidate node
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | optional rectangular area to be invalidated, or force flag if rectangle is empty |
Optional force | boolean | optional boolean parameter that can force invalidation |
this
▸ invalidateLayout(propagate?): WellTrack
Notify that layout is invalidated. Send event Events.LayoutInvalidated
| Name | Type | Description |
|---|---|---|
Optional propagate | boolean | propagate invalidate layout to parent |
this
AbstractWellTrack.invalidateLayout
▸ invalidateParent(bounds?, force?): WellTrack
Invalidate parent area
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | area to invalidate |
Optional force | boolean | force |
this
AbstractWellTrack.invalidateParent
▸ isClippingEnabled(): boolean
Returns if clipping is enabled or not for this node.
boolean
AbstractWellTrack.isClippingEnabled
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isEventPropagationEnabled(): boolean
Return true if event propagation is enabled from child to parent
boolean
AbstractWellTrack.isEventPropagationEnabled
▸ isHorizontalFlip(): boolean
Return true if the representation is flipped horizontally
boolean
flip
AbstractWellTrack.isHorizontalFlip
▸ isLayoutInvalidated(): boolean
Return true if layout is invalid
boolean
AbstractWellTrack.isLayoutInvalidated
▸ isNavigationEnabled(): boolean
Return status of navigation tool after track instantiation
boolean
▸ isNotificationEnabled(): boolean
return state of notification
boolean
current notification state
AbstractWellTrack.isNotificationEnabled
▸ isPickingChildrenEnabled(): boolean
Returns if picking children is enabled or not for this node.
boolean
pickingChildren
AbstractWellTrack.isPickingChildrenEnabled
▸ isSelectable(): boolean
Returns true if node can be picked/selected.
boolean
The selectable flag
AbstractWellTrack.isSelectable
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ isVerticalFlip(): boolean
Return true if the representation is flipped vertically
boolean
flip
AbstractWellTrack.isVerticalFlip
▸ loadTemplate(template, registry?): WellTrack
Load template
| Name | Type | Description |
|---|---|---|
template | string | WellTrack | template to be applied to the track |
Optional registry | Registry | registry |
this
▸ moveTo(area, vAlign?, hAlign?): WellTrack
MoveTo position of node to specified area
| Name | Type | Description |
|---|---|---|
area | Rect | specified area |
Optional vAlign | string | vertical alignment. It can be "top", "bottom", "center". |
Optional hAlign | string | horizontal alignment It can be "left", "right", "center". |
this
▸ notify<E>(type, source, args?): WellTrack
Notify listeners of the Node
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event |
source | WellTrack | source who called the event |
Optional args | EventMap[E] | event arguments |
this
▸ Protected notifyRoot(event, source, args?): Node
Notify an even to root node
| Name | Type | Description |
|---|---|---|
event | string | type of event |
source | Node | source who called the event |
Optional args | any | event arguments |
this
▸ off<E>(type?, callback?): WellTrack
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.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: WellTrack, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): WellTrack
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.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: WellTrack, args: EventMap[E]) => void | to be called |
this
▸ Protected onBoundsChanged(bounds): WellTrack
Occurs when bounds has been changed
| Name | Type | Description |
|---|---|---|
bounds | Rect | bound of the node in the parent coordinates |
this
AbstractWellTrack.onBoundsChanged
▸ Protected onChildAdded(child): void
This method is called it child or children are added
void
AbstractWellTrack.onChildAdded
▸ Protected onChildRemoved(child): void
This method is called it child or children are removed
| Name | Type | Description |
|---|---|---|
child | Node | removed child |
void
AbstractWellTrack.onChildRemoved
▸ Protected onParentChanged(node): WellTrack
This method is called when parent changes. Do not call it directly.
| Name | Type | Description |
|---|---|---|
node | Node | node to change parent |
this
AbstractWellTrack.onParentChanged
▸ Protected onVisibilityChanged(): void
This method is called if visibility is changed. Send event Events.VisibilityChanged
void
AbstractWellTrack.onVisibilityChanged
▸ Protected onVisibleDepthLimitsChanged(oldLimits, newLimits, visible): WellTrack
Raising an event 'visibleDepthLimitsChanged' eventName : (geotoolkit.welllog.widgets.Events.VisibleDepthLimitsChanged)
| Name | Type | Description |
|---|---|---|
oldLimits | Range | old visible limits |
newLimits | Range | visible limits |
visible | boolean | visibility |
AbstractWellTrack.onVisibleDepthLimitsChanged
▸ Protected postRendering(context, callback?): void
To be called after rendering, used for PDF output
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
Optional callback | () => void | callback to be called after rendering |
void
AbstractWellTrack.postRendering
▸ Protected preRendering(context, callback?): void
Occurs before child rendering
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
Optional callback | () => void | callback to be called after rendering of geometry |
void
AbstractWellTrack.preRendering
▸ rebuild(force?, changes?): WellTrack
Rebuild node. This method resets state, cache, and invalidate node.
| Name | Type | Description |
|---|---|---|
Optional force | boolean | optional boolean parameter that can force invalidation |
Optional changes | StateChanges | optional parameter to specify a reason of changes |
this
▸ registerAnimationStyle(root): void
Register animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
AbstractWellTrack.registerAnimationStyle
▸ removeBaseLayer(baseLayer): WellTrack
Remove child baseLayer
this
AbstractWellTrack.removeBaseLayer
▸ removeChild(node, disposeChildren?): WellTrack
Remove child node
| Name | Type | Description |
|---|---|---|
node | Node | Node[] | node or array of nodes to be removed |
Optional disposeChildren | boolean | automatically dispose children. If it is true then method dispose is called for each child. |
this
▸ removeCssClass(cssclass): WellTrack
Removes css class from node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
AbstractWellTrack.removeCssClass
▸ removeInvalidateHandler(handler): WellTrack
Remove invalidate handler
Deprecated
since 4.0, use Node.off instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
AbstractWellTrack.removeInvalidateHandler
▸ removeOverlay(overlay): WellTrack
Remove child overlay
this
AbstractWellTrack.removeOverlay
▸ removeSelection(): WellTrack
Remove selection if it exists
this
AbstractWellTrack.removeSelection
▸ removeTrack(track, disposeTrack?): WellTrack
Remove the track with headers and footers
| Name | Type | Description |
|---|---|---|
track | LogTrack | track to remove |
Optional disposeTrack | boolean | automatically dispose track. If it is true then method dispose is called for track. |
▸ render(context): void
Render group
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render group |
void
▸ renderAsync(context, callback): void
Render node in asynchronous mode. This implementation doesn't support cache for now.
| Name | Type | Description |
|---|---|---|
context | RenderingContext | The rendering context to be used to draw the node |
callback | () => void | callback function |
void
▸ Protected renderBackground(context, bounds): WellTrack
Render background
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render background |
bounds | Rect | group bounds |
this
AbstractWellTrack.renderBackground
▸ Protected renderBaseLayers(context): WellTrack
Render baseLayers on bottom of cache. This method does nothing, but can be implemented to render graphics on bottom of cache and between borders
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render baseLayers |
this
AbstractWellTrack.renderBaseLayers
▸ Protected renderBaseLayersAsync(context, callback): void
Render baseLayers on bottom of cache in asynchronous mode. This method calls renderBaseLayers
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render overlays |
callback | () => void | callback function |
void
AbstractWellTrack.renderBaseLayersAsync
▸ Protected renderChildren(context): void
Render children
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
AbstractWellTrack.renderChildren
▸ Protected renderChildrenAsync(context, callback): void
Render children async
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
callback | () => void | callback function to be called then all children are rendered |
void
AbstractWellTrack.renderChildrenAsync
▸ Protected renderContent(context): void
render to specified context. This method calls preRendering, renderChildren, postRendering
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
AbstractWellTrack.renderContent
▸ Protected renderContentAsync(context, callback): void
Render children in asynchronous mode
| Name | Type | Description |
|---|---|---|
context | RenderingContext | The rendering context to be used to draw the node |
callback | () => void | callback function to be called then all children are rendered |
void
AbstractWellTrack.renderContentAsync
▸ Protected renderOverlays(context): WellTrack
Render overlays on top of cache. This method does nothing, but can be implemented to render graphics on top of cache and between borders
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render overlays |
this
AbstractWellTrack.renderOverlays
▸ Protected renderOverlaysAsync(context, callback): void
Render overlays on top of cache in asynchronous mode. This method calls renderOverlays
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render overlays |
callback | () => void | callback function |
void
AbstractWellTrack.renderOverlaysAsync
▸ resumeUpdate(rebuild?, changes?): WellTrack
Resume auto update
| Name | Type | Description |
|---|---|---|
Optional rebuild | boolean | force rebuild |
Optional changes | StateChanges | optional parameter to specify a reason of changes |
this
AbstractWellTrack.resumeUpdate
▸ rotate(theta, x, y): WellTrack
Rotate bounds around a given coordinate
| Name | Type | Description |
|---|---|---|
theta | number | angle to rotate node, in radians |
x | number | x coordinate to rotate around |
y | number | y coordinate to rotate around |
this
▸ saveTemplate(registry?): string
Save template
| Name | Type | Description |
|---|---|---|
Optional registry | Registry | registry |
string
return template as a string
▸ scale(xx, yy): WellTrack
Scale node
| Name | Type | Description |
|---|---|---|
xx | number | x scale factor |
yy | number | y scale factor |
this
▸ setAnimationStyle(animationStyle): WellTrack
Sets animation style
| Name | Type | Description |
|---|---|---|
animationStyle | Type | animation style |
AbstractWellTrack.setAnimationStyle
▸ setAutoModelLimitsMode(mode): WellTrack
Set 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. This is convenient method. It creates AutoModelLimitsStrategy
| Name | Type | Description |
|---|---|---|
mode | boolean | Model Limits Logics to be used |
this
AbstractWellTrack.setAutoModelLimitsMode
▸ setAutoModelLimitsStrategy(strategy): WellTrack
Set Model Limits Logics Strategy
| Name | Type | Description |
|---|---|---|
strategy | ModelLimitsStrategy | Model Limits logic strategy to use |
this
AbstractWellTrack.setAutoModelLimitsStrategy
▸ setBounds(bounds): WellTrack
Set bounds of the well
| Name | Type | Description |
|---|---|---|
bounds | Rect | track bounds |
▸ setCache(cache, rebuild?): WellTrack
Sets cache to be used to cache
| Name | Type | Description |
|---|---|---|
cache | Cache | cache to be used |
Optional rebuild | boolean | rebuild cache |
this
▸ setChild(index, node): WellTrack
Replace child node by index
| Name | Type | Description |
|---|---|---|
index | number | index of the node |
node | Node | node |
this
▸ setClipStyle(style): WellTrack
Sets a new clipping style
| Name | Type | Description |
|---|---|---|
style | GraphicsPath | ClipStyle | Options | a new clipping style |
this
AbstractWellTrack.setClipStyle
▸ setContentOrientation(orientation): WellTrack
Set content orientation
| Name | Type | Description |
|---|---|---|
orientation | Orientation | content orientation |
this
AbstractWellTrack.setContentOrientation
▸ setCss(style, merge?): WellTrack
Sets CSS style. This style will be applied for all inserted elements
| Name | Type | Description |
|---|---|---|
style | Type | CSS style to be applied to inserted elements |
Optional merge | boolean | merge flag |
this
▸ setCssClass(name): WellTrack
Sets css class name of the node to be used to apply CSS style
| Name | Type | Description |
|---|---|---|
name | string | css class name of the node |
this
▸ setCssTransform(transform): WellTrack
Set CSS transformation
| Name | Type | Description |
|---|---|---|
transform | string | Transformation | transformation css transformation instruction or Transformation instance |
this
AbstractWellTrack.setCssTransform
▸ setData(data): WellTrack
Sets a new data source
| Name | Type | Description |
|---|---|---|
data | AbstractDataTable | DataSource | data source |
this
▸ setDataBinding(binding, silent?): WellTrack
Sets the data binding
| Name | Type | Description |
|---|---|---|
binding | DataBinding | DataBindingRegistry | data binding |
Optional silent | boolean | silent mode to forbid |
this
▸ setDepthLimits(minIndex, maxIndex): WellTrack
Sets depth 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 | min index limit |
maxIndex | number | max index limit |
▸ setDepthLimits(range): WellTrack
Sets depth limits for all tracks
| Name | Type | Description |
|---|---|---|
range | Range | depth range |
▸ setDepthScale(scale, scaleUnit?, deviceUnit?): WellTrack
Sets a depth scale factor.
Throws
Will throw an error if the current scale is NaN
Example
// 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
AbstractWellTrack.setDepthScale
▸ setDesiredHeight(value, silent?): WellTrack
Sets desired height of the group as a layoutable object
| Name | Type | Description |
|---|---|---|
value | string | number | desired height to set, use 'auto' for automatic desired height |
Optional silent | boolean | silent setting |
this
AbstractWellTrack.setDesiredHeight
▸ setDesiredWidth(value, silent?): WellTrack
Sets desired width of the group as a layoutable object
| Name | Type | Description |
|---|---|---|
value | string | number | desired width to set |
Optional silent | boolean | silent setting |
this
AbstractWellTrack.setDesiredWidth
▸ setDeviceUnit(unit): WellTrack
Sets device unit of the current well
| Name | Type | Description |
|---|---|---|
unit | string | AbstractUnit | device unit |
this
▸ setFillStyle(fillStyle, merge?): WellTrack
Sets fill style
| Name | Type | Description |
|---|---|---|
fillStyle | Type | a new fill style |
Optional merge | boolean | true if you want to merge fillStyle with existing attribute, false by default |
this
AbstractWellTrack.setFillStyle
▸ setHorizontalFlip(enable): WellTrack
Set horizontal flip of the representation
| Name | Type | Description |
|---|---|---|
enable | boolean | enable flip |
this
AbstractWellTrack.setHorizontalFlip
▸ setId(id): WellTrack
Allows the user to associate any identifier
| Name | Type | Description |
|---|---|---|
id | string | number | object id |
this
▸ setIndexUnit(unit): WellTrack
Sets index unit
| Name | Type | Description |
|---|---|---|
unit | string | AbstractUnit | index unit |
this
▸ setInfiniteMode(infinityMode): WellTrack
Set infinity mode flag to draw composite without collision check
| Name | Type | Description |
|---|---|---|
infinityMode | boolean | infinity mode flag |
this
AbstractWellTrack.setInfiniteMode
▸ setLayout(layout): WellTrack
Associate layout with a group.
| Name | Type | Description |
|---|---|---|
layout | Record<string, any> | Layout | layout instance to be set or layout properties to apply |
this
▸ Protected setLayoutInvalidated(invalidated): void
Set invalidation status
| Name | Type | Description |
|---|---|---|
invalidated | boolean | invalidated layout |
void
AbstractWellTrack.setLayoutInvalidated
▸ setLayoutStyle(layoutStyle, silent?, merge?): WellTrack
specify desired layout style
| Name | Type | Description |
|---|---|---|
layoutStyle | LayoutStyle<string | number> | Options<string | number> | desired layout style |
Optional silent | boolean | silent setting |
Optional merge | boolean | true if you want to merge layoutStyle with existing attribute, false by default |
this
AbstractWellTrack.setLayoutStyle
▸ setLineStyle(lineStyle, merge?): WellTrack
Sets border color Returns this
| Name | Type | Description |
|---|---|---|
lineStyle | Type | line style or options |
Optional merge | boolean | true if you want to merge lineStyle with existing attribute, false by default |
this
AbstractWellTrack.setLineStyle
▸ setLocalTransform(localTransform, force?): WellTrack
Sets local transformation to be used to transform from local to parent coordinate
| Name | Type | Description |
|---|---|---|
localTransform | Transformation | local transformation for this node |
Optional force | boolean | boolean flag to force update event if transformations are equal, false by default |
this
AbstractWellTrack.setLocalTransform
▸ setMarginsStyle(margins, merge?): WellTrack
Sets margins style
| Name | Type | Description |
|---|---|---|
margins | Type<string | number> | margins style |
Optional merge | boolean | true if you want to merge marginsStyle with existing attribute, false by default |
this
AbstractWellTrack.setMarginsStyle
▸ setModelLimits(modelLimits): WellTrack
Sets inner model limits
Throws
Well Track model limits is fixed
| Name | Type | Description |
|---|---|---|
modelLimits | Rect | inner limits |
this
AbstractWellTrack.setModelLimits
▸ setName(name): WellTrack
Sets name of the node
| Name | Type | Description |
|---|---|---|
name | string | The node name |
this
▸ setNotification(notify, force?): WellTrack
set notification state
| Name | Type | Description |
|---|---|---|
notify | boolean | flag set to invalidate parent or not |
Optional force | boolean | true if parent should be invalidated immediately |
this
AbstractWellTrack.setNotification
▸ setOpacity(opacity, blendMode?): WellTrack
Sets node opacity
| Name | Type | Description |
|---|---|---|
opacity | number | node opacity from 0 to 1 |
Optional blendMode | BlendMode | opacity blend mode. If it is normal, opacity will be replaced. |
this
▸ setPaddingStyle(paddingStyle, merge?): WellTrack
Sets padding style
| Name | Type | Description |
|---|---|---|
paddingStyle | Type<string | number> | padding style |
Optional merge | boolean | true if you want to merge paddingStyle with existing attribute, false by default |
this
AbstractWellTrack.setPaddingStyle
▸ setProperties(properties?): WellTrack
Sets all the properties pertaining to this object
See
| Name | Type | Description |
|---|---|---|
Optional properties | Options | An object containing the properties to set |
this
AbstractWellTrack.setProperties
▸ setProperty(name, value): WellTrack
Sets dynamic property by name
| Name | Type | Description |
|---|---|---|
name | string | property name |
value | any | property value |
this
▸ setRenderingFilter(filter): WellTrack
Sets filter to be applied before rendering and picking
| Name | Type | Description |
|---|---|---|
filter | IFilter | filter to set |
this
AbstractWellTrack.setRenderingFilter
▸ setResponsiveStyle(style): WellTrack
Sets responsive style.
| Name | Type | Description |
|---|---|---|
style | Options | ResponsiveStyle | responsive style |
this
AbstractWellTrack.setResponsiveStyle
▸ setScaleScrollStrategy(strategy?): WellTrack
Sets scale scroll strategy
| Name | Type | Description |
|---|---|---|
Optional strategy | Delegate | scale scroll strategy |
this
AbstractWellTrack.setScaleScrollStrategy
▸ setSelectable(selectable): WellTrack
Allows to select node. If node is not selectable then child node is not selectable.
| Name | Type | Description |
|---|---|---|
selectable | boolean | flag to allow node selection |
this
AbstractWellTrack.setSelectable
▸ setSilent(bool): WellTrack
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setTag(tag): WellTrack
Allows the user to associate any arbitrary object with the node.
| Name | Type | Description |
|---|---|---|
tag | any | The object to be associated with the node. |
this
▸ setTitle(title): WellTrack
Sets well title
| Name | Type | Description |
|---|---|---|
title | string | well title |
this
▸ setTrackOptions(track, options): LogTrack
Sets track options
Example
//The code to configure the gridlines in a log track, specify logdecades and generate multiple logticks
import {TrackType} from '@int/geotoolkit/welllog/TrackType';
well.setTrackOptions(track, {
'type:': TrackType.LogTrack,
'value': {
'logstart': 0.2,
'logdecades': 4
}
});| Name | Type | Description |
|---|---|---|
track | LogTrack | log track |
options | TrackOptions | track options |
▸ setTrackWidth(width, track?): WellTrack
Set track width and layout remains track
| Name | Type | Description |
|---|---|---|
width | number | track width |
Optional track | LogTrack | if track is not defined then width is set for all tracks |
this
▸ setVerticalFlip(flip): WellTrack
Set vertical flip of the representation
| Name | Type | Description |
|---|---|---|
flip | boolean | flag to set the vertical flip of the representation |
this
AbstractWellTrack.setVerticalFlip
▸ setVisible(value): WellTrack
Sets visibility of the node. Send event Events.VisibilityChanged
| Name | Type | Description |
|---|---|---|
value | boolean | flag specifying visibility of the node |
this
▸ setVisibleDepthLimits(fromIndex, toIndex?): WellTrack
Sets visible depth limits
Example
// Set visible limits to fit visible area of container
well.setVisibleDepthLimits(limits, true);| Name | Type | Description |
|---|---|---|
fromIndex | Range | depth range |
Optional toIndex | boolean | option to fit to container visible limits |
IWellTrack.setVisibleDepthLimits
AbstractWellTrack.setVisibleDepthLimits
▸ setVisibleDepthLimits(fromIndex, toIndex, fitHeight?): WellTrack
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
| Name | Type | Description |
|---|---|---|
fromIndex | number | start depth |
toIndex | number | end range |
Optional fitHeight | boolean | option to fit to container visible limits |
IWellTrack.setVisibleDepthLimits
AbstractWellTrack.setVisibleDepthLimits
▸ setVisibleModelLimits(visibleModelBounds, deviceBounds?): WellTrack
Set visible model limits
| Name | Type | Description |
|---|---|---|
visibleModelBounds | Rect | visible model limits or bounds |
Optional deviceBounds | Rect | device bounds |
this
AbstractWellTrack.setVisibleModelLimits
▸ setZIndex(value): WellTrack
Sets z-index for node (set null for default)
| Name | Type | Description |
|---|---|---|
value | number | index determining node z-position |
this
▸ shear(shx, shy): WellTrack
Shear this node's bounds
| Name | Type | Description |
|---|---|---|
shx | number | x-axis shear |
shy | number | y-axis shear |
this
▸ suspendUpdate(): WellTrack
Suspend auto update
this
AbstractWellTrack.suspendUpdate
▸ toString(): string
Returns a string representation of this object (generally the classname)
string
A string representation
▸ translate(tx, ty): WellTrack
Translate bounds
| Name | Type | Description |
|---|---|---|
tx | number | x translation |
ty | number | y translation |
this
▸ unregisterAnimationStyle(root): void
Unregister animation style.
| Name | Type | Description |
|---|---|---|
root | AnimatedNode | root node for node |
void
AbstractWellTrack.unregisterAnimationStyle
▸ updateAdornments(): void
Update adornments
void
▸ updateLayout(targets?): WellTrack
Updates layout(s)
Fires
| Name | Type | Description |
|---|---|---|
Optional targets | ILayoutable[] | optional parameter about which element to layout |
this
AbstractWellTrack.updateLayout
▸ updateSceneTransformation(): WellTrack
Update scene transformation
this
AbstractWellTrack.updateSceneTransformation
▸ updateState(regions?, changes?): WellTrack
Mark this group to be updated.
| Name | Type | Description |
|---|---|---|
Optional regions | Rect[] | optional array to return invalid rectangles |
Optional changes | StateChanges | optional parameter to specify a reason of changes |
this
▸ updateSuspended(): boolean
Return state of suspend state
boolean
state of update
AbstractWellTrack.updateSuspended
▸ Protected updateTimeStamp(): WellTrack
Update time stamp to indicate that Node or Children has been changed.
this
AbstractWellTrack.updateTimeStamp
▸ Static enableSceneGraphNotification(enabled): void
Enable / disable all notifications
| Name | Type | Description |
|---|---|---|
enabled | boolean | sets if this object sends notifications |
void
AbstractWellTrack.enableSceneGraphNotification
▸ Static findParent<T>(node, classType, filter?): InstanceType<T>
Find root of the node with specified type
| Name | Type |
|---|---|
T | extends Constructor<any> |
| Name | Type | Description |
|---|---|---|
node | Node | node to start search |
classType | T | type of the class to search for |
Optional filter | (node: Node) => boolean | additional filter to apply |
InstanceType<T>
▸ Static findParent(node, classType, filter?): Node
Find root of the node with specified type
| Name | Type | Description |
|---|---|---|
node | Node | node to start search |
classType | string | interface name to search for |
Optional filter | (node: Node) => boolean | additional filter to apply |
▸ Static getClassName(): string
string
AbstractWellTrack.getClassName
▸ Static isSceneGraphNotificationEnabled(): boolean
Return status of the global notification for all nodes.
boolean