Last updated

API / geotoolkit / welllog / LogTrack / LogTrack

Class: LogTrack

welllog.LogTrack.LogTrack

The LogTrack is a generic container of Well elements like logcurves, log-axis, log-images, etc. It can be used for various purposes like DepthIndex, TimeIndex or a plain LogCurve container.
For example, one could add Axis to a log track to create an index-track, Or add a LogLog10ValueGrid to create a logarithmic display.
Track it this is not linear or logarithmic, you can mix regular curve and logarithmic in linear track and logarithmic curve with regular in logarithmic track.

Options in the constructor are used to manipulate other properties like border,bounds. A combination of tracks can be displayed by using TrackContainer.
To add a curve to the track simply use track.addChild(curve)
The children are displayed in order you add it in to the track so if you add curve and then lithology, then lithology will be above curve.

The track has model coordinates ranging from [0, 1] in the horizontal direction and spans from minimum depth to maximum depth in the vertical direction.

Example

// To change the order you can remove child and add it again or use:
track.changeChildOrder(curve, NodeOrder.Last); // Please see CompositeNode#changeChildOrder documentation

Example

import {CssStyle} from '@int/geotoolkit/css/CssStyle';
// to modify properties of the border using css.
const css = [
'.geotoolkit.welllog.LogTrack {',
'   border-linestyle-color: red;',
'   border-linestyle-width: 2;',
'}',
].join('\n');
track.setCss(new CssStyle({'css': css}));

Example

// This example shows how to reorganize children in a particular track.
import {from} from '@int/geotoolkit/selection/from';
import {LogCurve} from '@int/geotoolkit/welllog/LogCurve';
import {NodeOrder} from '@int/geotoolkit/scene/CompositeNode';
from(linearTrack)
.where( (node) => node instanceof LogCurve })
.selectToArray()
.forEach((logCurve) => {
logCurve.getTrack().changeChildOrder(logCurve, NodeOrder.Last);
});
widget.getTrackHeader(linearTrack).rebuild();

Hierarchy

Implements

Table of contents

Constructors
Methods
addBaseLayeraddChildaddCssClass
addInvalidateHandleraddOverlayadjustPosition
applyOpacityapplyResponsiveStyleasNode
calculateDataLimitschangeBaseLayerOrderchangeChildOrder
changeOverlayOrdercheckCollisionclearBaseLayers
clearChildrenclearOverlaysclone
connectStylecopyConstructordisconnectStyle
disposeenableClippingenableEventPropagation
enumerateNodesexecutefillHighlight
filtergetAnimationStylegetBaseLayer
getBaseLayersgetBaseLayersCountgetBlock
getBordergetBordersgetBounds
getChildgetChildrengetChildrenCount
getClassNamegetClipStylegetContentsArea
getContentsTransformgetCssgetCssClass
getCssClassesgetCssTransformgetDataLimits
getDepthLimitsgetDeviceLimitsgetFillStyle
getFootergetHeadergetId
getInfiniteModegetInvalidateMethodgetLayoutStyle
getLineStylegetLocalTransformgetMarginsStyle
getModelLimitsgetNamegetOpacity
getOpacityBlendModegetOverlaygetOverlayAt
getOverlaysgetOverlaysCountgetParent
getPropertiesgetPropertygetPropertyKeys
getRenderingFiltergetResponsiveStylegetRoot
getScaleScrollStrategygetSceneTransformgetTag
getTrackContainergetUnitInfogetVisible
getVisibleDepthLimitsgetVisibleDeviceLimitsgetVisibleModelLimits
getWidthgetWorldTransformgetZIndex
hasCssClasshasEventListenerindexOfBaseLayer
indexOfChildindexOfOverlayinsertBaseLayer
insertChildinsertOverlayinvalidate
invalidateLayoutinvalidateParentisClippingEnabled
isDisposedisEventPropagationEnabledisHorizontalFlip
isLayoutInvalidatedisNotificationEnabledisSelectable
isSilentisVerticalFlipmoveTo
notifynotifyRootoff
ononChildAddedonChildRemoved
onParentChangedonVisibilityChangedpostRendering
preRenderingregisterAnimationStyleremoveBaseLayer
removeChildremoveCssClassremoveInvalidateHandler
removeOverlayrenderrenderAsync
renderBaseLayersrenderBaseLayersAsyncrenderChildren
renderChildrenAsyncrenderContentrenderContentAsync
renderHighlightrenderOverlaysrenderOverlaysAsync
rotatescalesetAnimationStyle
setBorderssetBoundssetChild
setClipStylesetCsssetCssClass
setCssTransformsetDepthLimitssetFillStyle
setHorizontalFlipsetIdsetInfiniteMode
setLayoutInvalidatedsetLayoutStylesetLineStyle
setLocalTransformsetMarginsStylesetName
setNotificationsetOpacitysetProperties
setPropertysetRenderingFiltersetResponsiveStyle
setScaleScrollStrategysetSelectablesetSilent
setTagsetUnitInfosetVisible
setVisibleModelLimitssetWidthsetZIndex
shearstrokeHighlighttoString
translateunregisterAnimationStyleupdateContentsTransform
updateSceneTransformationupdateStateupdateTimeStamp
createLogOverlayenableSceneGraphNotificationfindParent
getClassNameisSceneGraphNotificationEnabled
Css Properties
Name Type Description
backgroundcolorstringBackground color fill style
backgroundcolorFillStyleBackground color fill style
backgroundcolor-colorstringColor in CSS form
backgroundcolor-evenoddmodebooleanEven-odd fill mode
backgroundcolor-fillpatternPatternPattern
backgroundcolor-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
backgroundcolor-fillpattern-patternnamestringName of this pattern for indexing
backgroundcolor-fillpattern-scalablebooleanFlag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported)
backgroundcolor-foregroundstringForeground color
backgroundcolor-patternPatternPattern
borderBorderOutline of the track
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-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-cssclassstringThe css class name of this node
border-csscursorstringCSS cursor associated with node
border-cssstylestringCSS style to be applied to inserted elements
border-fillstylestringStyle applied on fill
border-fillstyleFillStyleStyle applied on fill
border-idstring | numberId of the node, its a unique identifier
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
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
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-namestringName of the node. It is often used for debugging purposes or to simplify queries
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-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-transformstringAdditional CSS transformation applied to node or 'none'
border-transformTransformationAdditional CSS transformation applied to node or 'none'
border-visiblebooleanVisibility of the node, a boolean to determine if the node should be rendered or not
border-z-indexnumberDefine node z-index
borderstrategyBorderStrategyStrategy on how to display the border of the track
boundsRectBounds of the visual
clippingbooleanEnable clipping, this does not consider the clipstyle, it is related to bounds-clipping
clipstyleClipStyleClipping style
clipstyleGraphicsPathClipping style
cssclassstringThe css class name of this node
csscursorstringCSS cursor associated with node
cssstylestringCSS style to be applied to inserted elements
fillstylestringBackground color fill style (alias for backgroundcolor)
fillstyleFillStyleBackground color fill style (alias for backgroundcolor)
highlightBorderHighlight outline of the track
highlightstrategyTrackHighlightStrategyTrack highlight strategy
idstring | numberId of the node, its a unique identifier
infinitybooleanMode to render outside the model limits
limitsRectModel limits
linestylestringLine style or options
linestyleLineStyleLine style or options
localtransformTransformationLocal transformation
logblockLogBlockLog block
logblock-autoboundsbooleanEnables or disables auto bounds
logblock-basenamestringThe base name
logblock-boundsRectThe rectangle specifying position of the visual in the track. If set, autobounds will be switched off
logblock-clipstyleClipStyleClipping style
logblock-clipstyleGraphicsPathClipping style
logblock-cssclassstringThe css class name of this node
logblock-csscursorstringCSS cursor associated with node
logblock-cssstylestringCSS style to be applied to inserted elements
logblock-descriptionstringThe description
logblock-fillstylestringThe fill style
logblock-fillstyleFillStyleThe fill style
logblock-idstring | numberId of the node, its a unique identifier
logblock-linestylestringLinestyle
logblock-linestyleLineStyleLinestyle
logblock-localtransformTransformationLocal transformation
logblock-marginsnumber | stringIt has properties for specifying the margins for each side
logblock-microposleftnumberLeft micro position
logblock-microposrightnumberRight micro position
logblock-namestringName of the node. It is often used for debugging purposes or to simplify queries
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
logblock-opacityblendmodeBlendModeNode opacity mode to blend it
logblock-positionPositionPosition (left or right or both)
logblock-scalescrollstrategyScaleScrollStrategyScale scroll strategy
logblock-selectablebooleanSelectable node, a boolean to determine if selection should consider this node
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
logblock-transformstringAdditional CSS transformation applied to node or 'none'
logblock-transformTransformationAdditional CSS transformation applied to node or 'none'
logblock-visiblebooleanVisibility of the node, a boolean to determine if the node should be rendered or not
logblock-z-indexnumberDefine node z-index
marginsnumber | stringIt has properties for specifying the margins for each side
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
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
transformstringAdditional CSS transformation applied to node or 'none'
transformTransformationAdditional CSS transformation applied to node or 'none'
visiblebooleanVisibility of the node, a boolean to determine if the node should be rendered or not
z-indexnumberDefine node z-index

Contents

Constructors

new LogTrack(options)

new LogTrack(options?)

Parameters

Name Type
Optional optionsOptions

Overrides

LayeredNode.constructor

Methods

addBaseLayer

addBaseLayer(baseLayer): LogTrack

Add baseLayer to container

Parameters

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

Returns

LogTrack

this

Inherited from

LayeredNode.addBaseLayer


addChild

addChild(node): LogTrack

Add a child node

Parameters

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

Returns

LogTrack

this

Inherited from

LayeredNode.addChild


addCssClass

addCssClass(cssclass): LogTrack

Adds new css class to node

Parameters

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

Returns

LogTrack

this

Inherited from

LayeredNode.addCssClass


addInvalidateHandler

addInvalidateHandler(handler): LogTrack

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

Parameters

Name Type Description
handlerFunctionhandler to be notified about invalidation

Returns

LogTrack

this

Inherited from

LayeredNode.addInvalidateHandler


addOverlay

addOverlay(overlay): LogTrack

Add overlay to container

Parameters

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

Returns

LogTrack

this

Inherited from

LayeredNode.addOverlay


adjustPosition

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

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

LogTrack

this

Inherited from

LayeredNode.adjustPosition


applyOpacity

Protected applyOpacity(context): LogTrack

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

LogTrack

this

Inherited from

LayeredNode.applyOpacity


applyResponsiveStyle

Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

Returns

void

Inherited from

LayeredNode.applyResponsiveStyle


asNode

asNode(): Node

Return track as Node instance

Returns

Node

Implementation of

ITrack.asNode


calculateDataLimits

Protected calculateDataLimits(fullLimits?): Range

Parameters

Name Type
Optional fullLimitsboolean

Returns

Range


changeBaseLayerOrder

changeBaseLayerOrder(overlay, order, anchor?): LogTrack

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

LogTrack

this

Inherited from

LayeredNode.changeBaseLayerOrder


changeChildOrder

changeChildOrder(node, order, anchor?): LogTrack

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

LogTrack

this

Inherited from

LayeredNode.changeChildOrder


changeOverlayOrder

changeOverlayOrder(overlay, order, anchor?): LogTrack

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

LogTrack

this

Inherited from

LayeredNode.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

LayeredNode.checkCollision


clearBaseLayers

clearBaseLayers(disposeBaseLayers?): LogTrack

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

LogTrack

this

Inherited from

LayeredNode.clearBaseLayers


clearChildren

clearChildren(disposeChildren?): LogTrack

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

LogTrack

this

Inherited from

LayeredNode.clearChildren


clearOverlays

clearOverlays(disposeOverlays?): LogTrack

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

LogTrack

this

Inherited from

LayeredNode.clearOverlays


clone

clone(): LogTrack

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

Returns

LogTrack

clone

Overrides

LayeredNode.clone


connectStyle

connectStyle(style, type, callback): LogTrack

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

LogTrack

this

Inherited from

LayeredNode.connectStyle


copyConstructor

Protected copyConstructor(src, deepCopy?): LogTrack

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
srcLogTrackSource to copy from
Optional deepCopybooleandeep copy

Returns

LogTrack

this

Overrides

LayeredNode.copyConstructor


disconnectStyle

disconnectStyle(style, type, callback): LogTrack

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

LogTrack

this

Inherited from

LayeredNode.disconnectStyle


dispose

dispose(): void

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

Returns

void

Inherited from

LayeredNode.dispose


enableClipping

enableClipping(doClip): LogTrack

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

LogTrack

this

Inherited from

LayeredNode.enableClipping


enableEventPropagation

enableEventPropagation(enable): LogTrack

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

LogTrack

this

Inherited from

LayeredNode.enableEventPropagation


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

LayeredNode.enumerateNodes


execute

execute(delegate): LogTrack

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: LogTrack) => voidFunction to execute

Returns

LogTrack

The result if any or this

Inherited from

LayeredNode.execute

execute<T>(delegate): T

Type parameters

Name
T

Parameters

Name Type
delegate(this: LogTrack) => T

Returns

T

Inherited from

LayeredNode.execute


fillHighlight

Protected fillHighlight(context, callback?): LogTrack

Render highlight background

Parameters

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

Returns

LogTrack

this


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

LayeredNode.filter


getAnimationStyle

getAnimationStyle(): AnimationStyle

Return animation style

Returns

AnimationStyle

animationStyle current animation style

Inherited from

LayeredNode.getAnimationStyle


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

LayeredNode.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

LayeredNode.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

LayeredNode.getBaseLayers


getBaseLayersCount

getBaseLayersCount(): number

Returns amount of baseLayers

Returns

number

Inherited from

LayeredNode.getBaseLayersCount


getBlock

getBlock(): LogBlock

Return log block

Returns

LogBlock


getBorder

getBorder(): Border

return border visual

Returns

Border

border


getBorders

getBorders(): Visible

Return an object where it is possible to specify the visibility of each border

Returns

Visible


getBounds

getBounds(): Rect

Gets bounds in the parent coordinates

Returns

Rect

Implementation of

ILayoutable.getBounds

Inherited from

LayeredNode.getBounds


getChild

getChild(i): Node

Return node by index

Parameters

Name Type Description
inumberindex of the node

Returns

Node

Inherited from

LayeredNode.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

LayeredNode.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

LayeredNode.getChildren


getChildrenCount

getChildrenCount(): number

Return number of child nodes

Returns

number

Inherited from

LayeredNode.getChildrenCount


getClassName

getClassName(): string

Returns

string

Inherited from

LayeredNode.getClassName


getClipStyle

getClipStyle(): ClipStyle

Gets the current clipping style

Returns

ClipStyle

clipping style

Inherited from

LayeredNode.getClipStyle


getContentsArea

getContentsArea(transformation?): Rect

Return area of content. By default it is equal to bounds.

Parameters

Name Type Description
Optional transformationTransformationscene transformation

Returns

Rect

Inherited from

LayeredNode.getContentsArea


getContentsTransform

getContentsTransform(): Transformation

Transformation of inner contents to content area

Returns

Transformation

Inherited from

LayeredNode.getContentsTransform


getCss

getCss(): CssStyle

Return CSS style

Returns

CssStyle

Inherited from

LayeredNode.getCss


getCssClass

getCssClass(): string

Returns css class name to be used to apply CSS style

Returns

string

the css class name

Inherited from

LayeredNode.getCssClass


getCssClasses

getCssClasses(): string[]

Gets list of css class names which applied to this node

Returns

string[]

Inherited from

LayeredNode.getCssClasses


getCssTransform

getCssTransform(): string

Returns CSS transformation

Returns

string

Inherited from

LayeredNode.getCssTransform


getDataLimits

getDataLimits(fullLimits?): Range

Return data limits

Parameters

Name Type Description
Optional fullLimitsbooleandefault value is false, true if you want to get full limits including trail NaN values

Returns

Range


getDepthLimits

getDepthLimits(): Range

Returns depth range

Returns

Range

Implementation of

ITrack.getDepthLimits


getDeviceLimits

getDeviceLimits(): Rect

Return device limits

Returns

Rect

Inherited from

LayeredNode.getDeviceLimits


getFillStyle

getFillStyle(): FillStyle

Return background color

Returns

FillStyle


getFooter

getFooter(): LogTrackHeader

Returns the track footer if it exists

Returns

LogTrackHeader


getHeader

getHeader(): LogTrackHeader

Returns the track header if it exists

Returns

LogTrackHeader


getId

getId(): string | number

Returns the associated identifier of the node

Returns

string | number

The node's id

Inherited from

LayeredNode.getId


getInfiniteMode

getInfiniteMode(): boolean

Return infinity mode flag

Returns

boolean

flag

Inherited from

LayeredNode.getInfiniteMode


getInvalidateMethod

Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

Returns

AttributeCallback<EventDispatcher>

method to invalidate this object

Inherited from

LayeredNode.getInvalidateMethod


getLayoutStyle

getLayoutStyle(): LayoutStyle<string | number>

Return desired layout style

Returns

LayoutStyle<string | number>

Implementation of

ILayoutable.getLayoutStyle


getLineStyle

getLineStyle(): LineStyle

Return border style

Returns

LineStyle


getLocalTransform

getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Returns

Transformation

transform the local transform.

Inherited from

LayeredNode.getLocalTransform


getMarginsStyle

getMarginsStyle(): SpaceStyle<string | number>

Return margins style

Returns

SpaceStyle<string | number>

Inherited from

LayeredNode.getMarginsStyle


getModelLimits

getModelLimits(): Rect

Returns model limits

Returns

Rect

Overrides

LayeredNode.getModelLimits


getName

getName(): string

Returns the node name

Returns

string

The node name

Inherited from

LayeredNode.getName


getOpacity

getOpacity(): number

Returns current node opacity

Returns

number

opacity

Inherited from

LayeredNode.getOpacity


getOpacityBlendMode

getOpacityBlendMode(): BlendMode

Returns current node opacity

Returns

BlendMode

opacity blend mode

Inherited from

LayeredNode.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

LayeredNode.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

LayeredNode.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

LayeredNode.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

LayeredNode.getOverlays


getOverlaysCount

getOverlaysCount(): number

Returns amount of overlays

Returns

number

Inherited from

LayeredNode.getOverlaysCount


getParent

getParent(): Node

Return parent node

Returns

Node

parent node

Implementation of

ILayoutable.getParent

Inherited from

LayeredNode.getParent


getProperties

getProperties(): OptionsOut

Gets all the properties pertaining to this object

Returns

OptionsOut

An object containing the properties to set

Overrides

LayeredNode.getProperties

getProperties(context): DeserializationOptionsOut

Parameters

Name Type
contextISerializationContext

Returns

DeserializationOptionsOut

Overrides

LayeredNode.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

LayeredNode.getProperty


getPropertyKeys

getPropertyKeys(): string[]

Returns known properties keys

Returns

string[]

Inherited from

LayeredNode.getPropertyKeys


getRenderingFilter

getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

Returns

IFilter

current filter

Inherited from

LayeredNode.getRenderingFilter


getResponsiveStyle

getResponsiveStyle(): ResponsiveStyle

Return responsive style

Returns

ResponsiveStyle

Inherited from

LayeredNode.getResponsiveStyle


getRoot

getRoot(): Node

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

Returns

Node

the root node

Inherited from

LayeredNode.getRoot


getScaleScrollStrategy

getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Returns

Delegate

scale scroll strategy

Inherited from

LayeredNode.getScaleScrollStrategy


getSceneTransform

getSceneTransform(): Transformation

Returns transformation from node to root scene

Returns

Transformation

a transformation from node to root scene

Inherited from

LayeredNode.getSceneTransform


getTag

getTag(): any

Returns the object associated with the node by user.

Returns

any

The node's user-object

Implementation of

ITrack.getTag

Inherited from

LayeredNode.getTag


getTrackContainer

getTrackContainer(): TrackContainer

Return parent track container or null

Returns

TrackContainer


getUnitInfo

getUnitInfo(): IUnitInfo

Returns an object that has getDeviceUnit and getScaleUnit functions

Returns

IUnitInfo


getVisible

getVisible(): boolean

Return visibility of the node

Returns

boolean

true if node is visible

Inherited from

LayeredNode.getVisible


getVisibleDepthLimits

getVisibleDepthLimits(): Range

Returns visible depth range

Returns

Range

Implementation of

ITrack.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

LayeredNode.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

LayeredNode.getVisibleModelLimits


getWidth

getWidth(): number

Returns 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

LayeredNode.getWorldTransform


getZIndex

getZIndex(): number

Returns node z-index (null if not set)

Returns

number

Inherited from

LayeredNode.getZIndex


hasCssClass

hasCssClass(cssClass): boolean

Check if node has specified css class

Parameters

Name Type Description
cssClassstringcss class name

Returns

boolean

Inherited from

LayeredNode.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

LayeredNode.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

LayeredNode.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

LayeredNode.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

LayeredNode.indexOfOverlay


insertBaseLayer

insertBaseLayer(index, baseLayer): LogTrack

Insert child baseLayer at specified index

Parameters

Name Type Description
indexnumberspecified index
baseLayerNodea baseLayer to add

Returns

LogTrack

this

Inherited from

LayeredNode.insertBaseLayer


insertChild

insertChild(index, node): LogTrack

Insert child node at specified index

Parameters

Name Type Description
indexnumberspecified index
nodeNodea child node to add

Returns

LogTrack

this

Inherited from

LayeredNode.insertChild


insertOverlay

insertOverlay(index, overlay): LogTrack

Insert child overlay at specified index

Parameters

Name Type Description
indexnumberspecified index
overlayNodea overlay to add

Returns

LogTrack

this

Inherited from

LayeredNode.insertOverlay


invalidate

invalidate(bounds?, force?): LogTrack

Invalidate area of the shape. This method invalidates parent by default. invalidated from parent to root node.

Parameters

Name Type Description
Optional boundsRectbounds of the invalid rectangle in the inner node coordinates
Optional forcebooleantrue if parent should be invalidated immediately if null is provided then cache (if any will be completely refreshed) otherwise only specified rect or node.bounds will be refreshed

Returns

LogTrack

this

Inherited from

LayeredNode.invalidate


invalidateLayout

invalidateLayout(propagate?): LogTrack

Invalidate layout

Parameters

Name Type Description
Optional propagatebooleanpropagate

Returns

LogTrack

this


invalidateParent

invalidateParent(bounds?, force?): LogTrack

Invalidate bounds

Parameters

Name Type Description
Optional boundsRectif null is provided then cache (if any will be completely refreshed) otherwise only specified rect or node.bounds will be refreshed
Optional forcebooleanforce invalidation

Returns

LogTrack

this

Overrides

LayeredNode.invalidateParent


isClippingEnabled

isClippingEnabled(): boolean

Returns if clipping is enabled or not for this node.

Returns

boolean

Inherited from

LayeredNode.isClippingEnabled


isDisposed

isDisposed(): boolean

Returns whether this object has been disposed

Returns

boolean

Inherited from

LayeredNode.isDisposed


isEventPropagationEnabled

isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

Returns

boolean

Inherited from

LayeredNode.isEventPropagationEnabled


isHorizontalFlip

isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

Returns

boolean

horizontal flip

Overrides

LayeredNode.isHorizontalFlip


isLayoutInvalidated

isLayoutInvalidated(): boolean

Return true if layout is invalid

Returns

boolean


isNotificationEnabled

isNotificationEnabled(): boolean

return state of notification

Returns

boolean

current notification state

Inherited from

LayeredNode.isNotificationEnabled


isSelectable

isSelectable(): boolean

Returns true if node can be picked/selected.

Returns

boolean

The selectable flag

Inherited from

LayeredNode.isSelectable


isSilent

isSilent(): boolean

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

Returns

boolean

Inherited from

LayeredNode.isSilent


isVerticalFlip

isVerticalFlip(): boolean

Return true if the representation is flipped vertically

Returns

boolean

Inherited from

LayeredNode.isVerticalFlip


moveTo

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

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

LogTrack

this

Inherited from

LayeredNode.moveTo


notify

notify<E>(event, source, args?): LogTrack

Notify listeners of the Node

Type parameters

NameType
Eextends string

Parameters

Name Type Description
eventEtype of event
sourceLogTracksource who called the event
Optional argsEventMap[E]event arguments

Returns

LogTrack

this

Overrides

LayeredNode.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

LayeredNode.notifyRoot


off

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

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: LogTrack, args: EventMap[E]) => voidfunction to be called

Returns

LogTrack

this

Overrides

LayeredNode.off


on

on<E>(type, callback): LogTrack

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: LogTrack, args: EventMap[E]) => voidto be called

Returns

LogTrack

this

Overrides

LayeredNode.on


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

LayeredNode.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

LayeredNode.onChildRemoved


onParentChanged

Protected onParentChanged(node): LogTrack

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

Parameters

Name Type Description
nodeNodenode to change parent

Returns

LogTrack

this

Inherited from

LayeredNode.onParentChanged


onVisibilityChanged

Protected onVisibilityChanged(): void

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

Returns

void

Inherited from

LayeredNode.onVisibilityChanged


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

LayeredNode.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

LayeredNode.preRendering


registerAnimationStyle

registerAnimationStyle(root): void

Register animation style.

Parameters

Name Type Description
rootNoderoot node for node

Returns

void

Inherited from

LayeredNode.registerAnimationStyle


removeBaseLayer

removeBaseLayer(baseLayer): LogTrack

Remove child baseLayer

Parameters

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

Returns

LogTrack

this

Inherited from

LayeredNode.removeBaseLayer


removeChild

removeChild(node, disposeChildren?): LogTrack

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

LogTrack

this

Inherited from

LayeredNode.removeChild


removeCssClass

removeCssClass(cssclass): LogTrack

Removes css class from node

Parameters

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

Returns

LogTrack

this

Inherited from

LayeredNode.removeCssClass


removeInvalidateHandler

removeInvalidateHandler(handler): LogTrack

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

Parameters

Name Type Description
handlerFunctionhandler to be notified about invalidation

Returns

LogTrack

this

Inherited from

LayeredNode.removeInvalidateHandler


removeOverlay

removeOverlay(overlay): LogTrack

Remove child overlay

Parameters

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

Returns

LogTrack

this

Inherited from

LayeredNode.removeOverlay


render

render(context): void

Render composite node and children

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

void

Inherited from

LayeredNode.render


renderAsync

renderAsync(context, callback): void

Render node in asynchronous mode

Parameters

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

Returns

void

Inherited from

LayeredNode.renderAsync


renderBaseLayers

Protected renderBaseLayers(context): LogTrack

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

LogTrack

this

Inherited from

LayeredNode.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

LayeredNode.renderBaseLayersAsync


renderChildren

Protected renderChildren(context): void

Render children

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

void

Inherited from

LayeredNode.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

LayeredNode.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

LayeredNode.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

LayeredNode.renderContentAsync


renderHighlight

Protected renderHighlight(context, callback?): LogTrack

Render highlight shape

Parameters

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

Returns

LogTrack

this


renderOverlays

Protected renderOverlays(context): LogTrack

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

LogTrack

this

Inherited from

LayeredNode.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

LayeredNode.renderOverlaysAsync


rotate

rotate(theta, x, y): LogTrack

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

LogTrack

this

Inherited from

LayeredNode.rotate


scale

scale(xx, yy): LogTrack

Scale node

Parameters

Name Type Description
xxnumberx scale factor
yynumbery scale factor

Returns

LogTrack

this

Inherited from

LayeredNode.scale


setAnimationStyle

setAnimationStyle(animationStyle): LogTrack

Sets animation style

Parameters

Name Type Description
animationStyleTypeanimation style

Returns

LogTrack

Inherited from

LayeredNode.setAnimationStyle


setBorders

setBorders(borders): LogTrack

set borders state

Parameters

Name Type Description
bordersVisibleborders

Returns

LogTrack


setBounds

setBounds(bounds): LogTrack

Sets bounds of the node in the parent coordinates

Parameters

Name Type Description
boundsRectbound of the node in the parent coordinates

Returns

LogTrack

this

Implementation of

ILayoutable.setBounds


setChild

setChild(index, node): LogTrack

Replace child node by index

Parameters

Name Type Description
indexnumberindex of the node
nodeNodenode

Returns

LogTrack

this

Inherited from

LayeredNode.setChild


setClipStyle

setClipStyle(style): LogTrack

Sets a new clipping style

Parameters

Name Type Description
styleGraphicsPath | ClipStyle | Optionsa new clipping style

Returns

LogTrack

this

Inherited from

LayeredNode.setClipStyle


setCss

setCss(style, merge?): LogTrack

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

LogTrack

this

Inherited from

LayeredNode.setCss


setCssClass

setCssClass(name): LogTrack

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

LogTrack

this

Inherited from

LayeredNode.setCssClass


setCssTransform

setCssTransform(transform): LogTrack

Set CSS transformation

Parameters

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

Returns

LogTrack

this

Inherited from

LayeredNode.setCssTransform


setDepthLimits

setDepthLimits(range): LogTrack

Sets model depth range

Parameters

Name Type Description
rangeRangea new depth range

Returns

LogTrack

this

setDepthLimits(minDepth, maxDepth): LogTrack

Sets model minimum and maximum depth

Parameters

Name Type Description
minDepthnumberminimum depth
maxDepthnumbermaximum depth

Returns

LogTrack

this


setFillStyle

setFillStyle(fillStyle, merge?): LogTrack

Sets background fill style Returns this track

Parameters

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

Returns

LogTrack


setHorizontalFlip

setHorizontalFlip(enable): LogTrack

Set horizontal flip of the representation

Parameters

Name Type Description
enablebooleanenable flip

Returns

LogTrack

this


setId

setId(id): LogTrack

Allows the user to associate any identifier

Parameters

Name Type Description
idstring | numberobject id

Returns

LogTrack

this

Inherited from

LayeredNode.setId


setInfiniteMode

setInfiniteMode(infinityMode): LogTrack

Set infinity mode flag to draw composite without collision check

Parameters

Name Type Description
infinityModebooleaninfinity mode flag

Returns

LogTrack

this

Inherited from

LayeredNode.setInfiniteMode


setLayoutInvalidated

Protected setLayoutInvalidated(invalidated): void

Set invalidation status

Parameters

Name Type Description
invalidatedbooleaninvalidated layout

Returns

void


setLayoutStyle

setLayoutStyle(layoutStyle, merge?): LogTrack

Specify desired layout style

Parameters

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

Returns

LogTrack


setLineStyle

setLineStyle(lineStyle, merge?): LogTrack

Sets border color Returns this track

Parameters

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

Returns

LogTrack

this


setLocalTransform

setLocalTransform(localTransform, force?): LogTrack

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

LogTrack

this

Inherited from

LayeredNode.setLocalTransform


setMarginsStyle

setMarginsStyle(margins, merge?): LogTrack

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

LogTrack

this

Inherited from

LayeredNode.setMarginsStyle


setName

setName(name): LogTrack

Sets name of the node

Parameters

Name Type Description
namestringThe node name

Returns

LogTrack

this

Inherited from

LayeredNode.setName


setNotification

setNotification(notify, force?): LogTrack

set notification state

Parameters

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

Returns

LogTrack

this

Inherited from

LayeredNode.setNotification


setOpacity

setOpacity(opacity, blendMode?): LogTrack

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

LogTrack

this

Inherited from

LayeredNode.setOpacity


setProperties

setProperties(properties?): LogTrack

Sets all the properties pertaining to this object

Parameters

Name Type Description
Optional propertiesOptionsAn object containing the properties to set

Returns

LogTrack

this

Overrides

LayeredNode.setProperties


setProperty

setProperty(name, value): LogTrack

Sets dynamic property by name

Parameters

Name Type Description
namestringproperty name
valueanyproperty value

Returns

LogTrack

this

Inherited from

LayeredNode.setProperty


setRenderingFilter

setRenderingFilter(filter): LogTrack

Sets filter to be applied before rendering and picking

Parameters

Name Type Description
filterIFilterfilter to set

Returns

LogTrack

this

Inherited from

LayeredNode.setRenderingFilter


setResponsiveStyle

setResponsiveStyle(style): LogTrack

Sets responsive style.

Parameters

Name Type Description
styleOptions | ResponsiveStyleresponsive style

Returns

LogTrack

this

Inherited from

LayeredNode.setResponsiveStyle


setScaleScrollStrategy

setScaleScrollStrategy(strategy?): LogTrack

Sets scale scroll strategy

Parameters

Name Type Description
Optional strategyDelegatescale scroll strategy

Returns

LogTrack

this

Inherited from

LayeredNode.setScaleScrollStrategy


setSelectable

setSelectable(selectable): LogTrack

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

LogTrack

this

Inherited from

LayeredNode.setSelectable


setSilent

setSilent(bool): LogTrack

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

LogTrack

this

Inherited from

LayeredNode.setSilent


setTag

setTag(tag): LogTrack

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

Parameters

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

Returns

LogTrack

this

Inherited from

LayeredNode.setTag


setUnitInfo

setUnitInfo(unitInfo): LogTrack

Sets the track's unit info object, which holds getDeviceUnit and getScaleUnit functions

Parameters

Name Type Description
unitInfoIUnitInfotrack's unit info - device unit and the scaled unit

Returns

LogTrack

this


setVisible

setVisible(value): LogTrack

Sets visibility of the node. Send event Events.VisibilityChanged

Parameters

Name Type Description
valuebooleanflag specifying visibility of the node

Returns

LogTrack

this

Inherited from

LayeredNode.setVisible


setVisibleModelLimits

setVisibleModelLimits(visibleModelBounds, deviceBounds?): LogTrack

Set visible model limits

Parameters

Name Type Description
visibleModelBoundsRectvisible model limits or bounds
Optional deviceBoundsRectdevice bounds

Returns

LogTrack

this

Inherited from

LayeredNode.setVisibleModelLimits


setWidth

setWidth(width): LogTrack

Set track width and layout remains tracks

Parameters

Name Type Description
widthnumbera new track width

Returns

LogTrack

this


setZIndex

setZIndex(value): LogTrack

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

Parameters

Name Type Description
valuenumberindex determining node z-position

Returns

LogTrack

this

Inherited from

LayeredNode.setZIndex


shear

shear(shx, shy): LogTrack

Shear this node's bounds

Parameters

Name Type Description
shxnumberx-axis shear
shynumbery-axis shear

Returns

LogTrack

this

Inherited from

LayeredNode.shear


strokeHighlight

Protected strokeHighlight(context, callback?): LogTrack

Render highlight border

Parameters

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

Returns

LogTrack

this


toString

toString(): string

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

Returns

string

A string representation

Inherited from

LayeredNode.toString


translate

translate(tx, ty): LogTrack

Translate bounds

Parameters

Name Type Description
txnumberx translation
tynumbery translation

Returns

LogTrack

this

Inherited from

LayeredNode.translate


unregisterAnimationStyle

unregisterAnimationStyle(root): void

Unregister animation style.

Parameters

Name Type Description
rootAnimatedNoderoot node for node

Returns

void

Inherited from

LayeredNode.unregisterAnimationStyle


updateContentsTransform

updateContentsTransform(): void

Returns

void


updateSceneTransformation

updateSceneTransformation(): LogTrack

Update scene transformation

Returns

LogTrack

this

Inherited from

LayeredNode.updateSceneTransformation


updateState

updateState(regions?, changes?): LogTrack

Update state. These methods reset node state and update state for children. this method is useful to refresh a scene graph

Parameters

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

Returns

LogTrack

this

Inherited from

LayeredNode.updateState


updateTimeStamp

Protected updateTimeStamp(): LogTrack

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

Returns

LogTrack

this

Inherited from

LayeredNode.updateTimeStamp


createLogOverlay

Static createLogOverlay(name, type?): Layer<Node>

Create a new layer, which always has coordinates from 0 to 1 in horizontal direction by default

Parameters

Name Type Description
namestringname of the layer
Optional typeLayerTypelayer type

Returns

Layer<Node>

overlay


enableSceneGraphNotification

Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

Parameters

Name Type Description
enabledbooleansets if this object sends notifications

Returns

void

Inherited from

LayeredNode.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

LayeredNode.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

LayeredNode.findParent


getClassName

Static getClassName(): string

Returns

string

Inherited from

LayeredNode.getClassName


isSceneGraphNotificationEnabled

Static isSceneGraphNotificationEnabled(): boolean

Return status of the global notification for all nodes.

Returns

boolean

Inherited from

LayeredNode.isSceneGraphNotificationEnabled