Class: LogTrackHeader

• new LogTrackHeader(track, provider)

• new LogTrackHeader(track?, provider?)

Create track header

LogBaseTrackHeader.constructor

▸ addBaseLayer(baseLayer): LogTrackHeader

Add baseLayer to container

LogTrackHeader

this

LogBaseTrackHeader.addBaseLayer

▸ addChild(node): LogTrackHeader

Add a child node

LogTrackHeader

this

LogBaseTrackHeader.addChild

▸ addCssClass(cssclass): LogTrackHeader

Adds new css class to node

LogTrackHeader

LogBaseTrackHeader.addCssClass

▸ addInvalidateHandler(handler): LogTrackHeader

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

LogTrackHeader

this

LogBaseTrackHeader.addInvalidateHandler

▸ addOverlay(overlay): LogTrackHeader

Add overlay to container

LogTrackHeader

this

LogBaseTrackHeader.addOverlay

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

Adjust position of node to specified area

LogTrackHeader

this

LogBaseTrackHeader.adjustPosition

▸ Protected applyOpacity(context): LogTrackHeader

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

LogTrackHeader

this

LogBaseTrackHeader.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

LogBaseTrackHeader.applyResponsiveStyle

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

Changes the z-order of the baseLayer.

LogTrackHeader

this

LogBaseTrackHeader.changeBaseLayerOrder

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

changes the z-order of the nodes being rendered.

LogTrackHeader

this

LogBaseTrackHeader.changeChildOrder

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

Changes the z-order of the overlay.

LogTrackHeader

this

LogBaseTrackHeader.changeOverlayOrder

▸ checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

boolean

true if node is collided

LogBaseTrackHeader.checkCollision

▸ clearBaseLayers(disposeBaseLayers?): LogTrackHeader

Remove all child baseLayers from group

LogTrackHeader

this

LogBaseTrackHeader.clearBaseLayers

▸ clearChildren(disposeChildren?): LogTrackHeader

Remove all child nodes from this composite group

LogTrackHeader

this

LogBaseTrackHeader.clearChildren

▸ clearOverlays(disposeOverlays?): LogTrackHeader

Remove all child overlays from group

LogTrackHeader

this

LogBaseTrackHeader.clearOverlays

▸ clone(): LogTrackHeader

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

LogTrackHeader

clone

LogBaseTrackHeader.clone

▸ connectStyle(style, type, callback): LogTrackHeader

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

LogTrackHeader

this

LogBaseTrackHeader.connectStyle

▸ Protected copyConstructor(src, deepCopy?): LogTrackHeader

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

LogTrackHeader

this

LogBaseTrackHeader.copyConstructor

▸ disconnectStyle(style, type, callback): LogTrackHeader

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

LogTrackHeader

this

LogBaseTrackHeader.disconnectStyle

▸ dispose(): void

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

void

LogBaseTrackHeader.dispose

▸ enableClipping(doClip): LogTrackHeader

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

LogTrackHeader

this

LogBaseTrackHeader.enableClipping

▸ enableEventPropagation(enable): LogTrackHeader

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

LogTrackHeader

this

LogBaseTrackHeader.enableEventPropagation

▸ enumerateNodes(callback, target?): void

Executes a provided function once for each child node

void

LogBaseTrackHeader.enumerateNodes

▸ execute(delegate): LogTrackHeader

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

LogTrackHeader

The result if any or this

LogBaseTrackHeader.execute

▸ execute<T>(delegate): T

T

LogBaseTrackHeader.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

LogBaseTrackHeader.filter

▸ getActiveVisual(): LogAbstractVisual

Returns active visual

LogAbstractVisual

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

LogBaseTrackHeader.getAnimationStyle

▸ getBaseLayer(index): Node

Return baseLayer at specified index

Node

track

LogBaseTrackHeader.getBaseLayer

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

Return iterator by baseLayers nodes

Iterator<Node>

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

LogBaseTrackHeader.getBaseLayers

▸ getBaseLayersCount(): number

Returns amount of baseLayers

number

LogBaseTrackHeader.getBaseLayersCount

▸ getBorderFillStyle(): FillStyle

Gets the border fill style

FillStyle

style The fill style of the border.

LogBaseTrackHeader.getBorderFillStyle

▸ getBorderLineStyle(): LineStyle

Gets the border line style

LineStyle

style The line style of the border.

LogBaseTrackHeader.getBorderLineStyle

▸ getBorderVisibility(): boolean

Gets the header border's visibility.

boolean

visibility The visibility of the header border.

LogBaseTrackHeader.getBorderVisibility

▸ getBounds(): Rect

Returns bounds

Rect

LogBaseTrackHeader.getBounds

▸ getChild(i): Node

Return node by index

Node

LogBaseTrackHeader.getChild

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

Return iterator by child nodes

Iterator<S>

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

LogBaseTrackHeader.getChildren

▸ getChildrenCount(): number

Return number of child nodes

number

LogBaseTrackHeader.getChildrenCount

▸ getClassName(): string

string

LogBaseTrackHeader.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

LogBaseTrackHeader.getClipStyle

▸ getContentsArea(transformation?): Rect

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

Rect

LogBaseTrackHeader.getContentsArea

▸ getContentsTransform(): Transformation

Gets transformation

Transformation

transform

LogBaseTrackHeader.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

LogBaseTrackHeader.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

LogBaseTrackHeader.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

LogBaseTrackHeader.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

LogBaseTrackHeader.getCssTransform

▸ getDesiredHeight(): number

Return desired height of the header

number

LogBaseTrackHeader.getDesiredHeight

▸ getDeviceLimits(): Rect

Return device limits

Rect

LogBaseTrackHeader.getDeviceLimits

▸ getFirstToLast(): boolean

Return order of the track child headers

boolean

▸ getHeaderProvider(): LogVisualHeaderProvider

Returns the current header provider

LogVisualHeaderProvider

LogBaseTrackHeader.getHeaderProvider

▸ getHoldTitle(): HoldTitle

Return track title hold

HoldTitle

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

LogBaseTrackHeader.getId

▸ getInfiniteMode(): boolean

Return infinity mode flag

boolean

flag

LogBaseTrackHeader.getInfiniteMode

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

LogBaseTrackHeader.getInvalidateMethod

▸ getLayoutStyle(): LayoutStyle<string | number>

return desired layout style

LayoutStyle<string | number>

LogBaseTrackHeader.getLayoutStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

LogBaseTrackHeader.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

LogBaseTrackHeader.getMarginsStyle

▸ getMergeMicroposition(): boolean

Return microposition merging

boolean

▸ getModelLimits(): Rect

Get models limits

Rect

LogBaseTrackHeader.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

LogBaseTrackHeader.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

LogBaseTrackHeader.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

LogBaseTrackHeader.getOpacityBlendMode

▸ getOverlay(index): Node

Return overlay at specified index

Node

track

LogBaseTrackHeader.getOverlay

▸ getOverlayAt(index): Node

Return overlay at specified index

Deprecated

since 4.2 use getOverlay instead

Node

track

LogBaseTrackHeader.getOverlayAt

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

Return iterator by overlays nodes

Iterator<Node>

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

LogBaseTrackHeader.getOverlays

▸ getOverlaysCount(): number

Returns amount of overlays

number

LogBaseTrackHeader.getOverlaysCount

▸ getParent(): Node

Return parent node

Node

parent node

LogBaseTrackHeader.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

An object containing the properties to set

LogBaseTrackHeader.getProperties

▸ getProperty(name): any

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

any

LogBaseTrackHeader.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

LogBaseTrackHeader.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

LogBaseTrackHeader.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

LogBaseTrackHeader.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

LogBaseTrackHeader.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

LogBaseTrackHeader.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

LogBaseTrackHeader.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

LogBaseTrackHeader.getTag

▸ getTitleFirst(): boolean

Return order of the track title header.

boolean

▸ getTopToBottom(): boolean

Return position of the track child headers

boolean

▸ getTrack(): LogTrack

Return track to create a header

LogTrack

LogBaseTrackHeader.getTrack

▸ getTraverseMode(): TraverseMode

Return children traverse mode

TraverseMode

▸ getVisible(): boolean

Returns track visibility if track is not null, true instead

boolean

LogBaseTrackHeader.getVisible

▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect

Return visible device limits

Rect

LogBaseTrackHeader.getVisibleDeviceLimits

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

LogBaseTrackHeader.getVisibleModelLimits

▸ getWorldTransform(): Transformation

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

Transformation

LogBaseTrackHeader.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

LogBaseTrackHeader.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

LogBaseTrackHeader.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

LogBaseTrackHeader.hasEventListener

▸ indexOfBaseLayer(baseLayer): number

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

number

LogBaseTrackHeader.indexOfBaseLayer

▸ indexOfChild(node): number

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

number

LogBaseTrackHeader.indexOfChild

▸ indexOfOverlay(overlay): number

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

number

LogBaseTrackHeader.indexOfOverlay

▸ Protected initializeVisualHeaders(): LogTrackHeader

LogTrackHeader

LogBaseTrackHeader.initializeVisualHeaders

▸ insertBaseLayer(index, baseLayer): LogTrackHeader

Insert child baseLayer at specified index

LogTrackHeader

this

LogBaseTrackHeader.insertBaseLayer

▸ insertChild(index, node): LogTrackHeader

Insert child node at specified index

LogTrackHeader

this

LogBaseTrackHeader.insertChild

▸ insertOverlay(index, overlay): LogTrackHeader

Insert child overlay at specified index

LogTrackHeader

this

LogBaseTrackHeader.insertOverlay

▸ invalidate(bounds?, force?): LogTrackHeader

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

LogTrackHeader

this

LogBaseTrackHeader.invalidate

▸ invalidateLayout(propagate?): LogTrackHeader

Notify that layout is invalidated. Send event Events.LayoutInvalidated

LogTrackHeader

this

LogBaseTrackHeader.invalidateLayout

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

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

Fires

Events.Invalidate

LogTrackHeader

this

LogBaseTrackHeader.invalidateParent

▸ isClippingEnabled(): boolean

Returns if clipping is enabled or not for this node.

boolean

LogBaseTrackHeader.isClippingEnabled

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

LogBaseTrackHeader.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

LogBaseTrackHeader.isEventPropagationEnabled

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

LogBaseTrackHeader.isHorizontalFlip

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

LogBaseTrackHeader.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

LogBaseTrackHeader.isSelectable

▸ isSilent(): boolean

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

boolean

LogBaseTrackHeader.isSilent

▸ isVerticalFlip(): boolean

Return true if the representation is flipped vertically

boolean

LogBaseTrackHeader.isVerticalFlip

▸ isVisibleTrackHeader(): boolean

Return true if track title is visible

boolean

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

MoveTo position of node to specified area

LogTrackHeader

this

LogBaseTrackHeader.moveTo

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

Notify listeners of the Node

LogTrackHeader

this

LogBaseTrackHeader.notify

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

Notify an even to root node

Node

this

LogBaseTrackHeader.notifyRoot

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

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.

LogTrackHeader

this

LogBaseTrackHeader.off

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

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.

LogTrackHeader

this

LogBaseTrackHeader.on

▸ Protected onChildAdded(child): void

This method is called it child or children are added

void