Class: LogTrackContainer

• new LogTrackContainer(options)

• new LogTrackContainer(options?)

TrackContainer.constructor

▸ addBaseLayer(baseLayer): LogTrackContainer

Add baseLayer to container

LogTrackContainer

this

TrackContainer.addBaseLayer

▸ addChild(node): LogTrackContainer

Add a child node

LogTrackContainer

this

TrackContainer.addChild

▸ addCssClass(cssclass): LogTrackContainer

Adds new css class to node

LogTrackContainer

this

TrackContainer.addCssClass

▸ addInvalidateHandler(handler): LogTrackContainer

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

LogTrackContainer

this

TrackContainer.addInvalidateHandler

▸ addLayer(layer): LogTrackContainer

Add layer or layer collection to container

LogTrackContainer

this

▸ addOverlay(overlay): LogTrackContainer

Add overlay to container

LogTrackContainer

this

TrackContainer.addOverlay

▸ addTrack(track): LogTrackContainer

Add track to container

LogTrackContainer

▸ adjustPosition(area?, vAlign?, hAlign?): LogTrackContainer

Adjust position of node to specified area

LogTrackContainer

this

TrackContainer.adjustPosition

▸ Protected applyOpacity(context): LogTrackContainer

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

LogTrackContainer

this

TrackContainer.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

TrackContainer.applyResponsiveStyle

▸ changeBaseLayerOrder(overlay, order, anchor?): LogTrackContainer

Changes the z-order of the baseLayer.

LogTrackContainer

this

TrackContainer.changeBaseLayerOrder

▸ changeChildOrder(node, order, anchor?): LogTrackContainer

changes the z-order of the nodes being rendered.

LogTrackContainer

this

TrackContainer.changeChildOrder

▸ changeOverlayOrder(overlay, order, anchor?): LogTrackContainer

Changes the z-order of the overlay.

LogTrackContainer

this

TrackContainer.changeOverlayOrder

▸ changeTrackOrder(track, order, anchor?): LogTrackContainer

changes the layout order of the tracks being rendered.

LogTrackContainer

this

▸ checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

boolean

true if node is collided

TrackContainer.checkCollision

▸ clearBaseLayers(disposeBaseLayers?): LogTrackContainer

Remove all child baseLayers from group

LogTrackContainer

this

TrackContainer.clearBaseLayers

▸ clearCache(): LogTrackContainer

Clear cache

LogTrackContainer

this

TrackContainer.clearCache

▸ clearChildren(disposeChildren?): LogTrackContainer

Remove all child nodes from this composite group

LogTrackContainer

this

TrackContainer.clearChildren

▸ clearLayers(disposeLayers?): LogTrackContainer

Remove all child layers from container

LogTrackContainer

this

▸ clearOverlays(disposeOverlays?): LogTrackContainer

Remove all child overlays from group

LogTrackContainer

this

TrackContainer.clearOverlays

▸ clearTracks(disposeTracks?): LogTrackContainer

Remove all tracks from this container

LogTrackContainer

this

▸ clone(): LogTrackContainer

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

LogTrackContainer

clone

TrackContainer.clone

▸ connectStyle(style, type, callback): LogTrackContainer

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

LogTrackContainer

this

TrackContainer.connectStyle

▸ Protected copyConstructor(src, deepCopy?): LogTrackContainer

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

LogTrackContainer

this

TrackContainer.copyConstructor

▸ disconnectStyle(style, type, callback): LogTrackContainer

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

LogTrackContainer

this

TrackContainer.disconnectStyle

▸ dispose(): void

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

void

TrackContainer.dispose

▸ Protected drawBorder(localContext, bounds?): LogTrackContainer

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

LogTrackContainer

this

TrackContainer.drawBorder

▸ enableClipping(doClip): LogTrackContainer

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

LogTrackContainer

this

TrackContainer.enableClipping

▸ enableEventPropagation(enable): LogTrackContainer

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

LogTrackContainer

this

TrackContainer.enableEventPropagation

▸ enablePickingChildren(enable): LogTrackContainer

Enables or disables picking children

LogTrackContainer

this

TrackContainer.enablePickingChildren

▸ enumerateNodes(callback, target?): void

Executes a provided function once for each child node

void

TrackContainer.enumerateNodes

▸ execute(delegate): LogTrackContainer

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

LogTrackContainer

The result if any or this

TrackContainer.execute

▸ execute<T>(delegate): T

T

TrackContainer.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

TrackContainer.filter

▸ forEachVisual(callback): void

Enumerate each visual in track container

void

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

TrackContainer.getAnimationStyle

▸ getAutoModelLimitsMode(): boolean

Get Model Limits Logics to use when no Model Limits have been set set to true: will use parents width and height, starting at 0 set to false: will use parents bounds

boolean

mode

TrackContainer.getAutoModelLimitsMode

▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy

Get Model Limits Logics Strategy

ModelLimitsStrategy

strategy

TrackContainer.getAutoModelLimitsStrategy

▸ getBaseLayer(index): Node

Return baseLayer at specified index

Node

track

TrackContainer.getBaseLayer

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

Return iterator by baseLayers nodes

Iterator<Node>

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

Iterator<Node>

An iterator for child overlays.

TrackContainer.getBaseLayers

▸ getBaseLayersCount(): number

Returns amount of baseLayers

number

TrackContainer.getBaseLayersCount

▸ getBounds(): Rect

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

Rect

current bounds

TrackContainer.getBounds

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache

TrackContainer.getCache

▸ getChild(i): Node

Return node by index

Node

TrackContainer.getChild

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

Return iterator by child nodes

Iterator<S>

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

Iterator<Node>

An iterator for child nodes.

TrackContainer.getChildren

▸ getChildrenCount(): number

Return number of child nodes

number

TrackContainer.getChildrenCount

▸ getClassName(): string

string

TrackContainer.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

TrackContainer.getClipStyle

▸ getContentOrientation(): Orientation

Return content orientation

Orientation

content orientation

TrackContainer.getContentOrientation

▸ getContentsArea(transformation?): Rect

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

Rect

TrackContainer.getContentsArea

▸ getContentsTransform(): Transformation

getContentsTransform() retrieves the world transformation of the node.

Transformation

transformation from model coordinates to bounds of the group

TrackContainer.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

TrackContainer.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

TrackContainer.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

TrackContainer.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

TrackContainer.getCssTransform

▸ getData(): AbstractDataTable | DataSource

returns data source

AbstractDataTable | DataSource

▸ getDataBinding(): DataBinding | DataBindingRegistry

Return the data binding

DataBinding | DataBindingRegistry

▸ getDepthLimits(): Range

Returns depth range

Range

TrackContainer.getDepthLimits

▸ getDesiredHeight(): string | number

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

string | number

desired height ("undefined" by default)

TrackContainer.getDesiredHeight

▸ getDesiredWidth(): string | number

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

string | number

desired width ("undefined" by default)

TrackContainer.getDesiredWidth

▸ getDeviceLimits(): Rect

Return device limits

Rect

TrackContainer.getDeviceLimits

▸ getDeviceUnit(): AbstractUnit

Return a unit of the measure of device

AbstractUnit

TrackContainer.getDeviceUnit

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

TrackContainer.getFillStyle

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

TrackContainer.getId

▸ getIndent(): number

Return indent between tracks

number

▸ getIndexUnit(): AbstractUnit

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

AbstractUnit

TrackContainer.getIndexUnit

▸ getInfiniteMode(): boolean

Return infinity mode flag

boolean

flag

TrackContainer.getInfiniteMode

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

TrackContainer.getInvalidateMethod

▸ getLayer(index): CompositeNode<Node>

Return layer at specified index

CompositeNode<Node>

track

▸ getLayerAt(index): CompositeNode<Node>

Return layer at specified index

Deprecated

since 4.2 use getLayer(index) instead

CompositeNode<Node>

track

▸ getLayers(filter?, modify?): Iterator<Node>

Return iterator by overlays nodes

Iterator<Node>

▸ getLayersCount(): number

Returns amount of layers

number

▸ getLayout(): Layout

Returns layout associated with the group

Layout

layout

TrackContainer.getLayout

▸ getLayoutStyle(): LayoutStyle<string | number>

return desired layout style

LayoutStyle<string | number>

TrackContainer.getLayoutStyle

▸ getLineStyle(): LineStyle

Return border style

LineStyle

TrackContainer.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

TrackContainer.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

TrackContainer.getMarginsStyle

▸ getMaxWidth(track?): string | number

Returns the maximum width of a track

string | number

▸ getMinWidth(track?): string | number

Returns the minimum width of a track

string | number

▸ getModelLimits(): Rect

Gets model limits, the limits of this groups inside space

Rect

the current model limits

TrackContainer.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

TrackContainer.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

TrackContainer.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

TrackContainer.getOpacityBlendMode

▸ getOutline(tr): Polygon

Gets node outline

Polygon

ITransformable.getOutline

▸ getOverlay(index): Node

Return overlay at specified index

Node

track

TrackContainer.getOverlay

▸ getOverlayAt(index): Node

Return overlay at specified index

Deprecated

since 4.2 use getOverlay instead

Node

track

TrackContainer.getOverlayAt

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

Return iterator by overlays nodes

Iterator<Node>

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

Iterator<Node>

An iterator for child overlays.

TrackContainer.getOverlays

▸ getOverlaysCount(): number

Returns amount of overlays

number

TrackContainer.getOverlaysCount

▸ getPaddingStyle(): SpaceStyle<string | number>

Return padding style

SpaceStyle<string | number>

padding

TrackContainer.getPaddingStyle

▸ getParent(): Node

Return parent node

Node

parent node

TrackContainer.getParent

▸ getPreferredSize(): Rect

Return preferred size to layout children

Rect

TrackContainer.getPreferredSize

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties object

TrackContainer.getProperties

▸ getProperty(name): any

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

any

TrackContainer.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

TrackContainer.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

TrackContainer.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

TrackContainer.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

TrackContainer.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

TrackContainer.getScaleScrollStrategy

▸ getScaleUnit(): AbstractUnit

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

Deprecated

since 4.1 Use getIndexUnit instead

AbstractUnit

TrackContainer.getScaleUnit

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

TrackContainer.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

TrackContainer.getTag

▸ getTrack(index): LogTrack

Return track at specified index

LogTrack

track

▸ getTrackAt(index): LogTrack

Return track at specified index

Deprecated

since 4.2 use getTrack instead

LogTrack

track

▸ getTrackAtPosition(x, gap): LogTrack | { left?: LogTrack ; right?: LogTrack }

Find nearest track at specified {number} x-coordinate

LogTrack | { left?: LogTrack ; right?: LogTrack }

▸ getTrackFactory(): TrackFactory

Returns track factory

TrackFactory

track factory

▸ getTrackIndex(track): number

return index of track

Deprecated

since 4.2 use indexOfTrack instead

number

index of the track

▸ getTracks(filter?, modify?): Iterator<LogTrack>

Return iterator by child tracks

Iterator<LogTrack>

▸ getTracksCount(): number

Returns amount of tracks

number

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

TrackContainer.getVisible

▸ getVisibleDepthLimits(): Range

Returns visible depth range

Range

TrackContainer.getVisibleDepthLimits

▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect

Return visible device limits

Rect

TrackContainer.getVisibleDeviceLimits

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

TrackContainer.getVisibleModelLimits

▸ getWorldTransform(): Transformation

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

Transformation

TrackContainer.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

TrackContainer.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

TrackContainer.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

TrackContainer.hasEventListener

▸ hitTest(area, radius?): CollapsedInterval[]

Hit test in the device coordinates

CollapsedInterval[]

a collection of selected nodes

▸ indexOfBaseLayer(baseLayer): number

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

number

TrackContainer.indexOfBaseLayer

▸ indexOfChild(node): number

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

number

TrackContainer.indexOfChild

▸ indexOfLayer(node): number

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

number

▸ indexOfOverlay(overlay): number

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

number

TrackContainer.indexOfOverlay

▸ indexOfTrack(track): number

return index of track

number

index of the track

▸ insertBaseLayer(index, baseLayer): LogTrackContainer

Insert child baseLayer at specified index

LogTrackContainer

this

TrackContainer.insertBaseLayer

▸ insertChild(index, node): LogTrackContainer

Insert child node at specified index

LogTrackContainer

this

TrackContainer.insertChild

▸ insertOverlay(index, overlay): LogTrackContainer

Insert child overlay at specified index

LogTrackContainer

this

TrackContainer.insertOverlay

▸ insertTrack(index, track): LogTrack

Insert a track

Example

import {TrackType} from '@int/geotoolkit/welllog/TrackType';
widget.addTrack(TrackType.LinearTrack);

Example

// index tracks has 'INDEX_TRACK' css class defined, so it can be used to modify style with css:
widget.getTrackContainer().setCss('*[cssclass="INDEX_TRACK"] { visible: false; }');
// or differ it from another tracks:
if (track.getCssClass() === 'INDEX_TRACK') {
// do smth
}