Last updated

API / geotoolkit / welllog / multiwell / ProxyWellTrack / ProxyWellTrack

Class: ProxyWellTrack

multiwell.ProxyWellTrack.ProxyWellTrack

The Proxy well track is designated to improve template loading performance

Example

import {MultiWellWidget} from '@int/geotoolkit/welllog/multiwell/MultiWellWidget';
import {TrackType as MultiTrackType} from '@int/geotoolkit/welllog/multiwell/TrackType';

const proxyWell = multiWellWidget.addTrack(MultiTrackType.ProxyTrack, {
'range': positions,
'welllog': {
'range': depthrange
},
'width': template.getLayoutStyle().getWidth(),
'height': template.getLayoutStyle().getHeight(),
'prototype': {
'template': template,
'create': (track: ProxyWellTrack) => new Promise( (resolve, reject) => {
const template = track.getPrototype();
if (template != null) {
const instance = template.clone() as WellTrack | LogTrack;
return resolve(instance);
}
return reject(new Error('error'));
})
},
'title': title
});

Hierarchy

Implements

Table of contents

Constructors
Methods
addBaseLayeraddChildaddCssClass
addInvalidateHandleraddOverlayadjustPosition
applyOpacityapplyResponsiveStyleasNode
beginExportchangeBaseLayerOrderchangeChildOrder
changeOverlayOrdercheckCollisionclearBaseLayers
clearCacheclearChildrenclearOverlays
cloneconnectStyleconnectTool
convertDepthToBoundscopyConstructorcreateWritableInstance
disconnectStyledisconnectTooldispose
drawBorderenableClippingenableEventPropagation
enableNavigationenablePickingChildrenendExport
enumerateNodesexecutefilter
getAnimationStylegetAutoModelLimitsModegetAutoModelLimitsStrategy
getBaseLayergetBaseLayersgetBaseLayersCount
getBoundsgetCachegetChild
getChildrengetChildrenCountgetClassName
getClipStylegetContentOrientationgetContentsArea
getContentsTransformgetCssgetCssClass
getCssClassesgetCssTransformgetData
getDataBindinggetDepthLimitsgetDepthScale
getDesiredHeightgetDesiredWidthgetDeviceLimits
getDeviceUnitgetExportElementgetFillStyle
getFootergetHeadergetId
getInfiniteModegetInvalidateMethodgetLayout
getLayoutStylegetLineStylegetLocalTransform
getManipulatorLayergetMarginsStylegetMarkerLayer
getModelLimitsgetNamegetOpacity
getOpacityBlendModegetOverlaygetOverlayAt
getOverlaysgetOverlaysCountgetPaddingStyle
getParentgetPreferredSizegetProperties
getPropertygetPropertyKeysgetPrototype
getRenderingFiltergetResponsiveStylegetRoot
getScaleScrollStrategygetScaleUnitgetSceneTransform
getSelectiongetTaggetTitle
getToolgetToolByNamegetTrack
getVisiblegetVisibleDepthLimitsgetVisibleDeviceLimits
getVisibleModelLimitsgetWidthgetWorldTransform
getZIndexgetZoneLayerhasCssClass
hasEventListenerindexOfBaseLayerindexOfChild
indexOfOverlayinsertBaseLayerinsertChild
insertOverlayinvalidateinvalidateLayout
invalidateParentisClippingEnabledisDisposed
isEventPropagationEnabledisHorizontalFlipisLayoutInvalidated
isNavigationEnabledisNotificationEnabledisPickingChildrenEnabled
isSelectableisSilentisVerticalFlip
moveTonotifynotifyRoot
offononBoundsChanged
onChildAddedonChildRemovedonParentChanged
onVisibilityChangedonVisibleDepthLimitsChangedpostRendering
preRenderingrebuildregisterAnimationStyle
removeBaseLayerremoveChildremoveCssClass
removeInvalidateHandlerremoveOverlayremoveSelection
renderrenderAsyncrenderBackground
renderBaseLayersrenderBaseLayersAsyncrenderChildren
renderChildrenAsyncrenderContentrenderContentAsync
renderOverlaysrenderOverlaysAsyncresumeUpdate
rotatescalesetAnimationStyle
setAutoModelLimitsModesetAutoModelLimitsStrategysetBounds
setCachesetChildsetClipStyle
setContentOrientationsetCsssetCssClass
setCssTransformsetDatasetDataBinding
setDepthLimitssetDepthScalesetDesiredHeight
setDesiredWidthsetDeviceUnitsetFillStyle
setHorizontalFlipsetIdsetInfiniteMode
setLayoutsetLayoutInvalidatedsetLayoutStyle
setLineStylesetLocalTransformsetMarginsStyle
setModelLimitssetNamesetNotification
setOpacitysetPaddingStylesetProperties
setPropertysetPrototypesetRenderingFilter
setResponsiveStylesetScaleScrollStrategysetScaleUnit
setSelectablesetSilentsetTag
setTitlesetVerticalFlipsetVisible
setVisibleDepthLimitssetVisibleModelLimitssetZIndex
shearsuspendUpdatetoString
translateunregisterAnimationStyleupdateAdornments
updateLayoutupdateSceneTransformationupdateState
updateSuspendedupdateTimeStampenableSceneGraphNotification
findParentgetClassNameisSceneGraphNotificationEnabled
Css Properties
Name Type Description
automodellimitsmodebooleanAuto model limits mode
borderOptionsBorder
border-cssclassstringThe css class name of this node
border-idstring | numberId of the node, its a unique identifier
border-namestringName of the node. It is often used for debugging purposes or to simplify queries
border-selectablebooleanSelectable node, a boolean to determine if selection should consider this node
border-taganyCustom 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-visiblebooleanVisibility of the node, a boolean to determine if the node should be rendered or not
border-z-indexnumberDefine node z-index
borderOptionsBorder
border-clipstyleClipStyleClipping style
border-clipstyle-evenoddbooleanTrue if evenodd mode is on ('nonzero' mode otherwise)
border-clipstyle-geometryGraphicsPathClipping geometry
border-clipstyle-geometry-boundsRectBounds
border-clipstyle-geometry-bounds-heightnumberHeight
border-clipstyle-geometry-bounds-readonlybooleanReadonly
border-clipstyle-geometry-bounds-widthnumberWidth
border-clipstyle-geometry-bounds-xnumberLeft
border-clipstyle-geometry-bounds-ynumberTop
border-clipstyleGraphicsPathClipping style
border-csscursorstringCSS cursor associated with node
border-cssstylestringCSS style to be applied to inserted elements
border-localtransformTransformationLocal transformation
border-localtransform-dxnumberX axis translation
border-localtransform-dynumberY axis translation
border-localtransform-xxnumberX scale
border-localtransform-xynumberXy skew
border-localtransform-yxnumberYx skew
border-localtransform-yynumberY scale
border-marginsnumber | stringIt has properties for specifying the margins for each side
border-opacitynumberNode 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-opacityblendmodeBlendModeNode opacity mode to blend it
border-scalescrollstrategyScaleScrollStrategyScale scroll strategy
border-scalescrollstrategy-enabledbooleanEnable flag
border-transformstringAdditional CSS transformation applied to node or 'none'
border-transformTransformationAdditional CSS transformation applied to node or 'none'
borderOptionsBorder
border-fillstylestringStyle applied on fill
border-fillstyleFillStyleStyle applied on fill
border-fillstyle-colorstringColor in CSS form
border-fillstyle-evenoddmodebooleanEven-odd fill mode
border-fillstyle-fillpatternPatternPattern
border-fillstyle-fillpattern-containernamestringAn 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-patternnamestringName of this pattern for indexing
border-fillstyle-fillpattern-scalablebooleanFlag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported)
border-fillstyle-foregroundstringForeground color
border-fillstyle-patternPatternPattern
border-linestylestringStyle applied on outline
border-linestyleLineStyleStyle applied on outline
border-linestyle-colorstringColor in CSS form
border-linestyle-fillstringOptional fill style to be used to fill lines generated with this style
border-linestyle-fillFillStyleOptional fill style to be used to fill lines generated with this style
border-linestyle-linecapCapStyleThe line cap style
border-linestyle-linedashoffsetnumberLine dash offset of dashed line
border-linestyle-linejoinJoinStyleThe line join style
border-linestyle-pixelsnapmodebooleanPixel Snap Mode, default(
border-linestyle-scalablebooleanTrue if width should depend on transformation
border-linestyle-unitstringOptional unit for the width
border-linestyle-widthnumber | stringThe line thickness
borderOptionsBorder
border-bordersVisibleStyle applied on borders, by default is
border-borders-bottombooleanVisibility of bottom part
border-borders-leftbooleanVisibility of left part
border-borders-rightbooleanVisibility of right part
border-borders-topbooleanVisibility of top part
border-borderstyleBorderStyleStyle applied on borders
border-linestylesStylesObject with line styles
border-linestyles-bottomstringBottom border style
border-linestyles-bottomLineStyleBottom border style
border-linestyles-leftstringLeft border style
border-linestyles-leftLineStyleLeft border style
border-linestyles-rightstringRight border style
border-linestyles-rightLineStyleRight border style
border-linestyles-topstringTop border style
border-linestyles-topLineStyleTop border style
borderstrategyBorderStrategyBorder rendering strategy
boundsRectDefine position of the group in the parent
clippingbooleanEnable clipping, this does not consider the clipstyle, it is related to bounds-clipping
clipstyleClipStyleClipping style
clipstyleGraphicsPathClipping style
contentorientationOrientationContent orientation
cssclassstringThe css class name of this node
csscursorstringCSS cursor associated with node
cssstylestringCSS style to be applied to inserted elements
deviceunitstringDevice unit
deviceunitUnitDevice unit
deviceunit-anumberFactor
deviceunit-bnumberFactor
deviceunit-baseunitsymbolstringRepresents the unit symbol of it's base unit (example for volume, 'm3' can be the base unit)
deviceunit-cnumberFactor
deviceunit-dnumberFactor
deviceunit-descriptionstringIt represents the description of unit
deviceunit-namestringRepresent the name of the unit (example : 'pint')
deviceunit-symbolstringSymbol to represent the unit (example: 'pt' to represent pint)
fillstylestringFill style
fillstyleFillStyleFill style
heightnumberWell track height
horizontalflipbooleanHorizontal axis goes from right to left
idstring | numberId of the node, its a unique identifier
indexunitstringIndex unit
indexunitUnitIndex unit
infinitybooleanMode to render outside the model limits
layoutstyleLayoutStyleLayout style to be used for parent layout
layoutstyle-constraintSizeConstraintLayout constrains
layoutstyle-flexgrownumberNumber specifying how much the item will grow relative to the rest of the items inside the same container
layoutstyle-flexshrinknumberNumber specifying how much the item will shrink relative to the rest of the items inside the same container
layoutstyle-floatstringFloat position
layoutstyle-positionstringLayout position
layoutstyle-sizenumber | stringLayout size
linestylestringLine style
linestyleLineStyleLine style
localtransformTransformationLocal transformation
marginsnumber | stringIt has properties for specifying the margins for each side
modellimitsRectDefine inner model coordinates of the group
namestringName of the node. It is often used for debugging purposes or to simplify queries
opacitynumberNode opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context
opacityblendmodeBlendModeNode opacity mode to blend it
paddingnumber | stringIt has properties for specifying the padding for each side
pickingchildrenbooleanEnable picking children
rangeRangePosition in container
range-highnumberUpper range boundary
range-lownumberLower range boundary
range-maxnumber
range-minnumber
scalescrollstrategyScaleScrollStrategyScale scroll strategy
selectablebooleanSelectable node, a boolean to determine if selection should consider this node
taganyCustom 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
titlestringTrack title, uses for header and footer
trackWellTrackWell track to be displayed
track-automodellimitsmodebooleanAuto model limits mode
track-borderOptionsBorder
track-borderOptionsBorder
track-borderOptionsBorder
track-borderOptionsBorder
track-borderstrategyBorderStrategyBorder rendering strategy
track-boundsRectDefine position of the group in the parent
track-clippingbooleanEnable clipping, this does not consider the clipstyle, it is related to bounds-clipping
track-clipstyleClipStyleClipping style
track-clipstyleGraphicsPathClipping style
track-contentorientationOrientationContent orientation
track-cssclassstringThe css class name of this node
track-csscursorstringCSS cursor associated with node
track-cssstylestringCSS style to be applied to inserted elements
track-fillstylestringFill style
track-fillstyleFillStyleFill style
track-horizontalflipbooleanHorizontal axis goes from right to left
track-idstring | numberId of the node, its a unique identifier
track-idstring | numberWell id
track-infinitybooleanMode to render outside the model limits
track-layoutstyleLayoutStyleLayout style to be used for parent layout
track-linestylestringLine style
track-linestyleLineStyleLine style
track-localtransformTransformationLocal transformation
track-marginsnumber | stringIt has properties for specifying the margins for each side
track-modellimitsRectDefine inner model coordinates of the group
track-namestringName of the node. It is often used for debugging purposes or to simplify queries
track-opacitynumberNode opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context
track-opacityblendmodeBlendModeNode opacity mode to blend it
track-paddingnumber | stringIt has properties for specifying the padding for each side
track-pickingchildrenbooleanEnable picking children
track-rangeRangePosition in container
track-scalescrollstrategyScaleScrollStrategyScale scroll strategy
track-selectablebooleanSelectable node, a boolean to determine if selection should consider this node
track-taganyCustom 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
track-titlestringWell track title
track-transformstringAdditional CSS transformation applied to node or 'none'
track-transformTransformationAdditional CSS transformation applied to node or 'none'
track-verticalflipbooleanVertical axis goes from bottom to top
track-viewcachebooleanView cache to cache child nodes
track-visiblebooleanVisibility of the node, a boolean to determine if the node should be rendered or not
track-welllogOptionsBaseOptions for well log
track-welllog-indentnumberIndent between tracks
track-welllog-verticalscrollableboolean
track-welllogOptionsOptions for well log
track-welllog-borderBorderOptionsDefines properties for widget outer border
track-welllog-border-bordersVisibleBorders visibility option
track-welllog-border-colorstringColor of border
track-welllog-border-linestylestringBorder line style
track-welllog-border-linestyleLineStyleBorder line style
track-welllog-border-visiblebooleanVisibility of the border
track-welllog-depthlimitsoptionsDepthLimitsOptionsDepth limits options
track-welllog-depthlimitsoptions-neatlimitsbooleanAuto neat depth limits
track-welllog-depthlimitsoptions-typeDepthLimitsTypesDepth limits type
track-welllog-deviceunitstringPrimary device unit
track-welllog-directionTrackRenderDirectionSet track render direction
track-welllog-gridlinestylestringGrid line style
track-welllog-gridlinestyleLineStyleGrid line style
track-welllog-horizontalscrollablebooleanDefines if plot displays horizontal scrollbars
track-welllog-indextypeIndexTypePrimary index types
track-welllog-indexunitstringPrimary index unit
track-welllog-markerMarkerOptionsMarker options
track-welllog-marker-datetimeformatOptionsDate time format in case if track container scale unit belongs to 'time'
track-welllog-marker-datetimeformat-formatstringDate time format
track-welllog-marker-datetimeformat-timezoneTimeZoneTime zone
track-welllog-marker-enabledinterpolatedvaluesbooleanDisplay symbol for interpolated values
track-welllog-marker-fillstylestringMarker shape fill style
track-welllog-marker-fillstyleFillStyleMarker shape fill style
track-welllog-marker-indexvisiblebooleanVisibility of the marker index value label
track-welllog-marker-labelvisiblebooleanVisibility of the marker shape label
track-welllog-marker-linestylestringMarker shape line style
track-welllog-marker-linestyleLineStyleMarker shape line style
track-welllog-marker-symbolSymbolShapeSymbol to use as depth index marker
track-welllog-marker-symbol-alignmentAnchorTypeAlignment according to the anchor point
track-welllog-marker-symbol-alignmentAnchorTypeAnchor type of symbol
track-welllog-marker-symbol-axnumberAnchor x position
track-welllog-marker-symbol-aynumberAnchor y position
track-welllog-marker-symbol-cachebooleanSet it to true if you want to cache complex geometry to raster
track-welllog-marker-symbol-clipstyleClipStyleClipping style
track-welllog-marker-symbol-clipstyleGraphicsPathClipping style
track-welllog-marker-symbol-cssclassstringThe css class name of this node
track-welllog-marker-symbol-csscursorstringCSS cursor associated with node
track-welllog-marker-symbol-cssstylestringCSS style to be applied to inserted elements
track-welllog-marker-symbol-fillstylestringStyle applied on fill
track-welllog-marker-symbol-fillstyleFillStyleStyle applied on fill
track-welllog-marker-symbol-heightnumberShape height
track-welllog-marker-symbol-idstring | numberId of the node, its a unique identifier
track-welllog-marker-symbol-ispointingupbooleanDefines whether the shape is always pointing up
track-welllog-marker-symbol-layoutstyleLayoutStyleLayout style to specify how to lay out shape
track-welllog-marker-symbol-linestylestringStyle applied on outline
track-welllog-marker-symbol-linestyleLineStyleStyle applied on outline
track-welllog-marker-symbol-localtransformTransformationLocal transformation
track-welllog-marker-symbol-marginsnumber | stringIt has properties for specifying the margins for each side
track-welllog-marker-symbol-maxdimensionDimensionMaximum size for rendering
track-welllog-marker-symbol-maxdimension-heightnumberHeight of dimension
track-welllog-marker-symbol-maxdimension-widthnumberWidth of dimension or properties
track-welllog-marker-symbol-mindimensionDimensionMinimum size for rendering
track-welllog-marker-symbol-namestringName of the node. It is often used for debugging purposes or to simplify queries
track-welllog-marker-symbol-opacitynumberNode opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context
track-welllog-marker-symbol-opacityblendmodeBlendModeNode opacity mode to blend it
track-welllog-marker-symbol-painterstringA function with has parameters: symbol, box, context
track-welllog-marker-symbol-painterpropertiesanySymbol's painter's properties
track-welllog-marker-symbol-preserveaspectratiobooleanPreserve aspect ratio of the anchored shape
track-welllog-marker-symbol-preservereadingorientationbooleanPreserve reading orientation for local transform
track-welllog-marker-symbol-preserverightanglebooleanPreserve right angle for local transformation
track-welllog-marker-symbol-rotationanglenumberRotation angle at anchor
track-welllog-marker-symbol-scalescrollstrategyScaleScrollStrategyScale scroll strategy
track-welllog-marker-symbol-selectablebooleanSelectable node, a boolean to determine if selection should consider this node
track-welllog-marker-symbol-sizeisindevicespacebooleanIs coordinate in device space
track-welllog-marker-symbol-taganyCustom 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
track-welllog-marker-symbol-transformstringAdditional CSS transformation applied to node or 'none'
track-welllog-marker-symbol-transformTransformationAdditional CSS transformation applied to node or 'none'
track-welllog-marker-symbol-useminmaxdimensionsbooleanUse the min max dimensions to limit visual size
track-welllog-marker-symbol-visiblebooleanVisibility of the node, a boolean to determine if the node should be rendered or not
track-welllog-marker-symbol-widthnumberShape width
track-welllog-marker-symbol-z-indexnumberDefine node z-index
track-welllog-orientationOrientationSet orientation of the well log widget
track-welllog-rangeRangeMin and max depth range
track-welllog-timezoneTimeZoneTime zone for time axis
track-welllog-timezoneoffsetnumberTime zone offset for date time axis
track-welllog-verticalscrollablebooleanDefines if plot displays vertical scrollbars
track-welllog-viewcachebooleanDefine view cache for tracks
track-widthnumberWell width
track-z-indexnumberDefine node z-index
trackLogTrackWell track to be displayed
track-backgroundcolorstringBackground color fill style
track-backgroundcolorFillStyleBackground color fill style
track-borderBorderOutline of the track
track-border-bordersVisibleStyle applied on borders, by default is
track-border-borderstyleBorderStyleStyle applied on borders
track-border-clipstyleClipStyleClipping style
track-border-clipstyleGraphicsPathClipping style
track-border-cssclassstringThe css class name of this node
track-border-csscursorstringCSS cursor associated with node
track-border-cssstylestringCSS style to be applied to inserted elements
track-border-fillstylestringStyle applied on fill
track-border-fillstyleFillStyleStyle applied on fill
track-border-idstring | numberId of the node, its a unique identifier
track-border-linestylestringStyle applied on outline
track-border-linestyleLineStyleStyle applied on outline
track-border-linestylesStylesObject with line styles
track-border-localtransformTransformationLocal transformation
track-border-marginsnumber | stringIt has properties for specifying the margins for each side
track-border-namestringName of the node. It is often used for debugging purposes or to simplify queries
track-border-opacitynumberNode opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context
track-border-opacityblendmodeBlendModeNode opacity mode to blend it
track-border-scalescrollstrategyScaleScrollStrategyScale scroll strategy
track-border-selectablebooleanSelectable node, a boolean to determine if selection should consider this node
track-border-taganyCustom 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
track-border-transformstringAdditional CSS transformation applied to node or 'none'
track-border-transformTransformationAdditional CSS transformation applied to node or 'none'
track-border-visiblebooleanVisibility of the node, a boolean to determine if the node should be rendered or not
track-border-z-indexnumberDefine node z-index
track-borderstrategyBorderStrategyStrategy on how to display the border of the track
track-boundsRectBounds of the visual
track-clippingbooleanEnable clipping, this does not consider the clipstyle, it is related to bounds-clipping
track-clipstyleClipStyleClipping style
track-clipstyleGraphicsPathClipping style
track-cssclassstringThe css class name of this node
track-csscursorstringCSS cursor associated with node
track-cssstylestringCSS style to be applied to inserted elements
track-fillstylestringBackground color fill style (alias for backgroundcolor)
track-fillstyleFillStyleBackground color fill style (alias for backgroundcolor)
track-highlightBorderHighlight outline of the track
track-highlightstrategyTrackHighlightStrategyTrack highlight strategy
track-idstring | numberId of the node, its a unique identifier
track-infinitybooleanMode to render outside the model limits
track-limitsRectModel limits
track-linestylestringLine style or options
track-linestyleLineStyleLine style or options
track-localtransformTransformationLocal transformation
track-logblockLogBlockLog block
track-logblock-autoboundsbooleanEnables or disables auto bounds
track-logblock-basenamestringThe base name
track-logblock-boundsRectThe rectangle specifying position of the visual in the track. If set, autobounds will be switched off
track-logblock-clipstyleClipStyleClipping style
track-logblock-clipstyleGraphicsPathClipping style
track-logblock-cssclassstringThe css class name of this node
track-logblock-csscursorstringCSS cursor associated with node
track-logblock-cssstylestringCSS style to be applied to inserted elements
track-logblock-descriptionstringThe description
track-logblock-fillstylestringThe fill style
track-logblock-fillstyleFillStyleThe fill style
track-logblock-idstring | numberId of the node, its a unique identifier
track-logblock-linestylestringLinestyle
track-logblock-linestyleLineStyleLinestyle
track-logblock-localtransformTransformationLocal transformation
track-logblock-marginsnumber | stringIt has properties for specifying the margins for each side
track-logblock-microposleftnumberLeft micro position
track-logblock-microposrightnumberRight micro position
track-logblock-namestringName of the node. It is often used for debugging purposes or to simplify queries
track-logblock-opacitynumberNode opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context
track-logblock-opacityblendmodeBlendModeNode opacity mode to blend it
track-logblock-positionPositionPosition (left or right or both)
track-logblock-scalescrollstrategyScaleScrollStrategyScale scroll strategy
track-logblock-selectablebooleanSelectable node, a boolean to determine if selection should consider this node
track-logblock-taganyCustom 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
track-logblock-transformstringAdditional CSS transformation applied to node or 'none'
track-logblock-transformTransformationAdditional CSS transformation applied to node or 'none'
track-logblock-visiblebooleanVisibility of the node, a boolean to determine if the node should be rendered or not
track-logblock-z-indexnumberDefine node z-index
track-marginsnumber | stringIt has properties for specifying the margins for each side
track-namestringName of the node. It is often used for debugging purposes or to simplify queries
track-opacitynumberNode opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context
track-opacityblendmodeBlendModeNode opacity mode to blend it
track-scalescrollstrategyScaleScrollStrategyScale scroll strategy
track-selectablebooleanSelectable node, a boolean to determine if selection should consider this node
track-taganyCustom 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
track-transformstringAdditional CSS transformation applied to node or 'none'
track-transformTransformationAdditional CSS transformation applied to node or 'none'
track-visiblebooleanVisibility of the node, a boolean to determine if the node should be rendered or not
track-z-indexnumberDefine node z-index
transformstringAdditional CSS transformation applied to node or 'none'
transformTransformationAdditional CSS transformation applied to node or 'none'
verticalflipbooleanVertical axis goes from bottom to top
viewcachebooleanView cache to cache child nodes
visiblebooleanVisibility of the node, a boolean to determine if the node should be rendered or not
widthnumberWell track width
z-indexnumberDefine node z-index

Contents

Constructors

new ProxyWellTrack(options)

new ProxyWellTrack(options?)

Creates proxy well track

Parameters

Name Type Description
Optional optionsOptionsaddition options

Overrides

AbstractWellTrack.constructor

Methods

addBaseLayer

addBaseLayer(baseLayer): ProxyWellTrack

Add baseLayer to container

Parameters

Name Type Description
baseLayerNode | Node[]baseLayer to be added

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.addBaseLayer


addChild

addChild(node): ProxyWellTrack

Add a child node

Parameters

Name Type Description
nodeNode | Iterator<Node> | Node[]the child node to be added

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.addChild


addCssClass

addCssClass(cssclass): ProxyWellTrack

Adds new css class to node

Parameters

Name Type Description
cssclassstring | string[]css class name('s)

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.addCssClass


addInvalidateHandler

addInvalidateHandler(handler): ProxyWellTrack

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

Parameters

Name Type Description
handlerFunctionhandler to be notified about invalidation

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.addInvalidateHandler


addOverlay

addOverlay(overlay): ProxyWellTrack

Add overlay to container

Parameters

Name Type Description
overlayNode | Node[]overlay to be added

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.addOverlay


adjustPosition

adjustPosition(area?, vAlign?, hAlign?): ProxyWellTrack

Adjust position of node to specified area

Parameters

Name Type Description
Optional areaRectspecified area. Default to Parent Model Limits
Optional vAlignstringvertical alignment. It can be "top", "bottom", "center". Defaults to "top".
Optional hAlignstringhorizontal alignment It can be "left", "right", "center". Defaults to "left".

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.adjustPosition


applyOpacity

Protected applyOpacity(context): ProxyWellTrack

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

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.applyOpacity


applyResponsiveStyle

Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

Returns

void

Inherited from

AbstractWellTrack.applyResponsiveStyle


asNode

asNode(): Node

Return track as Node instance

Returns

Node

Implementation of

IProxyWellTrack.asNode

Inherited from

AbstractWellTrack.asNode


beginExport

beginExport(): ProxyWellTrack

Prepares object before exporting and saving state

Returns

ProxyWellTrack

this

Implementation of

IExportable.beginExport


changeBaseLayerOrder

changeBaseLayerOrder(overlay, order, anchor?): ProxyWellTrack

Changes the z-order of the baseLayer.

Parameters

Name Type Description
overlayNode
orderNodeOrderposition to be added
Optional anchorNodeanchor node to specify changeOrder with respect to this node

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.changeBaseLayerOrder


changeChildOrder

changeChildOrder(node, order, anchor?): ProxyWellTrack

changes the z-order of the nodes being rendered.

Parameters

Name Type Description
nodeNodeany child added in the Composite node
orderNodeOrderposition to be added
Optional anchorNodeanchor node to specify changeOrder with respect to this node

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.changeChildOrder


changeOverlayOrder

changeOverlayOrder(overlay, order, anchor?): ProxyWellTrack

Changes the z-order of the overlay.

Parameters

Name Type Description
overlayNodechild overlay
orderNodeOrderposition to be added
Optional anchorNodeanchor node to specify changeOrder with respect to this node

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.changeOverlayOrder


checkCollision

checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

boolean

true if node is collided

Inherited from

AbstractWellTrack.checkCollision


clearBaseLayers

clearBaseLayers(disposeBaseLayers?): ProxyWellTrack

Remove all child baseLayers from group

Parameters

Name Type Description
Optional disposeBaseLayersbooleanautomatically dispose baseLayers. If it is true then method dispose is called for each baseLayer, false by default

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.clearBaseLayers


clearCache

clearCache(): ProxyWellTrack

Clear cache

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.clearCache


clearChildren

clearChildren(disposeChildren?): ProxyWellTrack

Remove all child nodes from this composite group

Parameters

Name Type Description
Optional disposeChildrenbooleanautomatically dispose children. If it is true then method dispose is called for each child.

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.clearChildren


clearOverlays

clearOverlays(disposeOverlays?): ProxyWellTrack

Remove all child overlays from group

Parameters

Name Type Description
Optional disposeOverlaysbooleanautomatically dispose overlays. If it is true then method dispose is called for each overlay, false by default

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.clearOverlays


clone

clone(): ProxyWellTrack

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

Returns

ProxyWellTrack

clone

Overrides

AbstractWellTrack.clone


connectStyle

connectStyle(style, type, callback): ProxyWellTrack

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

Parameters

Name Type Description
styleEventDispatcherconnect style
typestringtype of event or property
callbackAttributeCallback<EventDispatcher>function to be called

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.connectStyle


connectTool

connectTool(tool): ProxyWellTrack

Connect a new tool with a tool name to the widget

Parameters

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

Returns

ProxyWellTrack

this


convertDepthToBounds

Protected convertDepthToBounds(depth): number

Converts depth to position inside of the bounds

Parameters

Name Type Description
depthnumberdepth

Returns

number

vertical position inside of the bounds

Inherited from

AbstractWellTrack.convertDepthToBounds


copyConstructor

Protected copyConstructor(src, deepCopy?): ProxyWellTrack

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

Parameters

Name Type Description
srcProxyWellTrackSource to copy from
Optional deepCopybooleandeep copy

Returns

ProxyWellTrack

this

Overrides

AbstractWellTrack.copyConstructor


createWritableInstance

createWritableInstance(): Promise<LogTrack | WellTrack>

Return promise with new track instance

Returns

Promise<LogTrack | WellTrack>

promise

Implementation of

IProxyWellTrack.createWritableInstance


disconnectStyle

disconnectStyle(style, type, callback): ProxyWellTrack

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

Parameters

Name Type Description
styleEventDispatcherconnect style
typestringtype of event or property
callbackAttributeCallback<EventDispatcher>function to be called

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.disconnectStyle


disconnectTool

disconnectTool(tool): ProxyWellTrack

Disconnect the tool from the widget

Parameters

Name Type Description
toolAbstractTool | AbstractTool[]tool to disconnect

Returns

ProxyWellTrack

this


dispose

dispose(): void

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

Returns

void

Inherited from

AbstractWellTrack.dispose


drawBorder

Protected drawBorder(localContext, bounds?): ProxyWellTrack

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

Parameters

Name Type Description
localContextRenderingContextThe local rendering context
Optional boundsRectgroup bounds

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.drawBorder


enableClipping

enableClipping(doClip): ProxyWellTrack

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

Parameters

Name Type Description
doClipbooleanenable clipping on this node

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.enableClipping


enableEventPropagation

enableEventPropagation(enable): ProxyWellTrack

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

Parameters

Name Type Description
enablebooleanenable

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.enableEventPropagation


enableNavigation

enableNavigation(enabled): ProxyWellTrack

Enable navigation tool after track instantiation. By default it is enabled

Parameters

Name Type Description
enabledbooleanflag to enable/disable navigation

Returns

ProxyWellTrack


enablePickingChildren

enablePickingChildren(enable): ProxyWellTrack

Enables or disables picking children

Parameters

Name Type Description
enablebooleanenable picking children

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.enablePickingChildren


endExport

endExport(): ProxyWellTrack

Used to restore object's state after exporting

Returns

ProxyWellTrack

this

Implementation of

IExportable.endExport


enumerateNodes

enumerateNodes(callback, target?): void

Executes a provided function once for each child node

Parameters

Name Type Description
callbackCallback<Node>provided function
Optional targetQueryBuilder<any>target to pass to callback as a second parameter

Returns

void

Inherited from

AbstractWellTrack.enumerateNodes


execute

execute(delegate): ProxyWellTrack

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

Parameters

Name Type Description
delegate(this: ProxyWellTrack) => voidFunction to execute

Returns

ProxyWellTrack

The result if any or this

Inherited from

AbstractWellTrack.execute

execute<T>(delegate): T

Type parameters

Name
T

Parameters

Name Type
delegate(this: ProxyWellTrack) => T

Returns

T

Inherited from

AbstractWellTrack.execute


filter

Protected filter(context): boolean

Filter node

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

boolean

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

Inherited from

AbstractWellTrack.filter


getAnimationStyle

getAnimationStyle(): AnimationStyle

Return animation style

Returns

AnimationStyle

animationStyle current animation style

Inherited from

AbstractWellTrack.getAnimationStyle


getAutoModelLimitsMode

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

Returns

boolean

mode

Inherited from

AbstractWellTrack.getAutoModelLimitsMode


getAutoModelLimitsStrategy

getAutoModelLimitsStrategy(): ModelLimitsStrategy

Get Model Limits Logics Strategy

Returns

ModelLimitsStrategy

strategy

Inherited from

AbstractWellTrack.getAutoModelLimitsStrategy


getBaseLayer

getBaseLayer(index): Node

Return baseLayer at specified index

Parameters

Name Type Description
indexnumberindex at which to get the baseLayer for

Returns

Node

track

Inherited from

AbstractWellTrack.getBaseLayer


getBaseLayers

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

Return iterator by baseLayers nodes

Type parameters

NameType
Sextends Node<S>

Parameters

Name Type Description
predicate(value: Node) => value is Sa filter function
Optional modifybooleanAn option to specify if the iterator supports adding/removing items from the collection. false by default.

Returns

Iterator<Node>

Inherited from

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

Parameters

Name Type Description
Optional filter(node: Node) => booleanA filter function. Returns all overlays if null.
Optional modifybooleanAn option to specify if the iterator supports adding/removing items from the collection. false by default.

Returns

Iterator<Node>

An iterator for child overlays.

Inherited from

AbstractWellTrack.getBaseLayers


getBaseLayersCount

getBaseLayersCount(): number

Returns amount of baseLayers

Returns

number

Inherited from

AbstractWellTrack.getBaseLayersCount


getBounds

getBounds(): Rect

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

Returns

Rect

current bounds

Implementation of

IProxyWellTrack.getBounds

Inherited from

AbstractWellTrack.getBounds


getCache

getCache(): Cache

Return cache strategy to be used to cache children nodes

Returns

Cache

cache

Inherited from

AbstractWellTrack.getCache


getChild

getChild(i): Node

Return node by index

Parameters

Name Type Description
inumberindex of the node

Returns

Node

Inherited from

AbstractWellTrack.getChild


getChildren

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

Return iterator by child nodes

Type parameters

NameType
Sextends Node<S>

Parameters

Name Type Description
predicate(value: Node) => value is Sa filter function
Optional modifybooleanAn option to specify if the iterator supports adding/removing items from the collection. false by default.

Returns

Iterator<S>

Inherited from

AbstractWellTrack.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);

Parameters

Name Type Description
Optional filter(node: Node) => booleanA filter function. Returns all nodes if null.
Optional modifybooleanAn option to specify if the iterator supports adding/removing items from the collection. false by default.

Returns

Iterator<Node>

An iterator for child nodes.

Inherited from

AbstractWellTrack.getChildren


getChildrenCount

getChildrenCount(): number

Return number of child nodes

Returns

number

Inherited from

AbstractWellTrack.getChildrenCount


getClassName

getClassName(): string

Returns

string

Implementation of

IExportable.getClassName

Inherited from

AbstractWellTrack.getClassName


getClipStyle

getClipStyle(): ClipStyle

Gets the current clipping style

Returns

ClipStyle

clipping style

Inherited from

AbstractWellTrack.getClipStyle


getContentOrientation

getContentOrientation(): Orientation

Return content orientation

Returns

Orientation

content orientation

Inherited from

AbstractWellTrack.getContentOrientation


getContentsArea

getContentsArea(transformation?): Rect

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

Parameters

Name Type Description
Optional transformationTransformationscene transformation

Returns

Rect

Inherited from

AbstractWellTrack.getContentsArea


getContentsTransform

getContentsTransform(): Transformation

getContentsTransform() retrieves the world transformation of the node.

Returns

Transformation

transformation from model coordinates to bounds of the group

Inherited from

AbstractWellTrack.getContentsTransform


getCss

getCss(): CssStyle

Return CSS style

Returns

CssStyle

Inherited from

AbstractWellTrack.getCss


getCssClass

getCssClass(): string

Returns css class name to be used to apply CSS style

Returns

string

the css class name

Inherited from

AbstractWellTrack.getCssClass


getCssClasses

getCssClasses(): string[]

Gets list of css class names which applied to this node

Returns

string[]

Inherited from

AbstractWellTrack.getCssClasses


getCssTransform

getCssTransform(): string

Returns CSS transformation

Returns

string

Inherited from

AbstractWellTrack.getCssTransform


getData

getData(): AbstractDataTable | DataSource

Returns data source

Returns

AbstractDataTable | DataSource

Overrides

AbstractWellTrack.getData


getDataBinding

getDataBinding(): DataBinding

Return the data binding

Returns

DataBinding

Overrides

AbstractWellTrack.getDataBinding


getDepthLimits

getDepthLimits(): Range

Returns depth or time range

Returns

Range

Implementation of

IProxyWellTrack.getDepthLimits

Overrides

AbstractWellTrack.getDepthLimits


getDepthScale

getDepthScale(scaleUnit?, deviceUnit?): number

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

Example

//  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

Overrides

AbstractWellTrack.getDepthScale


getDesiredHeight

getDesiredHeight(): string | number

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

Returns

string | number

desired height ("undefined" by default)

Inherited from

AbstractWellTrack.getDesiredHeight


getDesiredWidth

getDesiredWidth(): number

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

Returns

number

desired width ("undefined" by default)

Overrides

AbstractWellTrack.getDesiredWidth


getDeviceLimits

getDeviceLimits(): Rect

Return device limits

Returns

Rect

Inherited from

AbstractWellTrack.getDeviceLimits


getDeviceUnit

getDeviceUnit(): AbstractUnit

Return a unit of the measure of device

Returns

AbstractUnit


getExportElement

getExportElement(): AbstractDocumentElement

Returns exportable element

Returns

AbstractDocumentElement

return exportable element

Implementation of

IExportable.getExportElement


getFillStyle

getFillStyle(): FillStyle

Return fill style

Returns

FillStyle

fillStyle current fill style

Inherited from

AbstractWellTrack.getFillStyle


getFooter

getFooter(): LogBaseTrackHeader

Return Proxy Well Footer

Returns

LogBaseTrackHeader


getHeader

getHeader(): LogBaseTrackHeader

Return Proxy Well Header

Returns

LogBaseTrackHeader


getId

getId(): string | number

Returns the associated identifier of the node

Returns

string | number

The node's id

Inherited from

AbstractWellTrack.getId


getInfiniteMode

getInfiniteMode(): boolean

Return infinity mode flag

Returns

boolean

flag

Inherited from

AbstractWellTrack.getInfiniteMode


getInvalidateMethod

Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

Returns

AttributeCallback<EventDispatcher>

method to invalidate this object

Inherited from

AbstractWellTrack.getInvalidateMethod


getLayout

getLayout(): Layout

Returns layout associated with the group

Returns

Layout

layout

Inherited from

AbstractWellTrack.getLayout


getLayoutStyle

getLayoutStyle(): LayoutStyle<string | number>

return desired layout style

Returns

LayoutStyle<string | number>

Implementation of

IProxyWellTrack.getLayoutStyle

Inherited from

AbstractWellTrack.getLayoutStyle


getLineStyle

getLineStyle(): LineStyle

Return border style

Returns

LineStyle

Inherited from

AbstractWellTrack.getLineStyle


getLocalTransform

getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Returns

Transformation

transform the local transform.

Inherited from

AbstractWellTrack.getLocalTransform


getManipulatorLayer

getManipulatorLayer(): Layer<Node>

Returns manipulator layer

Returns

Layer<Node>

layer

Implementation of

IProxyWellTrack.getManipulatorLayer

Overrides

AbstractWellTrack.getManipulatorLayer


getMarginsStyle

getMarginsStyle(): SpaceStyle<string | number>

Return margins style

Returns

SpaceStyle<string | number>

Inherited from

AbstractWellTrack.getMarginsStyle


getMarkerLayer

getMarkerLayer(): Layer<Node>

Return a layer to display markers

Returns

Layer<Node>

Overrides

AbstractWellTrack.getMarkerLayer


getModelLimits

getModelLimits(): Rect

Gets model limits, the limits of this groups inside space

Returns

Rect

the current model limits

Inherited from

AbstractWellTrack.getModelLimits


getName

getName(): string

Returns the node name

Returns

string

The node name

Inherited from

AbstractWellTrack.getName


getOpacity

getOpacity(): number

Returns current node opacity

Returns

number

opacity

Inherited from

AbstractWellTrack.getOpacity


getOpacityBlendMode

getOpacityBlendMode(): BlendMode

Returns current node opacity

Returns

BlendMode

opacity blend mode

Inherited from

AbstractWellTrack.getOpacityBlendMode


getOverlay

getOverlay(index): Node

Return overlay at specified index

Parameters

Name Type Description
indexnumberindex at which to get the overlay for

Returns

Node

track

Inherited from

AbstractWellTrack.getOverlay


getOverlayAt

getOverlayAt(index): Node

Return overlay at specified index

Deprecated

since 4.2 use getOverlay instead

Parameters

Name Type Description
indexnumberindex at which to get the overlay for

Returns

Node

track

Inherited from

AbstractWellTrack.getOverlayAt


getOverlays

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

Return iterator by overlays nodes

Type parameters

NameType
Sextends Node<S>

Parameters

Name Type Description
predicate(value: Node) => value is Sa filter function
Optional modifybooleanAn option to specify if the iterator supports adding/removing items from the collection. false by default.

Returns

Iterator<Node>

Inherited from

AbstractWellTrack.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);

Parameters

Name Type Description
Optional filter(node: Node) => booleanA filter function. Returns all overlays if null.
Optional modifybooleanAn option to specify if the iterator supports adding/removing items from the collection. false by default.

Returns

Iterator<Node>

An iterator for child overlays.

Inherited from

AbstractWellTrack.getOverlays


getOverlaysCount

getOverlaysCount(): number

Returns amount of overlays

Returns

number

Inherited from

AbstractWellTrack.getOverlaysCount


getPaddingStyle

getPaddingStyle(): SpaceStyle<string | number>

Return padding style

Returns

SpaceStyle<string | number>

padding

Inherited from

AbstractWellTrack.getPaddingStyle


getParent

getParent(): Node

Return parent node

Returns

Node

parent node

Inherited from

AbstractWellTrack.getParent


getPreferredSize

getPreferredSize(): Rect

Return preferred size to layout children

Returns

Rect

Inherited from

AbstractWellTrack.getPreferredSize


getProperties

getProperties(): OptionsOut

Gets all the properties pertaining to this object

Returns

OptionsOut

of this object

Overrides

AbstractWellTrack.getProperties


getProperty

getProperty(name): any

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

Parameters

Name Type Description
namestringproperty name

Returns

any

Inherited from

AbstractWellTrack.getProperty


getPropertyKeys

getPropertyKeys(): string[]

Returns known properties keys

Returns

string[]

Inherited from

AbstractWellTrack.getPropertyKeys


getPrototype

getPrototype(): LogTrack | WellTrack

Return a reference to template

Returns

LogTrack | WellTrack

track prototype

Implementation of

IProxyWellTrack.getPrototype


getRenderingFilter

getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

Returns

IFilter

current filter

Inherited from

AbstractWellTrack.getRenderingFilter


getResponsiveStyle

getResponsiveStyle(): ResponsiveStyle

Return responsive style

Returns

ResponsiveStyle

Inherited from

AbstractWellTrack.getResponsiveStyle


getRoot

getRoot(): Node

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

Returns

Node

the root node

Inherited from

AbstractWellTrack.getRoot


getScaleScrollStrategy

getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Returns

Delegate

scale scroll strategy

Inherited from

AbstractWellTrack.getScaleScrollStrategy


getScaleUnit

getScaleUnit(): AbstractUnit

Return unit of the measure to be used to display scale in the header

Returns

AbstractUnit


getSceneTransform

getSceneTransform(): Transformation

Returns transformation from node to root scene

Returns

Transformation

a transformation from node to root scene

Inherited from

AbstractWellTrack.getSceneTransform


getSelection

getSelection(): Node[]

Return the currently selected items

Returns

Node[]

array of selected object

Overrides

AbstractWellTrack.getSelection


getTag

getTag(): any

Returns the object associated with the node by user.

Returns

any

The node's user-object

Implementation of

IProxyWellTrack.getTag

Inherited from

AbstractWellTrack.getTag


getTitle

getTitle(): string

Return title

Returns

string

well title

Inherited from

AbstractWellTrack.getTitle


getTool

getTool(): CompositeTool

Returns root tool associated to this widget

Returns

CompositeTool

Implementation of

IProxyWellTrack.getTool


getToolByName

getToolByName(name): AbstractTool

Return tool by name

Parameters

Name Type Description
namestringname of the tool

Returns

AbstractTool


getTrack

getTrack(): LogTrack | WellTrack

Return track instance if any

Returns

LogTrack | WellTrack

Implementation of

IProxyWellTrack.getTrack


getVisible

getVisible(): boolean

Return visibility of the node

Returns

boolean

true if node is visible

Inherited from

AbstractWellTrack.getVisible


getVisibleDepthLimits

getVisibleDepthLimits(): Range

Return a depth range, which is visible now

Returns

Range

Implementation of

IProxyWellTrack.getVisibleDepthLimits

Overrides

AbstractWellTrack.getVisibleDepthLimits


getVisibleDeviceLimits

getVisibleDeviceLimits(ignoreModelLimits?): Rect

Return visible device limits

Parameters

Name Type Description
Optional ignoreModelLimitsbooleanflag defines whether to ignore ModelLimits or not

Returns

Rect

Inherited from

AbstractWellTrack.getVisibleDeviceLimits


getVisibleModelLimits

getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Parameters

Name Type Description
Optional ignoreModelLimitsbooleanflag defines whether to ignore ModelLimits or not

Returns

Rect

Inherited from

AbstractWellTrack.getVisibleModelLimits


getWidth

getWidth(): number

Returns well track width

Returns

number


getWorldTransform

getWorldTransform(): Transformation

Retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.

Returns

Transformation

Inherited from

AbstractWellTrack.getWorldTransform


getZIndex

getZIndex(): number

Returns node z-index (null if not set)

Returns

number

Inherited from

AbstractWellTrack.getZIndex


getZoneLayer

getZoneLayer(): Layer<Node>

Return a layer to display zones

Returns

Layer<Node>


hasCssClass

hasCssClass(cssClass): boolean

Check if node has specified css class

Parameters

Name Type Description
cssClassstringcss class name

Returns

boolean

Inherited from

AbstractWellTrack.hasCssClass


hasEventListener

hasEventListener(type, callback?): boolean

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

Parameters

Name Type Description
typestringtype of event or property
Optional callbackFunctionto be called, if null, check if any callback is registered

Returns

boolean

Inherited from

AbstractWellTrack.hasEventListener


indexOfBaseLayer

indexOfBaseLayer(baseLayer): number

Return index of overlay ( index of the specified child or -1 if baseLayer is not found)

Parameters

Name Type Description
baseLayerNodebaseLayer to check index

Returns

number

Inherited from

AbstractWellTrack.indexOfBaseLayer


indexOfChild

indexOfChild(node): number

Return index of child ( index of the specified child or -1 if node is not found)

Parameters

Name Type Description
nodeNodenode to check index

Returns

number

Inherited from

AbstractWellTrack.indexOfChild


indexOfOverlay

indexOfOverlay(overlay): number

Return index of overlay ( index of the specified child or -1 if overlay is not found)

Parameters

Name Type Description
overlayNodeoverlay to check index

Returns

number

Inherited from

AbstractWellTrack.indexOfOverlay


insertBaseLayer

insertBaseLayer(index, baseLayer): ProxyWellTrack

Insert child baseLayer at specified index

Parameters

Name Type Description
indexnumberspecified index
baseLayerNodea baseLayer to add

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.insertBaseLayer


insertChild

insertChild(index, node): ProxyWellTrack

Insert child node at specified index

Parameters

Name Type Description
indexnumberspecified index
nodeNodea child node to add

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.insertChild


insertOverlay

insertOverlay(index, overlay): ProxyWellTrack

Insert child overlay at specified index

Parameters

Name Type Description
indexnumberspecified index
overlayNodea overlay to add

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.insertOverlay


invalidate

invalidate(bounds?, force?): ProxyWellTrack

Invalidate node

Parameters

Name Type Description
Optional boundsRectoptional rectangular area to be invalidated, or force flag if rectangle is empty
Optional forcebooleanoptional boolean parameter that can force invalidation

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.invalidate


invalidateLayout

invalidateLayout(propagate?): ProxyWellTrack

Notify that layout is invalidated. Send event Events.LayoutInvalidated

Parameters

Name Type Description
Optional propagatebooleanpropagate invalidate layout to parent

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.invalidateLayout


invalidateParent

invalidateParent(bounds?, force?): ProxyWellTrack

Invalidate parent area

Parameters

Name Type Description
Optional boundsRectarea to invalidate
Optional forcebooleanforce

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.invalidateParent


isClippingEnabled

isClippingEnabled(): boolean

Returns if clipping is enabled or not for this node.

Returns

boolean

Inherited from

AbstractWellTrack.isClippingEnabled


isDisposed

isDisposed(): boolean

Returns whether this object has been disposed

Returns

boolean

Inherited from

AbstractWellTrack.isDisposed


isEventPropagationEnabled

isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

Returns

boolean

Inherited from

AbstractWellTrack.isEventPropagationEnabled


isHorizontalFlip

isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

Returns

boolean

flip

Inherited from

AbstractWellTrack.isHorizontalFlip


isLayoutInvalidated

isLayoutInvalidated(): boolean

Return true if layout is invalid

Returns

boolean

Inherited from

AbstractWellTrack.isLayoutInvalidated


isNavigationEnabled

isNavigationEnabled(): boolean

Return status of navigation tool after track instantiation

Returns

boolean


isNotificationEnabled

isNotificationEnabled(): boolean

return state of notification

Returns

boolean

current notification state

Inherited from

AbstractWellTrack.isNotificationEnabled


isPickingChildrenEnabled

isPickingChildrenEnabled(): boolean

Returns if picking children is enabled or not for this node.

Returns

boolean

pickingChildren

Inherited from

AbstractWellTrack.isPickingChildrenEnabled


isSelectable

isSelectable(): boolean

Returns true if node can be picked/selected.

Returns

boolean

The selectable flag

Inherited from

AbstractWellTrack.isSelectable


isSilent

isSilent(): boolean

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

Returns

boolean

Inherited from

AbstractWellTrack.isSilent


isVerticalFlip

isVerticalFlip(): boolean

Return true if the representation is flipped vertically

Returns

boolean

flip

Inherited from

AbstractWellTrack.isVerticalFlip


moveTo

moveTo(area, vAlign?, hAlign?): ProxyWellTrack

MoveTo position of node to specified area

Parameters

Name Type Description
areaRectspecified area
Optional vAlignstringvertical alignment. It can be "top", "bottom", "center".
Optional hAlignstringhorizontal alignment It can be "left", "right", "center".

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.moveTo


notify

notify<E>(type, source, args?): ProxyWellTrack

Notify listeners of the Node

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEtype of event
sourceProxyWellTracksource who called the event
Optional argsEventMap[E]event arguments

Returns

ProxyWellTrack

this

Overrides

AbstractWellTrack.notify


notifyRoot

Protected notifyRoot(event, source, args?): Node

Notify an even to root node

Parameters

Name Type Description
eventstringtype of event
sourceNodesource who called the event
Optional argsanyevent arguments

Returns

Node

this

Inherited from

AbstractWellTrack.notifyRoot


off

off<E>(type?, callback?): ProxyWellTrack

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.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
Optional typeEtype of the event
Optional callback(eventType: E, sender: ProxyWellTrack, args: EventMap[E]) => voidfunction to be called

Returns

ProxyWellTrack

this

Overrides

AbstractWellTrack.off


on

on<E>(type, callback): ProxyWellTrack

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.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEtype of event or property
callback(eventType: E, sender: ProxyWellTrack, args: EventMap[E]) => voidto be called

Returns

ProxyWellTrack

this

Overrides

AbstractWellTrack.on


onBoundsChanged

Protected onBoundsChanged(bounds): ProxyWellTrack

Occurs when bounds has been changed

Parameters

Name Type Description
boundsRectbound of the node in the parent coordinates

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.onBoundsChanged


onChildAdded

Protected onChildAdded(child): void

This method is called it child or children are added

Parameters

Name Type Description
childNode | Iterator<Node>added child

Returns

void

Inherited from

AbstractWellTrack.onChildAdded


onChildRemoved

Protected onChildRemoved(child): void

This method is called it child or children are removed

Parameters

Name Type Description
childNoderemoved child

Returns

void

Inherited from

AbstractWellTrack.onChildRemoved


onParentChanged

Protected onParentChanged(node): ProxyWellTrack

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

Parameters

Name Type Description
nodeNodenode to change parent

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.onParentChanged


onVisibilityChanged

Protected onVisibilityChanged(): void

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

Returns

void

Inherited from

AbstractWellTrack.onVisibilityChanged


onVisibleDepthLimitsChanged

Protected onVisibleDepthLimitsChanged(oldLimits, newLimits, visible): ProxyWellTrack

Raising an event 'visibleDepthLimitsChanged' eventName : (geotoolkit.welllog.widgets.Events.VisibleDepthLimitsChanged)

Parameters

Name Type Description
oldLimitsRangeold visible limits
newLimitsRangevisible limits
visiblebooleanvisibility

Returns

ProxyWellTrack

Inherited from

AbstractWellTrack.onVisibleDepthLimitsChanged


postRendering

Protected postRendering(context, callback?): void

To be called after rendering, used for PDF output

Parameters

Name Type Description
contextRenderingContextRendering Context
Optional callback() => voidcallback to be called after rendering

Returns

void

Inherited from

AbstractWellTrack.postRendering


preRendering

Protected preRendering(context, callback?): void

Occurs before child rendering

Parameters

Name Type Description
contextRenderingContextRendering Context
Optional callback() => voidcallback to be called after rendering of geometry

Returns

void

Inherited from

AbstractWellTrack.preRendering


rebuild

rebuild(force?, changes?): ProxyWellTrack

Rebuild node. This method resets state, cache, and invalidate node.

Parameters

Name Type Description
Optional forcebooleanoptional boolean parameter that can force invalidation
Optional changesStateChangesoptional parameter to specify a reason of changes

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.rebuild


registerAnimationStyle

registerAnimationStyle(root): void

Register animation style.

Parameters

Name Type Description
rootNoderoot node for node

Returns

void

Inherited from

AbstractWellTrack.registerAnimationStyle


removeBaseLayer

removeBaseLayer(baseLayer): ProxyWellTrack

Remove child baseLayer

Parameters

Name Type Description
baseLayerNode | Node[]baseLayer or array of nodes to be removed

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.removeBaseLayer


removeChild

removeChild(node, disposeChildren?): ProxyWellTrack

Remove child node

Parameters

Name Type Description
nodeNode | Node[]node or array of nodes to be removed
Optional disposeChildrenbooleanautomatically dispose children. If it is true then method dispose is called for each child.

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.removeChild


removeCssClass

removeCssClass(cssclass): ProxyWellTrack

Removes css class from node

Parameters

Name Type Description
cssclassstring | string[]css class name('s)

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.removeCssClass


removeInvalidateHandler

removeInvalidateHandler(handler): ProxyWellTrack

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

Parameters

Name Type Description
handlerFunctionhandler to be notified about invalidation

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.removeInvalidateHandler


removeOverlay

removeOverlay(overlay): ProxyWellTrack

Remove child overlay

Parameters

Name Type Description
overlayNode | Node[]overlay or array of nodes to be removed

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.removeOverlay


removeSelection

removeSelection(): ProxyWellTrack

Remove selection if it exists

Returns

ProxyWellTrack

this

Overrides

AbstractWellTrack.removeSelection


render

render(context): void

Render group

Parameters

Name Type Description
contextRenderingContextcontext to render group

Returns

void

Inherited from

AbstractWellTrack.render


renderAsync

renderAsync(context, callback): void

Render node in asynchronous mode. This implementation doesn't support cache for now.

Parameters

Name Type Description
contextRenderingContextThe rendering context to be used to draw the node
callback() => voidcallback function

Returns

void

Inherited from

AbstractWellTrack.renderAsync


renderBackground

Protected renderBackground(context, bounds): ProxyWellTrack

Render background

Parameters

Name Type Description
contextRenderingContextcontext to render background
boundsRectgroup bounds

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.renderBackground


renderBaseLayers

Protected renderBaseLayers(context): ProxyWellTrack

Render baseLayers on bottom of cache. This method does nothing, but can be implemented to render graphics on bottom of cache and between borders

Parameters

Name Type Description
contextRenderingContextcontext to render baseLayers

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.renderBaseLayers


renderBaseLayersAsync

Protected renderBaseLayersAsync(context, callback): void

Render baseLayers on bottom of cache in asynchronous mode. This method calls renderBaseLayers

Parameters

Name Type Description
contextRenderingContextcontext to render overlays
callback() => voidcallback function

Returns

void

Inherited from

AbstractWellTrack.renderBaseLayersAsync


renderChildren

Protected renderChildren(context): void

Render children

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

void

Inherited from

AbstractWellTrack.renderChildren


renderChildrenAsync

Protected renderChildrenAsync(context, callback): void

Render children async

Parameters

Name Type Description
contextRenderingContextRendering Context
callback() => voidcallback function to be called then all children are rendered

Returns

void

Inherited from

AbstractWellTrack.renderChildrenAsync


renderContent

Protected renderContent(context): void

render to specified context. This method calls preRendering, renderChildren, postRendering

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

void

Inherited from

AbstractWellTrack.renderContent


renderContentAsync

Protected renderContentAsync(context, callback): void

Render children in asynchronous mode

Parameters

Name Type Description
contextRenderingContextThe rendering context to be used to draw the node
callback() => voidcallback function to be called then all children are rendered

Returns

void

Inherited from

AbstractWellTrack.renderContentAsync


renderOverlays

Protected renderOverlays(context): ProxyWellTrack

Render overlays on top of cache. This method does nothing, but can be implemented to render graphics on top of cache and between borders

Parameters

Name Type Description
contextRenderingContextcontext to render overlays

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.renderOverlays


renderOverlaysAsync

Protected renderOverlaysAsync(context, callback): void

Render overlays on top of cache in asynchronous mode. This method calls renderOverlays

Parameters

Name Type Description
contextRenderingContextcontext to render overlays
callback() => voidcallback function

Returns

void

Inherited from

AbstractWellTrack.renderOverlaysAsync


resumeUpdate

resumeUpdate(rebuild?, changes?): ProxyWellTrack

Resume auto update

Parameters

Name Type Description
Optional rebuildbooleanforce rebuild
Optional changesStateChangesoptional parameter to specify a reason of changes

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.resumeUpdate


rotate

rotate(theta, x, y): ProxyWellTrack

Rotate bounds around a given coordinate

Parameters

Name Type Description
thetanumberangle to rotate node, in radians
xnumberx coordinate to rotate around
ynumbery coordinate to rotate around

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.rotate


scale

scale(xx, yy): ProxyWellTrack

Scale node

Parameters

Name Type Description
xxnumberx scale factor
yynumbery scale factor

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.scale


setAnimationStyle

setAnimationStyle(animationStyle): ProxyWellTrack

Sets animation style

Parameters

Name Type Description
animationStyleTypeanimation style

Returns

ProxyWellTrack

Inherited from

AbstractWellTrack.setAnimationStyle


setAutoModelLimitsMode

setAutoModelLimitsMode(mode): ProxyWellTrack

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

Parameters

Name Type Description
modebooleanModel Limits Logics to be used

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setAutoModelLimitsMode


setAutoModelLimitsStrategy

setAutoModelLimitsStrategy(strategy): ProxyWellTrack

Set Model Limits Logics Strategy

Parameters

Name Type Description
strategyModelLimitsStrategyModel Limits logic strategy to use

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setAutoModelLimitsStrategy


setBounds

setBounds(bounds): ProxyWellTrack

Set bounds of the well

Parameters

Name Type Description
boundsRecttrack bounds

Returns

ProxyWellTrack

Overrides

AbstractWellTrack.setBounds


setCache

setCache(cache, rebuild?): ProxyWellTrack

Sets cache to be used to cache

Parameters

Name Type Description
cacheCachecache to be used
Optional rebuildbooleanrebuild cache

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setCache


setChild

setChild(index, node): ProxyWellTrack

Replace child node by index

Parameters

Name Type Description
indexnumberindex of the node
nodeNodenode

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setChild


setClipStyle

setClipStyle(style): ProxyWellTrack

Sets a new clipping style

Parameters

Name Type Description
styleGraphicsPath | ClipStyle | Optionsa new clipping style

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setClipStyle


setContentOrientation

setContentOrientation(orientation): ProxyWellTrack

Set content orientation

Parameters

Name Type Description
orientationOrientationcontent orientation

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setContentOrientation


setCss

setCss(style, merge?): ProxyWellTrack

Sets CSS style. This style will be applied for all inserted elements

Parameters

Name Type Description
styleTypeCSS style to be applied to inserted elements
Optional mergebooleanmerge flag

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setCss


setCssClass

setCssClass(name): ProxyWellTrack

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

Parameters

Name Type Description
namestringcss class name of the node

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setCssClass


setCssTransform

setCssTransform(transform): ProxyWellTrack

Set CSS transformation

Parameters

Name Type Description
transformstring | Transformationtransformation css transformation instruction or Transformation instance

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setCssTransform


setData

setData(data): ProxyWellTrack

Sets a new data source

Parameters

Name Type Description
dataAbstractDataTable | DataSourcedata source

Returns

ProxyWellTrack

this


setDataBinding

setDataBinding(binding, silent?): ProxyWellTrack

Sets the data binding

Parameters

Name Type Description
bindingDataBindingdata binding
Optional silentbooleansilent mode to forbid

Returns

ProxyWellTrack

this


setDepthLimits

setDepthLimits(minIndex, maxIndex): ProxyWellTrack

Sets model minimum and maximum depth

Parameters

Name Type Description
minIndexnumbermin index limit
maxIndexnumbermax index limit

Returns

ProxyWellTrack

setDepthLimits(range): ProxyWellTrack

Sets depth limits for all tracks

Parameters

Name Type Description
rangeRangedepth range

Returns

ProxyWellTrack


setDepthScale

setDepthScale(scale, scaleUnit?, deviceUnit?): ProxyWellTrack

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

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

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setDepthScale


setDesiredHeight

setDesiredHeight(value, silent?): ProxyWellTrack

Sets desired height of the group as a layoutable object

Parameters

Name Type Description
valuestring | numberdesired height to set, use 'auto' for automatic desired height
Optional silentbooleansilent setting

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setDesiredHeight


setDesiredWidth

setDesiredWidth(value, silent?): ProxyWellTrack

Sets desired width of the group as a layoutable object

Parameters

Name Type Description
valuestring | numberdesired width to set
Optional silentbooleansilent setting

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setDesiredWidth


setDeviceUnit

setDeviceUnit(unit): ProxyWellTrack

Sets unit of the measure to be used for device

Parameters

Name Type Description
unitstring | AbstractUnitunit of the device

Returns

ProxyWellTrack

this


setFillStyle

setFillStyle(fillStyle, merge?): ProxyWellTrack

Sets fill style

Parameters

Name Type Description
fillStyleTypea new fill style
Optional mergebooleantrue if you want to merge fillStyle with existing attribute, false by default

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setFillStyle


setHorizontalFlip

setHorizontalFlip(enable): ProxyWellTrack

Set horizontal flip of the representation

Parameters

Name Type Description
enablebooleanenable flip

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setHorizontalFlip


setId

setId(id): ProxyWellTrack

Allows the user to associate any identifier

Parameters

Name Type Description
idstring | numberobject id

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setId


setInfiniteMode

setInfiniteMode(infinityMode): ProxyWellTrack

Set infinity mode flag to draw composite without collision check

Parameters

Name Type Description
infinityModebooleaninfinity mode flag

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setInfiniteMode


setLayout

setLayout(layout): ProxyWellTrack

Associate layout with a group.

Parameters

Name Type Description
layoutRecord<string, any> | Layoutlayout instance to be set or layout properties to apply

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setLayout


setLayoutInvalidated

Protected setLayoutInvalidated(invalidated): void

Set invalidation status

Parameters

Name Type Description
invalidatedbooleaninvalidated layout

Returns

void

Inherited from

AbstractWellTrack.setLayoutInvalidated


setLayoutStyle

setLayoutStyle(layoutStyle, silent?, merge?): ProxyWellTrack

specify desired layout style

Parameters

Name Type Description
layoutStyleLayoutStyle<string | number> | Options<string | number>desired layout style
Optional silentbooleansilent setting
Optional mergebooleantrue if you want to merge layoutStyle with existing attribute, false by default

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setLayoutStyle


setLineStyle

setLineStyle(lineStyle, merge?): ProxyWellTrack

Sets border color Returns this

Parameters

Name Type Description
lineStyleTypeline style or options
Optional mergebooleantrue if you want to merge lineStyle with existing attribute, false by default

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setLineStyle


setLocalTransform

setLocalTransform(localTransform, force?): ProxyWellTrack

Sets local transformation to be used to transform from local to parent coordinate

Parameters

Name Type Description
localTransformTransformationlocal transformation for this node
Optional forcebooleanboolean flag to force update event if transformations are equal, false by default

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setLocalTransform


setMarginsStyle

setMarginsStyle(margins, merge?): ProxyWellTrack

Sets margins style

Parameters

Name Type Description
marginsType<string | number>margins style
Optional mergebooleantrue if you want to merge marginsStyle with existing attribute, false by default

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setMarginsStyle


setModelLimits

setModelLimits(limits): ProxyWellTrack

Sets inner model limits

Parameters

Name Type Description
limitsTypeinner limits

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setModelLimits


setName

setName(name): ProxyWellTrack

Sets name of the node

Parameters

Name Type Description
namestringThe node name

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setName


setNotification

setNotification(notify, force?): ProxyWellTrack

set notification state

Parameters

Name Type Description
notifybooleanflag set to invalidate parent or not
Optional forcebooleantrue if parent should be invalidated immediately

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setNotification


setOpacity

setOpacity(opacity, blendMode?): ProxyWellTrack

Sets node opacity

Parameters

Name Type Description
opacitynumbernode opacity from 0 to 1
Optional blendModeBlendModeopacity blend mode. If it is normal, opacity will be replaced.

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setOpacity


setPaddingStyle

setPaddingStyle(paddingStyle, merge?): ProxyWellTrack

Sets padding style

Parameters

Name Type Description
paddingStyleType<string | number>padding style
Optional mergebooleantrue if you want to merge paddingStyle with existing attribute, false by default

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setPaddingStyle


setProperties

setProperties(properties?): ProxyWellTrack

Sets all the properties pertaining to this object

Parameters

Name Type Description
Optional propertiesOptionsAn object containing the properties to set

Returns

ProxyWellTrack

this

Overrides

AbstractWellTrack.setProperties


setProperty

setProperty(name, value): ProxyWellTrack

Sets dynamic property by name

Parameters

Name Type Description
namestringproperty name
valueanyproperty value

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setProperty


setPrototype

setPrototype(template): ProxyWellTrack

Set track template

Parameters

Name Type Description
templateLogTrack | WellTracktrack to be used as a template

Returns

ProxyWellTrack


setRenderingFilter

setRenderingFilter(filter): ProxyWellTrack

Sets filter to be applied before rendering and picking

Parameters

Name Type Description
filterIFilterfilter to set

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setRenderingFilter


setResponsiveStyle

setResponsiveStyle(style): ProxyWellTrack

Sets responsive style.

Parameters

Name Type Description
styleOptions | ResponsiveStyleresponsive style

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setResponsiveStyle


setScaleScrollStrategy

setScaleScrollStrategy(strategy?): ProxyWellTrack

Sets scale scroll strategy

Parameters

Name Type Description
Optional strategyDelegatescale scroll strategy

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setScaleScrollStrategy


setScaleUnit

setScaleUnit(unit): ProxyWellTrack

Sets unit of the measure to be used to display scale in the header

Parameters

Name Type Description
unitstring | AbstractUnita scale unit or string symbol

Returns

ProxyWellTrack

this


setSelectable

setSelectable(selectable): ProxyWellTrack

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

Parameters

Name Type Description
selectablebooleanflag to allow node selection

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setSelectable


setSilent

setSilent(bool): ProxyWellTrack

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setSilent


setTag

setTag(tag): ProxyWellTrack

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

Parameters

Name Type Description
taganyThe object to be associated with the node.

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setTag


setTitle

setTitle(title): ProxyWellTrack

Sets well title

Parameters

Name Type Description
titlestringwell title

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setTitle


setVerticalFlip

setVerticalFlip(flip): ProxyWellTrack

Set vertical flip of the representation

Parameters

Name Type Description
flipbooleanflag to set the vertical flip of the representation

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setVerticalFlip


setVisible

setVisible(value): ProxyWellTrack

Sets visibility of the node. Send event Events.VisibilityChanged

Parameters

Name Type Description
valuebooleanflag specifying visibility of the node

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setVisible


setVisibleDepthLimits

setVisibleDepthLimits(fromIndex, toIndex?): ProxyWellTrack

Sets visible depth limits

Example

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

Parameters

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

Returns

ProxyWellTrack

Inherited from

AbstractWellTrack.setVisibleDepthLimits

setVisibleDepthLimits(fromIndex, toIndex, fitHeight?): ProxyWellTrack

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

Parameters

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

Returns

ProxyWellTrack

Inherited from

AbstractWellTrack.setVisibleDepthLimits


setVisibleModelLimits

setVisibleModelLimits(visibleModelBounds, deviceBounds?): ProxyWellTrack

Set visible model limits

Parameters

Name Type Description
visibleModelBoundsRectvisible model limits or bounds
Optional deviceBoundsRectdevice bounds

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setVisibleModelLimits


setZIndex

setZIndex(value): ProxyWellTrack

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

Parameters

Name Type Description
valuenumberindex determining node z-position

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.setZIndex


shear

shear(shx, shy): ProxyWellTrack

Shear this node's bounds

Parameters

Name Type Description
shxnumberx-axis shear
shynumbery-axis shear

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.shear


suspendUpdate

suspendUpdate(): ProxyWellTrack

Suspend auto update

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.suspendUpdate


toString

toString(): string

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

Returns

string

A string representation

Inherited from

AbstractWellTrack.toString


translate

translate(tx, ty): ProxyWellTrack

Translate bounds

Parameters

Name Type Description
txnumberx translation
tynumbery translation

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.translate


unregisterAnimationStyle

unregisterAnimationStyle(root): void

Unregister animation style.

Parameters

Name Type Description
rootAnimatedNoderoot node for node

Returns

void

Inherited from

AbstractWellTrack.unregisterAnimationStyle


updateAdornments

updateAdornments(): void

Update adornments

Returns

void


updateLayout

updateLayout(targets?): ProxyWellTrack

Updates layout(s)

Fires

Events.LayoutUpdated

Parameters

Name Type Description
Optional targetsILayoutable[]optional parameter about which element to layout

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.updateLayout


updateSceneTransformation

updateSceneTransformation(): ProxyWellTrack

Update scene transformation

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.updateSceneTransformation


updateState

updateState(regions?, changes?): ProxyWellTrack

Mark this group to be updated.

Parameters

Name Type Description
Optional regionsRect[]optional array to return invalid rectangles
Optional changesStateChangesoptional parameter to specify a reason of changes

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.updateState


updateSuspended

updateSuspended(): boolean

Return state of suspend state

Returns

boolean

state of update

Inherited from

AbstractWellTrack.updateSuspended


updateTimeStamp

Protected updateTimeStamp(): ProxyWellTrack

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

Returns

ProxyWellTrack

this

Inherited from

AbstractWellTrack.updateTimeStamp


enableSceneGraphNotification

Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

Parameters

Name Type Description
enabledbooleansets if this object sends notifications

Returns

void

Inherited from

AbstractWellTrack.enableSceneGraphNotification


findParent

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

Find root of the node with specified type

Type parameters

NameType
Textends Constructor<any>

Parameters

Name Type Description
nodeNodenode to start search
classTypeTtype of the class to search for
Optional filter(node: Node) => booleanadditional filter to apply

Returns

InstanceType<T>

Inherited from

AbstractWellTrack.findParent

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

Find root of the node with specified type

Parameters

Name Type Description
nodeNodenode to start search
classTypestringinterface name to search for
Optional filter(node: Node) => booleanadditional filter to apply

Returns

Node

Inherited from

AbstractWellTrack.findParent


getClassName

Static getClassName(): string

Returns

string

Inherited from

AbstractWellTrack.getClassName


isSceneGraphNotificationEnabled

Static isSceneGraphNotificationEnabled(): boolean

Return status of the global notification for all nodes.

Returns

boolean

Inherited from

AbstractWellTrack.isSceneGraphNotificationEnabled