Class: LogBaseTrackHeader

• new LogBaseTrackHeader(track, height, provider)

• new LogBaseTrackHeader(track?, height?, provider?)

LayeredNode.constructor

▸ addBaseLayer(baseLayer): LogBaseTrackHeader

Add baseLayer to container

LogBaseTrackHeader

this

LayeredNode.addBaseLayer

▸ addChild(node): LogBaseTrackHeader

Add a child node

LogBaseTrackHeader

this

LayeredNode.addChild

▸ addCssClass(cssclass): LogBaseTrackHeader

Adds new css class to node

LogBaseTrackHeader

LayeredNode.addCssClass

▸ addInvalidateHandler(handler): LogBaseTrackHeader

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

LogBaseTrackHeader

this

LayeredNode.addInvalidateHandler

▸ addOverlay(overlay): LogBaseTrackHeader

Add overlay to container

LogBaseTrackHeader

this

LayeredNode.addOverlay

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

Adjust position of node to specified area

LogBaseTrackHeader

this

LayeredNode.adjustPosition

▸ Protected applyOpacity(context): LogBaseTrackHeader

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

LogBaseTrackHeader

this

LayeredNode.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

LayeredNode.applyResponsiveStyle

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

Changes the z-order of the baseLayer.

LogBaseTrackHeader

this

LayeredNode.changeBaseLayerOrder

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

changes the z-order of the nodes being rendered.

LogBaseTrackHeader

this

LayeredNode.changeChildOrder

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

Changes the z-order of the overlay.

LogBaseTrackHeader

this

LayeredNode.changeOverlayOrder

▸ checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

boolean

true if node is collided

LayeredNode.checkCollision

▸ clearBaseLayers(disposeBaseLayers?): LogBaseTrackHeader

Remove all child baseLayers from group

LogBaseTrackHeader

this

LayeredNode.clearBaseLayers

▸ clearChildren(disposeChildren?): LogBaseTrackHeader

Remove all child nodes from this composite group

LogBaseTrackHeader

this

LayeredNode.clearChildren

▸ clearOverlays(disposeOverlays?): LogBaseTrackHeader

Remove all child overlays from group

LogBaseTrackHeader

this

LayeredNode.clearOverlays

▸ clone(): LogBaseTrackHeader

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

LogBaseTrackHeader

clone

LayeredNode.clone

▸ connectStyle(style, type, callback): LogBaseTrackHeader

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

LogBaseTrackHeader

this

LayeredNode.connectStyle

▸ Protected copyConstructor(src, deepCopy?): LogBaseTrackHeader

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

LogBaseTrackHeader

this

LayeredNode.copyConstructor

▸ disconnectStyle(style, type, callback): LogBaseTrackHeader

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

LogBaseTrackHeader

this

LayeredNode.disconnectStyle

▸ dispose(): void

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

void

LayeredNode.dispose

▸ enableClipping(doClip): LogBaseTrackHeader

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

LogBaseTrackHeader

this

LayeredNode.enableClipping

▸ enableEventPropagation(enable): LogBaseTrackHeader

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

LogBaseTrackHeader

this

LayeredNode.enableEventPropagation

▸ enumerateNodes(callback, target?): void

Executes a provided function once for each child node

void

LayeredNode.enumerateNodes

▸ execute(delegate): LogBaseTrackHeader

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

LogBaseTrackHeader

The result if any or this

LayeredNode.execute

▸ execute<T>(delegate): T

T

LayeredNode.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

LayeredNode.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

LayeredNode.getAnimationStyle

▸ getBaseLayer(index): Node

Return baseLayer at specified index

Node

track

LayeredNode.getBaseLayer

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

Return iterator by baseLayers nodes

Iterator<Node>

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

Iterator<Node>

An iterator for child overlays.

LayeredNode.getBaseLayers

▸ getBaseLayersCount(): number

Returns amount of baseLayers

number

LayeredNode.getBaseLayersCount

▸ getBorderFillStyle(): FillStyle

Gets the border fill style

FillStyle

style The fill style of the border.

▸ getBorderLineStyle(): LineStyle

Gets the border line style

LineStyle

style The line style of the border.

▸ getBorderVisibility(): boolean

Gets the header border's visibility.

boolean

visibility The visibility of the header border.

▸ getBounds(): Rect

Returns bounds

Rect

ILayoutable.getBounds

LayeredNode.getBounds

▸ getChild(i): Node

Return node by index

Node

LayeredNode.getChild

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

Return iterator by child nodes

Iterator<S>

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

Iterator<Node>

An iterator for child nodes.

LayeredNode.getChildren

▸ getChildrenCount(): number

Return number of child nodes

number

LayeredNode.getChildrenCount

▸ getClassName(): string

string

LayeredNode.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

LayeredNode.getClipStyle

▸ getContentsArea(transformation?): Rect

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

Rect

LayeredNode.getContentsArea

▸ getContentsTransform(): Transformation

Gets transformation

Transformation

transform

LayeredNode.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

LayeredNode.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

LayeredNode.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

LayeredNode.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

LayeredNode.getCssTransform

▸ getDesiredHeight(): number

Return desired height of the header

number

▸ getDeviceLimits(): Rect

Return device limits

Rect

LayeredNode.getDeviceLimits

▸ getHeaderProvider(): LogVisualHeaderProvider

Returns the current header provider

LogVisualHeaderProvider

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

LayeredNode.getId

▸ getInfiniteMode(): boolean

Return infinity mode flag

boolean

flag

LayeredNode.getInfiniteMode

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

LayeredNode.getInvalidateMethod

▸ getLayoutStyle(): LayoutStyle<string | number>

return desired layout style

LayoutStyle<string | number>

ILayoutable.getLayoutStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

LayeredNode.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

LayeredNode.getMarginsStyle

▸ getModelLimits(): Rect

Get models limits

Rect

LayeredNode.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

LayeredNode.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

LayeredNode.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

LayeredNode.getOpacityBlendMode

▸ getOverlay(index): Node

Return overlay at specified index

Node

track

LayeredNode.getOverlay

▸ getOverlayAt(index): Node

Return overlay at specified index

Deprecated

since 4.2 use getOverlay instead

Node

track

LayeredNode.getOverlayAt

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

Return iterator by overlays nodes

Iterator<Node>

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

Iterator<Node>

An iterator for child overlays.

LayeredNode.getOverlays

▸ getOverlaysCount(): number

Returns amount of overlays

number

LayeredNode.getOverlaysCount

▸ getParent(): Node

Return parent node

Node

parent node

ILayoutable.getParent

LayeredNode.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

An object containing the props to set

LayeredNode.getProperties

▸ getProperty(name): any

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

any

LayeredNode.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

LayeredNode.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

LayeredNode.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

LayeredNode.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

LayeredNode.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

LayeredNode.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

LayeredNode.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

LayeredNode.getTag

▸ getTrack(): LogTrack

Return track to create a header

LogTrack

▸ getVisible(): boolean

Returns track visibility if track is not null, true instead

boolean

LayeredNode.getVisible

▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect

Return visible device limits

Rect

LayeredNode.getVisibleDeviceLimits

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

LayeredNode.getVisibleModelLimits

▸ getWorldTransform(): Transformation

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

Transformation

LayeredNode.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

LayeredNode.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

LayeredNode.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

LayeredNode.hasEventListener

▸ indexOfBaseLayer(baseLayer): number

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

number

LayeredNode.indexOfBaseLayer

▸ indexOfChild(node): number

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

number

LayeredNode.indexOfChild

▸ indexOfOverlay(overlay): number

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

number

LayeredNode.indexOfOverlay

▸ Protected initializeVisualHeaders(): LogBaseTrackHeader

LogBaseTrackHeader

▸ insertBaseLayer(index, baseLayer): LogBaseTrackHeader

Insert child baseLayer at specified index

LogBaseTrackHeader

this

LayeredNode.insertBaseLayer

▸ insertChild(index, node): LogBaseTrackHeader

Insert child node at specified index

LogBaseTrackHeader

this

LayeredNode.insertChild

▸ insertOverlay(index, overlay): LogBaseTrackHeader

Insert child overlay at specified index

LogBaseTrackHeader

this

LayeredNode.insertOverlay

▸ invalidate(bounds?, force?): LogBaseTrackHeader

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

LogBaseTrackHeader

this

LayeredNode.invalidate

▸ invalidateLayout(propagate?): LogBaseTrackHeader

Notify that layout is invalidated. Send event Events.LayoutInvalidated

LogBaseTrackHeader

this

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

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

Fires

Events.Invalidate

LogBaseTrackHeader

this

LayeredNode.invalidateParent

▸ isClippingEnabled(): boolean

Returns if clipping is enabled or not for this node.

boolean

LayeredNode.isClippingEnabled

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

LayeredNode.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

LayeredNode.isEventPropagationEnabled

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

LayeredNode.isHorizontalFlip

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

LayeredNode.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

LayeredNode.isSelectable

▸ isSilent(): boolean

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

boolean

LayeredNode.isSilent

▸ isVerticalFlip(): boolean

Return true if the representation is flipped vertically

boolean

LayeredNode.isVerticalFlip

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

MoveTo position of node to specified area

LogBaseTrackHeader

this

LayeredNode.moveTo

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

Notify listeners of the Node

LogBaseTrackHeader

this

LayeredNode.notify

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

Notify an even to root node

Node

this

LayeredNode.notifyRoot

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

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.

LogBaseTrackHeader

this

LayeredNode.off

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

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.

LogBaseTrackHeader

this

LayeredNode.on

▸ Protected onChildAdded(child): void

This method is called it child or children are added

void

LayeredNode.onChildAdded

▸ Protected onChildRemoved(child): void

This method is called it child or children are removed

void

LayeredNode.onChildRemoved

▸ Protected onParentChanged(node): LogBaseTrackHeader

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

LogBaseTrackHeader

this

LayeredNode.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

LayeredNode.onVisibilityChanged

▸ Protected postRendering(context, callback?): void

To be called after rendering, used for PDF output

void

LayeredNode.postRendering

▸ Protected preRendering(context, callback?): void

Occurs before child rendering

void

LayeredNode.preRendering

▸ rebuild(): LogBaseTrackHeader

Rebuild Track header