Class: StackedTrack

• new StackedTrack(options)

• new StackedTrack(options?)

LogTrack.constructor

▸ addBaseLayer(baseLayer): StackedTrack

Add baseLayer to container

StackedTrack

this

LogTrack.addBaseLayer

▸ addChild(node): StackedTrack

Add a child node

StackedTrack

this

LogTrack.addChild

▸ addCssClass(cssclass): StackedTrack

Adds new css class to node

StackedTrack

this

LogTrack.addCssClass

▸ addInvalidateHandler(handler): StackedTrack

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

StackedTrack

this

LogTrack.addInvalidateHandler

▸ addOverlay(overlay): StackedTrack

Add overlay to container

StackedTrack

this

LogTrack.addOverlay

▸ addTrack(track): LogTrack | LogTrack[]

Add a track

Throws

Will throw an error if the track is not specified

LogTrack | LogTrack[]

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

Adjust position of node to specified area

StackedTrack

this

LogTrack.adjustPosition

▸ Protected applyOpacity(context): StackedTrack

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

StackedTrack

this

LogTrack.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

LogTrack.applyResponsiveStyle

▸ asNode(): Node

Return track as Node instance

Node

LogTrack.asNode

▸ Protected calculateDataLimits(fullLimits?): Range

Return meaning data limits

Range

LogTrack.calculateDataLimits

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

Changes the z-order of the baseLayer.

StackedTrack

this

LogTrack.changeBaseLayerOrder

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

changes the z-order of the nodes being rendered.

StackedTrack

this

LogTrack.changeChildOrder

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

Changes the z-order of the overlay.

StackedTrack

this

LogTrack.changeOverlayOrder

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

changes the layout order of the tracks being rendered.

StackedTrack

this

▸ checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

boolean

true if node is collided

LogTrack.checkCollision

▸ clearBaseLayers(disposeBaseLayers?): StackedTrack

Remove all child baseLayers from group

StackedTrack

this

LogTrack.clearBaseLayers

▸ clearChildren(disposeChildren?): StackedTrack

Remove all child nodes from this composite group

StackedTrack

this

LogTrack.clearChildren

▸ clearOverlays(disposeOverlays?): StackedTrack

Remove all child overlays from group

StackedTrack

this

LogTrack.clearOverlays

▸ clearTracks(disposeTracks?): StackedTrack

Remove all tracks from this widget

StackedTrack

this

▸ clone(): StackedTrack

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

StackedTrack

clone

LogTrack.clone

▸ connectStyle(style, type, callback): StackedTrack

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

StackedTrack

this

LogTrack.connectStyle

▸ Protected copyConstructor(src, deepCopy?): StackedTrack

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

StackedTrack

this

LogTrack.copyConstructor

▸ disconnectStyle(style, type, callback): StackedTrack

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

StackedTrack

this

LogTrack.disconnectStyle

▸ dispose(): void

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

void

LogTrack.dispose

▸ enableClipping(doClip): StackedTrack

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

StackedTrack

this

LogTrack.enableClipping

▸ enableEventPropagation(enable): StackedTrack

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

StackedTrack

this

LogTrack.enableEventPropagation

▸ enumerateNodes(callback, target?): void

Executes a provided function once for each child node

void

LogTrack.enumerateNodes

▸ execute(delegate): StackedTrack

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

StackedTrack

The result if any or this

LogTrack.execute

▸ execute<T>(delegate): T

T

LogTrack.execute

▸ Protected fillHighlight(context, callback?): StackedTrack

Render highlight background

StackedTrack

this

LogTrack.fillHighlight

▸ Protected filter(context): boolean

Filter node

boolean

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

LogTrack.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

LogTrack.getAnimationStyle

▸ getBaseLayer(index): Node

Return baseLayer at specified index

Node

track

LogTrack.getBaseLayer

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

Return iterator by baseLayers nodes

Iterator<Node>

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

LogTrack.getBaseLayers

▸ getBaseLayersCount(): number

Returns amount of baseLayers

number

LogTrack.getBaseLayersCount

▸ getBlock(): LogBlock

Return log block

LogBlock

LogTrack.getBlock

▸ getBorder(): Border

return border visual

Border

border

LogTrack.getBorder

▸ getBorders(): Visible

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

Visible

LogTrack.getBorders

▸ getBounds(): Rect

Gets bounds in the parent coordinates

Rect

LogTrack.getBounds

▸ getChild(i): Node

Return node by index

Node

LogTrack.getChild

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

Return iterator by child nodes

Iterator<S>

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

LogTrack.getChildren

▸ getChildrenCount(): number

Return number of child nodes

number

LogTrack.getChildrenCount

▸ getClassName(): string

string

LogTrack.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

LogTrack.getClipStyle

▸ getContentsArea(transformation?): Rect

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

Rect

LogTrack.getContentsArea

▸ getContentsTransform(): Transformation

Transformation of inner contents to content area

Transformation

LogTrack.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

LogTrack.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

LogTrack.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

LogTrack.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

LogTrack.getCssTransform

▸ getDataLimits(fullLimits?): Range

Return data limits

Range

LogTrack.getDataLimits

▸ getDepthLimits(): Range

Returns depth range

Range

LogTrack.getDepthLimits

▸ getDeviceLimits(): Rect

Return device limits

Rect

LogTrack.getDeviceLimits

▸ getFillStyle(): FillStyle

Return background color

FillStyle

LogTrack.getFillStyle

▸ getFooter(): LogTrackHeader

Returns the track footer if it exists

LogTrackHeader

LogTrack.getFooter

▸ getHeader(): LogTrackHeader

Returns the track header if it exists

LogTrackHeader

LogTrack.getHeader

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

LogTrack.getId

▸ getInfiniteMode(): boolean

Return infinity mode flag

boolean

flag

LogTrack.getInfiniteMode

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

LogTrack.getInvalidateMethod

▸ getLayout(): Layout

Returns layout associated with the group

Layout

layout

▸ getLayoutStyle(): LayoutStyle<string | number>

Return desired layout style

LayoutStyle<string | number>

LogTrack.getLayoutStyle

▸ getLineStyle(): LineStyle

Return border style

LineStyle

LogTrack.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

LogTrack.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

LogTrack.getMarginsStyle

▸ getModelLimits(): Rect

Returns model limits

Rect

LogTrack.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

LogTrack.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

LogTrack.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

LogTrack.getOpacityBlendMode

▸ getOverlay(index): Node

Return overlay at specified index

Node

track

LogTrack.getOverlay

▸ getOverlayAt(index): Node

Return overlay at specified index

Deprecated

since 4.2 use getOverlay instead

Node

track

LogTrack.getOverlayAt

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

Return iterator by overlays nodes

Iterator<Node>

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

LogTrack.getOverlays

▸ getOverlaysCount(): number

Returns amount of overlays

number

LogTrack.getOverlaysCount

▸ getParent(): Node

Return parent node

Node

parent node

LogTrack.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

An object containing the properties to set

LogTrack.getProperties

▸ getProperties(context): DeserializationOptionsOut

DeserializationOptionsOut

LogTrack.getProperties

▸ getProperty(name): any

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

any

LogTrack.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

LogTrack.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

LogTrack.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

LogTrack.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

LogTrack.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

LogTrack.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

LogTrack.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

LogTrack.getTag

▸ getTrack(index): LogTrack

Returns LogTrack at specified index

LogTrack

▸ getTrackAt(index): LogTrack

Returns LogTrack at specified index

Deprecated

since 4.2 use getTrack instead

LogTrack

▸ getTrackContainer(): TrackContainer

Return parent track container or null

TrackContainer

LogTrack.getTrackContainer

▸ 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

amount of tracks

▸ getUnitInfo(): IUnitInfo

Returns an object that has getDeviceUnit and getScaleUnit functions

IUnitInfo

LogTrack.getUnitInfo

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

LogTrack.getVisible

▸ getVisibleDepthLimits(): Range

Returns visible depth range

Range

LogTrack.getVisibleDepthLimits

▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect

Return visible device limits

Rect

LogTrack.getVisibleDeviceLimits

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

LogTrack.getVisibleModelLimits

▸ getWidth(): number

Returns track width

number

LogTrack.getWidth

▸ getWorldTransform(): Transformation

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

Transformation

LogTrack.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

LogTrack.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

LogTrack.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

LogTrack.hasEventListener

▸ indexOfBaseLayer(baseLayer): number

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

number

LogTrack.indexOfBaseLayer

▸ indexOfChild(node): number

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

number

LogTrack.indexOfChild

▸ indexOfOverlay(overlay): number

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

number

LogTrack.indexOfOverlay

▸ indexOfTrack(track): number

Return index of track

number

index of the track

▸ insertBaseLayer(index, baseLayer): StackedTrack

Insert child baseLayer at specified index

StackedTrack

this

LogTrack.insertBaseLayer

▸ insertChild(index, node): StackedTrack

Insert child node at specified index

StackedTrack

this

LogTrack.insertChild

▸ insertOverlay(index, overlay): StackedTrack

Insert child overlay at specified index

StackedTrack

this

LogTrack.insertOverlay

▸ insertTrack(index, track, trackWidth?): LogTrack

Insert track to the container at specified index

Throws

Will throw an error if the track is not specified

Example

widget.insertTrack(0, track);

LogTrack

▸ invalidate(bounds?, force?): StackedTrack

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

StackedTrack

this

LogTrack.invalidate

▸ invalidateLayout(propagate?): StackedTrack

Invalidate layout

StackedTrack

this

LogTrack.invalidateLayout

▸ invalidateParent(bounds?, force?): StackedTrack

Invalidate bounds

StackedTrack

this

LogTrack.invalidateParent

▸ isClippingEnabled(): boolean

Returns if clipping is enabled or not for this node.

boolean

LogTrack.isClippingEnabled

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

LogTrack.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

LogTrack.isEventPropagationEnabled

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

horizontal flip

LogTrack.isHorizontalFlip

▸ isLayoutInvalidated(): boolean

Return true if layout is invalid

boolean

LogTrack.isLayoutInvalidated

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

LogTrack.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

LogTrack.isSelectable

▸ isSilent(): boolean

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

boolean

LogTrack.isSilent

▸ isVerticalFlip(): boolean

Return true if the representation is flipped vertically

boolean

LogTrack.isVerticalFlip

▸ moveTo(area, vAlign?, hAlign?): StackedTrack

MoveTo position of node to specified area