Class: StackedTrackHeader

• new StackedTrackHeader(track, provider, trackFactory)

• new StackedTrackHeader(track, provider, trackFactory)

LogTrackHeader.constructor

▸ addBaseLayer(baseLayer): StackedTrackHeader

Add baseLayer to container

StackedTrackHeader

this

LogTrackHeader.addBaseLayer

▸ addChild(node): StackedTrackHeader

Add a child node

StackedTrackHeader

this

LogTrackHeader.addChild

▸ addCssClass(cssclass): StackedTrackHeader

Adds new css class to node

StackedTrackHeader

LogTrackHeader.addCssClass

▸ addInvalidateHandler(handler): StackedTrackHeader

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

StackedTrackHeader

this

LogTrackHeader.addInvalidateHandler

▸ addOverlay(overlay): StackedTrackHeader

Add overlay to container

StackedTrackHeader

this

LogTrackHeader.addOverlay

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

Adjust position of node to specified area

StackedTrackHeader

this

LogTrackHeader.adjustPosition

▸ Protected applyOpacity(context): StackedTrackHeader

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

StackedTrackHeader

this

LogTrackHeader.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

LogTrackHeader.applyResponsiveStyle

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

Changes the z-order of the baseLayer.

StackedTrackHeader

this

LogTrackHeader.changeBaseLayerOrder

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

changes the z-order of the nodes being rendered.

StackedTrackHeader

this

LogTrackHeader.changeChildOrder

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

Changes the z-order of the overlay.

StackedTrackHeader

this

LogTrackHeader.changeOverlayOrder

▸ checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

boolean

true if node is collided

LogTrackHeader.checkCollision

▸ clearBaseLayers(disposeBaseLayers?): StackedTrackHeader

Remove all child baseLayers from group

StackedTrackHeader

this

LogTrackHeader.clearBaseLayers

▸ clearChildren(disposeChildren?): StackedTrackHeader

Remove all child nodes from this composite group

StackedTrackHeader

this

LogTrackHeader.clearChildren

▸ clearOverlays(disposeOverlays?): StackedTrackHeader

Remove all child overlays from group

StackedTrackHeader

this

LogTrackHeader.clearOverlays

▸ clone(): LogTrackHeader

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

LogTrackHeader

clone

LogTrackHeader.clone

▸ connectStyle(style, type, callback): StackedTrackHeader

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

StackedTrackHeader

this

LogTrackHeader.connectStyle

▸ Protected copyConstructor(src, deepCopy?): StackedTrackHeader

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

StackedTrackHeader

this

LogTrackHeader.copyConstructor

▸ disconnectStyle(style, type, callback): StackedTrackHeader

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

StackedTrackHeader

this

LogTrackHeader.disconnectStyle

▸ dispose(): void

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

void

LogTrackHeader.dispose

▸ enableClipping(doClip): StackedTrackHeader

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

StackedTrackHeader

this

LogTrackHeader.enableClipping

▸ enableEventPropagation(enable): StackedTrackHeader

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

StackedTrackHeader

this

LogTrackHeader.enableEventPropagation

▸ enumerateNodes(callback, target?): void

Executes a provided function once for each child node

void

LogTrackHeader.enumerateNodes

▸ execute(delegate): StackedTrackHeader

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

StackedTrackHeader

The result if any or this

LogTrackHeader.execute

▸ execute<T>(delegate): T

T

LogTrackHeader.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

LogTrackHeader.filter

▸ getActiveVisual(): LogAbstractVisual

Returns active visual

LogAbstractVisual

LogTrackHeader.getActiveVisual

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

LogTrackHeader.getAnimationStyle

▸ getBaseLayer(index): Node

Return baseLayer at specified index

Node

track

LogTrackHeader.getBaseLayer

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

Return iterator by baseLayers nodes

Iterator<Node>

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

LogTrackHeader.getBaseLayers

▸ getBaseLayersCount(): number

Returns amount of baseLayers

number

LogTrackHeader.getBaseLayersCount

▸ getBorderFillStyle(): FillStyle

Gets the border fill style

FillStyle

style The fill style of the border.

LogTrackHeader.getBorderFillStyle

▸ getBorderLineStyle(): LineStyle

Gets the border line style

LineStyle

style The line style of the border.

LogTrackHeader.getBorderLineStyle

▸ getBorderVisibility(): boolean

Gets the header border's visibility.

boolean

visibility The visibility of the header border.

LogTrackHeader.getBorderVisibility

▸ getBounds(): Rect

Returns bounds

Rect

LogTrackHeader.getBounds

▸ getChild(i): Node

Return node by index

Node

LogTrackHeader.getChild

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

Return iterator by child nodes

Iterator<S>

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

LogTrackHeader.getChildren

▸ getChildrenCount(): number

Return number of child nodes

number

LogTrackHeader.getChildrenCount

▸ getClassName(): string

string

LogTrackHeader.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

LogTrackHeader.getClipStyle

▸ getContentsArea(transformation?): Rect

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

Rect

LogTrackHeader.getContentsArea

▸ getContentsTransform(): Transformation

Gets transformation

Transformation

transform

LogTrackHeader.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

LogTrackHeader.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

LogTrackHeader.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

LogTrackHeader.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

LogTrackHeader.getCssTransform

▸ getDesiredHeight(): number

Return desired height of the header

number

LogTrackHeader.getDesiredHeight

▸ getDeviceLimits(): Rect

Return device limits

Rect

LogTrackHeader.getDeviceLimits

▸ getFirstToLast(): boolean

Return order of the track child headers

boolean

LogTrackHeader.getFirstToLast

▸ getHeaderProvider(): LogVisualHeaderProvider

Returns the current header provider

LogVisualHeaderProvider

LogTrackHeader.getHeaderProvider

▸ getHoldTitle(): HoldTitle

Return track title hold

HoldTitle

LogTrackHeader.getHoldTitle

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

LogTrackHeader.getId

▸ getInfiniteMode(): boolean

Return infinity mode flag

boolean

flag

LogTrackHeader.getInfiniteMode

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

LogTrackHeader.getInvalidateMethod

▸ getLayoutStyle(): LayoutStyle<string | number>

return desired layout style

LayoutStyle<string | number>

LogTrackHeader.getLayoutStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

LogTrackHeader.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

LogTrackHeader.getMarginsStyle

▸ getMergeMicroposition(): boolean

Return microposition merging

boolean

LogTrackHeader.getMergeMicroposition

▸ getModelLimits(): Rect

Get models limits

Rect

LogTrackHeader.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

LogTrackHeader.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

LogTrackHeader.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

LogTrackHeader.getOpacityBlendMode

▸ getOverlay(index): Node

Return overlay at specified index

Node

track

LogTrackHeader.getOverlay

▸ getOverlayAt(index): Node

Return overlay at specified index

Deprecated

since 4.2 use getOverlay instead

Node

track

LogTrackHeader.getOverlayAt

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

Return iterator by overlays nodes

Iterator<Node>

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

LogTrackHeader.getOverlays

▸ getOverlaysCount(): number

Returns amount of overlays

number

LogTrackHeader.getOverlaysCount

▸ getParent(): Node

Return parent node

Node

parent node

LogTrackHeader.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

An object containing the properties to set

LogTrackHeader.getProperties

▸ getProperty(name): any

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

any

LogTrackHeader.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

LogTrackHeader.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

LogTrackHeader.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

LogTrackHeader.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

LogTrackHeader.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

LogTrackHeader.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

LogTrackHeader.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

LogTrackHeader.getTag

▸ getTitleFirst(): boolean

Return order of the track title header.

boolean

LogTrackHeader.getTitleFirst

▸ getTopToBottom(): boolean

Return position of the track child headers

boolean

LogTrackHeader.getTopToBottom

▸ getTrack(): LogTrack

Return track to create a header

LogTrack

LogTrackHeader.getTrack

▸ getTraverseMode(): TraverseMode

Return children traverse mode

TraverseMode

LogTrackHeader.getTraverseMode

▸ getVisible(): boolean

Returns track visibility if track is not null, true instead

boolean

LogTrackHeader.getVisible

▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect

Return visible device limits

Rect

LogTrackHeader.getVisibleDeviceLimits

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

LogTrackHeader.getVisibleModelLimits

▸ getWorldTransform(): Transformation

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

Transformation

LogTrackHeader.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

LogTrackHeader.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

LogTrackHeader.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

LogTrackHeader.hasEventListener

▸ indexOfBaseLayer(baseLayer): number

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

number

LogTrackHeader.indexOfBaseLayer

▸ indexOfChild(node): number

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

number

LogTrackHeader.indexOfChild

▸ indexOfOverlay(overlay): number

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

number

LogTrackHeader.indexOfOverlay

▸ Protected initializeVisualHeaders(): StackedTrackHeader

StackedTrackHeader

LogTrackHeader.initializeVisualHeaders

▸ insertBaseLayer(index, baseLayer): StackedTrackHeader

Insert child baseLayer at specified index

StackedTrackHeader

this

LogTrackHeader.insertBaseLayer

▸ insertChild(index, node): StackedTrackHeader

Insert child node at specified index

StackedTrackHeader

this

LogTrackHeader.insertChild

▸ insertOverlay(index, overlay): StackedTrackHeader

Insert child overlay at specified index

StackedTrackHeader

this

LogTrackHeader.insertOverlay

▸ invalidate(bounds?, force?): StackedTrackHeader

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

StackedTrackHeader

this

LogTrackHeader.invalidate

▸ invalidateLayout(propagate?): StackedTrackHeader

Notify that layout is invalidated. Send event Events.LayoutInvalidated

StackedTrackHeader

this

LogTrackHeader.invalidateLayout

▸ Protected invalidateParent(bounds?, force?): StackedTrackHeader

Invalidate parent and notify all listeners. NOTE: Don't keep arguments of the event, because instance can be changed

Fires

Events.Invalidate

StackedTrackHeader

this

LogTrackHeader.invalidateParent

▸ isClippingEnabled(): boolean

Returns if clipping is enabled or not for this node.

boolean

LogTrackHeader.isClippingEnabled

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

LogTrackHeader.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

LogTrackHeader.isEventPropagationEnabled

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

LogTrackHeader.isHorizontalFlip

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

LogTrackHeader.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

LogTrackHeader.isSelectable

▸ isSilent(): boolean

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

boolean

LogTrackHeader.isSilent

▸ isVerticalFlip(): boolean

Return true if the representation is flipped vertically

boolean

LogTrackHeader.isVerticalFlip

▸ isVisibleTrackHeader(): boolean

Return true if track title is visible

boolean

LogTrackHeader.isVisibleTrackHeader

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

MoveTo position of node to specified area

StackedTrackHeader

this

LogTrackHeader.moveTo

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

Notify listeners of the Node

StackedTrackHeader

this

LogTrackHeader.notify

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

Notify an even to root node

Node

this

LogTrackHeader.notifyRoot

▸ off<E>(type?, callback?): StackedTrackHeader

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.

StackedTrackHeader

this

LogTrackHeader.off

▸ on<E>(type, callback): StackedTrackHeader

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.