Class: LogHeaderContainer

• new LogHeaderContainer(options)

• new LogHeaderContainer(options?)

HeaderContainer.constructor

▸ addBaseLayer(baseLayer): LogHeaderContainer

Add baseLayer to container

LogHeaderContainer

this

HeaderContainer.addBaseLayer

▸ addChild(node): LogHeaderContainer

Add a child node

LogHeaderContainer

this

HeaderContainer.addChild

▸ addCssClass(cssclass): LogHeaderContainer

Adds new css class to node

LogHeaderContainer

this

HeaderContainer.addCssClass

▸ addInvalidateHandler(handler): LogHeaderContainer

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

LogHeaderContainer

this

HeaderContainer.addInvalidateHandler

▸ addLayer(layer): LogHeaderContainer

Add layer or layer collection to container

LogHeaderContainer

this

▸ addOverlay(overlay): LogHeaderContainer

Add overlay to container

LogHeaderContainer

this

HeaderContainer.addOverlay

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

Adjust position of node to specified area

LogHeaderContainer

this

HeaderContainer.adjustPosition

▸ Protected applyOpacity(context): LogHeaderContainer

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

LogHeaderContainer

this

HeaderContainer.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

HeaderContainer.applyResponsiveStyle

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

Changes the z-order of the baseLayer.

LogHeaderContainer

this

HeaderContainer.changeBaseLayerOrder

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

changes the z-order of the nodes being rendered.

LogHeaderContainer

this

HeaderContainer.changeChildOrder

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

Changes the z-order of the overlay.

LogHeaderContainer

this

HeaderContainer.changeOverlayOrder

▸ checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

boolean

true if node is collided

HeaderContainer.checkCollision

▸ clearBaseLayers(disposeBaseLayers?): LogHeaderContainer

Remove all child baseLayers from group

LogHeaderContainer

this

HeaderContainer.clearBaseLayers

▸ clearCache(): LogHeaderContainer

Clear cache

LogHeaderContainer

this

HeaderContainer.clearCache

▸ clearChildren(disposeChildren?): LogHeaderContainer

Remove all child nodes from this composite group

LogHeaderContainer

this

HeaderContainer.clearChildren

▸ clearOverlays(disposeOverlays?): LogHeaderContainer

Remove all child overlays from group

LogHeaderContainer

this

HeaderContainer.clearOverlays

▸ clone(): LogHeaderContainer

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

LogHeaderContainer

clone

HeaderContainer.clone

▸ connectStyle(style, type, callback): LogHeaderContainer

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

LogHeaderContainer

this

HeaderContainer.connectStyle

▸ Protected copyConstructor(src, deepCopy?): LogHeaderContainer

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

LogHeaderContainer

this

HeaderContainer.copyConstructor

▸ disconnectStyle(style, type, callback): LogHeaderContainer

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

LogHeaderContainer

this

HeaderContainer.disconnectStyle

▸ dispose(): void

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

void

HeaderContainer.dispose

▸ Protected drawBorder(localContext, bounds?): LogHeaderContainer

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

LogHeaderContainer

this

HeaderContainer.drawBorder

▸ enableClipping(doClip): LogHeaderContainer

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

LogHeaderContainer

this

HeaderContainer.enableClipping

▸ enableEventPropagation(enable): LogHeaderContainer

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

LogHeaderContainer

this

HeaderContainer.enableEventPropagation

▸ enablePickingChildren(enable): LogHeaderContainer

Enables or disables picking children

LogHeaderContainer

this

HeaderContainer.enablePickingChildren

▸ enumerateNodes(callback, target?): void

Executes a provided function once for each child node

void

HeaderContainer.enumerateNodes

▸ execute(delegate): LogHeaderContainer

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

LogHeaderContainer

The result if any or this

HeaderContainer.execute

▸ execute<T>(delegate): T

T

HeaderContainer.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

HeaderContainer.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

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

HeaderContainer.getAutoModelLimitsMode

▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy

Get Model Limits Logics Strategy

ModelLimitsStrategy

strategy

HeaderContainer.getAutoModelLimitsStrategy

▸ getBaseLayer(index): Node

Return baseLayer at specified index

Node

track

HeaderContainer.getBaseLayer

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

Return iterator by baseLayers nodes

Iterator<Node>

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

HeaderContainer.getBaseLayers

▸ getBaseLayersCount(): number

Returns amount of baseLayers

number

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

HeaderContainer.getBounds

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache

HeaderContainer.getCache

▸ getChild(i): Node

Return node by index

Node

HeaderContainer.getChild

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

Return iterator by child nodes

Iterator<S>

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

HeaderContainer.getChildren

▸ getChildrenCount(): number

Return number of child nodes

number

HeaderContainer.getChildrenCount

▸ getClassName(): string

string

HeaderContainer.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

HeaderContainer.getClipStyle

▸ getContentOrientation(): Orientation

Return content orientation

Orientation

content orientation

HeaderContainer.getContentOrientation

▸ getContentsArea(transformation?): Rect

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

Rect

HeaderContainer.getContentsArea

▸ getContentsTransform(): Transformation

getContentsTransform() retrieves the world transformation of the node.

Transformation

transformation from model coordinates to bounds of the group

HeaderContainer.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

HeaderContainer.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

HeaderContainer.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

HeaderContainer.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

HeaderContainer.getCssTransform

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

HeaderContainer.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)

HeaderContainer.getDesiredWidth

▸ getDeviceLimits(): Rect

Return device limits

Rect

HeaderContainer.getDeviceLimits

▸ getDisplayMarkerDepth(): number

Return marker depth to be used to display value. By default, it is nan and value is not displayed

number

HeaderContainer.getDisplayMarkerDepth

▸ getDisplayPosition(): Point

Returns position to be used to display value. By default it is nan and value is not displayed

Point

HeaderContainer.getDisplayPosition

▸ getDisplayType(): DisplayType

Returns display type

DisplayType

HeaderContainer.getDisplayType

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

HeaderContainer.getFillStyle

▸ getHeaderProvider(): LogVisualHeaderProvider

Return a header provider

LogVisualHeaderProvider

header provider

HeaderContainer.getHeaderProvider

▸ getHeadersPadding(): number

Return padding in pixels in header containers

number

HeaderContainer.getHeadersPadding

▸ getHeadersSpacing(): number

Return spacing in pixels between headers

number

HeaderContainer.getHeadersSpacing

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

HeaderContainer.getId

▸ getInfiniteMode(): boolean

Return infinity mode flag

boolean

flag

HeaderContainer.getInfiniteMode

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

HeaderContainer.getInvalidateMethod

▸ getLayerAt(index): CompositeNode<Node>

Return layer at specified index

CompositeNode<Node>

track

▸ getLayersCount(): number

Returns amount of layers

number

▸ getLayout(): Layout

Returns layout associated with the group

Layout

layout

HeaderContainer.getLayout

▸ getLayoutStyle(): LayoutStyle<string | number>

return desired layout style

LayoutStyle<string | number>

HeaderContainer.getLayoutStyle

▸ getLineStyle(): LineStyle

Return border style

LineStyle

HeaderContainer.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

HeaderContainer.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

HeaderContainer.getMarginsStyle

▸ getModelLimits(): Rect

Gets model limits, the limits of this groups inside space

Rect

the current model limits

HeaderContainer.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

HeaderContainer.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

HeaderContainer.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

HeaderContainer.getOpacityBlendMode

▸ getOverlay(index): Node

Return overlay at specified index

Node

track

HeaderContainer.getOverlay

▸ getOverlayAt(index): Node

Return overlay at specified index

Deprecated

since 4.2 use getOverlay instead

Node

track

HeaderContainer.getOverlayAt

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

Return iterator by overlays nodes

Iterator<Node>

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

HeaderContainer.getOverlays

▸ getOverlaysCount(): number

Returns amount of overlays

number

HeaderContainer.getOverlaysCount

▸ getPaddingStyle(): SpaceStyle<string | number>

Return padding style

SpaceStyle<string | number>

padding

HeaderContainer.getPaddingStyle

▸ getParent(): Node

Return parent node

Node

parent node

HeaderContainer.getParent

▸ getPreferredSize(rect?): Rect

Return preferred size to layout children

Rect

HeaderContainer.getPreferredSize

▸ getProperties(): OptionsOut<Node>

Gets all the properties pertaining to this object

OptionsOut<Node>

HeaderContainer.getProperties

▸ getProperty(name): any

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

any

HeaderContainer.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

HeaderContainer.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

HeaderContainer.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

HeaderContainer.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

HeaderContainer.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

HeaderContainer.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

HeaderContainer.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

HeaderContainer.getTag

▸ getTrackHeader(track): LogBaseTrackHeader

Return log track header

LogBaseTrackHeader

track header

HeaderContainer.getTrackHeader

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

HeaderContainer.getVisible

▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect

Return visible device limits

Rect

HeaderContainer.getVisibleDeviceLimits

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

HeaderContainer.getVisibleModelLimits

▸ getWorldTransform(): Transformation

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

Transformation

HeaderContainer.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

HeaderContainer.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

HeaderContainer.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

HeaderContainer.hasEventListener

▸ indexOfBaseLayer(baseLayer): number

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

number

HeaderContainer.indexOfBaseLayer

▸ indexOfChild(node): number

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

number

HeaderContainer.indexOfChild

▸ indexOfOverlay(overlay): number

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

number

HeaderContainer.indexOfOverlay

▸ insertBaseLayer(index, baseLayer): LogHeaderContainer

Insert child baseLayer at specified index

LogHeaderContainer

this

HeaderContainer.insertBaseLayer

▸ insertChild(index, node): LogHeaderContainer

Insert child node at specified index

LogHeaderContainer

this

HeaderContainer.insertChild

▸ insertOverlay(index, overlay): LogHeaderContainer

Insert child overlay at specified index

LogHeaderContainer

this

HeaderContainer.insertOverlay

▸ invalidate(bounds?, force?): LogHeaderContainer

Invalidate node

LogHeaderContainer

this

HeaderContainer.invalidate

▸ invalidateLayout(propagate?): LogHeaderContainer

Notify that layout is invalidated. Send event Events.LayoutInvalidated

LogHeaderContainer

this

HeaderContainer.invalidateLayout

▸ invalidateParent(bounds?, force?): LogHeaderContainer

Invalidate parent area

LogHeaderContainer

this

HeaderContainer.invalidateParent

▸ isClippingEnabled(): boolean

Returns if clipping is enabled or not for this node.

boolean

HeaderContainer.isClippingEnabled

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

HeaderContainer.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

HeaderContainer.isEventPropagationEnabled

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

flip

HeaderContainer.isHorizontalFlip

▸ isLayoutInvalidated(): boolean

Return true if layout is invalid

boolean

HeaderContainer.isLayoutInvalidated

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

HeaderContainer.isNotificationEnabled

▸ isPickingChildrenEnabled(): boolean

Returns if picking children is enabled or not for this node.

boolean

pickingChildren

HeaderContainer.isPickingChildrenEnabled

▸ isScrollable(): boolean

Determines whether this container is scrollable Returns true if scrollable

boolean

HeaderContainer.isScrollable

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

HeaderContainer.isSelectable

▸ isSilent(): boolean

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

boolean

HeaderContainer.isSilent

▸ isVerticalFlip(): boolean

Return true if the representation is flipped vertically

boolean

flip

HeaderContainer.isVerticalFlip

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

MoveTo position of node to specified area

LogHeaderContainer

this

HeaderContainer.moveTo

▸ notify<E>(type, source, args?): LogHeaderContainer

Notify listeners of the Node

LogHeaderContainer

this

HeaderContainer.notify

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

Notify an even to root node

Node

this

HeaderContainer.notifyRoot

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

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.

LogHeaderContainer

this

HeaderContainer.off

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

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.

LogHeaderContainer

this

HeaderContainer.on

▸ Protected onBoundsChanged(bounds): LogHeaderContainer

Occurs when bounds has been changed

LogHeaderContainer

this

HeaderContainer.onBoundsChanged

▸ Protected onChildAdded(child): void

This method is called it child or children are added