Class: LogTrackVisualHeader<T>

• new LogTrackVisualHeader&lt;T&amp;gt;(options)

• new LogTrackVisualHeader<T>(options?)

LogVisualTitleHeader&lt;T&amp;gt;.constructor

▸ addCssClass(cssclass): LogTrackVisualHeader<T>

Adds new css class to node

LogTrackVisualHeader<T>

LogVisualTitleHeader.addCssClass

▸ addInvalidateHandler(handler): LogTrackVisualHeader<T>

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.addInvalidateHandler

▸ Protected applyOpacity(context): LogTrackVisualHeader<T>

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

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

LogVisualTitleHeader.applyResponsiveStyle

▸ Protected calculateDesiredHeight(): number

Return header desired height

number

LogVisualTitleHeader.calculateDesiredHeight

▸ checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

boolean

LogVisualTitleHeader.checkCollision

▸ checkTextSize(context, text, maxLen): string

Returns biggest text in specified width

string

LogVisualTitleHeader.checkTextSize

▸ clone(): LogVisualTitleHeader<T>

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

LogVisualTitleHeader<T>

clone

LogVisualTitleHeader.clone

▸ connectStyle(style, type, callback): LogTrackVisualHeader<T>

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

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.connectStyle

▸ Protected copyConstructor(src, deepCopy?): LogTrackVisualHeader<T>

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

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.copyConstructor

▸ disconnectStyle(style, type, callback): LogTrackVisualHeader<T>

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

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.disconnectStyle

▸ dispose(): void

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

void

LogVisualTitleHeader.dispose

▸ drawBorder(context, borderLineStyle?, modelLimits?): LogTrackVisualHeader<T>

Stroke border with specified

LogTrackVisualHeader<T>

LogVisualTitleHeader.drawBorder

▸ Protected drawRoundedBox(context, bounds, options?): LogTrackVisualHeader<T>

LogTrackVisualHeader<T>

LogVisualTitleHeader.drawRoundedBox

▸ Protected drawText(context, x?, y?, text?, style?, alignment?, theta?, maxSize?): void

for internal use only, make text always readable

void

LogVisualTitleHeader.drawText

▸ enableEventPropagation(enable): LogTrackVisualHeader<T>

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

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.enableEventPropagation

▸ execute(delegate): LogTrackVisualHeader<T>

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

LogTrackVisualHeader<T>

The result if any or this

LogVisualTitleHeader.execute

▸ execute<T>(delegate): T

T

LogVisualTitleHeader.execute

▸ fillBorder(context, fillStyle?, modelLimits?): LogTrackVisualHeader<T>

Draws a rectangle at the model limits and fill it with specified fillStyle

LogTrackVisualHeader<T>

LogVisualTitleHeader.fillBorder

▸ Protected filter(context): boolean

Filter node

boolean

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

LogVisualTitleHeader.filter

▸ getAdaptiveHeight(): boolean

get adaptive height flag

boolean

LogVisualTitleHeader.getAdaptiveHeight

▸ getAnchorType(): AnchorType

Returns title anchor type

AnchorType

title anchor type

LogVisualTitleHeader.getAnchorType

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

LogVisualTitleHeader.getAnimationStyle

▸ getAutoLabelRotation(): boolean

Get auto label rotation

boolean

LogVisualTitleHeader.getAutoLabelRotation

▸ getBorderLineStyle(): LineStyle

Gets border line style

LineStyle

LogVisualTitleHeader.getBorderLineStyle

▸ getBounds(): Rect

Return bound in the parent coordinates

Rect

LogVisualTitleHeader.getBounds

▸ getClassName(): string

string

LogVisualTitleHeader.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

LogVisualTitleHeader.getClipStyle

▸ getContentsArea(transformation?): Rect

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

Rect

LogVisualTitleHeader.getContentsArea

▸ getContentsTransform(): Transformation

Return transformation from model to bounds

Transformation

LogVisualTitleHeader.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

LogVisualTitleHeader.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

LogVisualTitleHeader.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

LogVisualTitleHeader.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

LogVisualTitleHeader.getCssTransform

▸ getDesiredHeight(width?): number

Return header desired height

number

LogVisualTitleHeader.getDesiredHeight

▸ getDisplayDepth(): number

Returns the displayed depth value

number

LogVisualTitleHeader.getDisplayDepth

▸ getDisplayMode(): string | string[]

Returns the displayed mode value

string | string[]

LogVisualTitleHeader.getDisplayMode

▸ getDisplayString(): string

Returns the displayed value

string

displayString

LogVisualTitleHeader.getDisplayString

▸ getDisplayValue(): number

Returns 0

number

LogVisualTitleHeader.getDisplayValue

▸ getEllipsisString(): string

Get ellipsis text

string

LogVisualTitleHeader.getEllipsisString

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

LogVisualTitleHeader.getFillStyle

▸ getHighlightOptions(): HighlightOptions

Returns highlight options

HighlightOptions

highlight options

LogVisualTitleHeader.getHighlightOptions

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

LogVisualTitleHeader.getId

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

LogVisualTitleHeader.getInvalidateMethod

▸ getIsPointingUp(): boolean

Returns true if the text is always pointing up

boolean

true if the text is always pointing up

LogVisualTitleHeader.getIsPointingUp

▸ getLabelRotationAngle(): number

Returns label rotation angle

number

label rotation angle in radians

LogVisualTitleHeader.getLabelRotationAngle

▸ getLayoutStyle(): LayoutStyle<string | number>

Return desired layout style

LayoutStyle<string | number>

LogVisualTitleHeader.getLayoutStyle

▸ getLineStyle(): LineStyle

Return line style

LineStyle

LogVisualTitleHeader.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

LogVisualTitleHeader.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

LogVisualTitleHeader.getMarginsStyle

▸ getModelLimits(): Rect

Return model limits

Rect

LogVisualTitleHeader.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

LogVisualTitleHeader.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

LogVisualTitleHeader.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

LogVisualTitleHeader.getOpacityBlendMode

▸ getPaddingStyle(): SpaceStyle<string | number>

Return padding style

SpaceStyle<string | number>

padding

LogVisualTitleHeader.getPaddingStyle

▸ getParent(): Node

Return parent node

Node

parent node

LogVisualTitleHeader.getParent

▸ getProperties(): OptionsOut<T>

Gets all the properties pertaining to this object

OptionsOut<T>

An object containing the properties to set

LogVisualTitleHeader.getProperties

▸ getProperty(name): any

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

any

LogVisualTitleHeader.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

LogVisualTitleHeader.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

LogVisualTitleHeader.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

LogVisualTitleHeader.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

LogVisualTitleHeader.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

LogVisualTitleHeader.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

LogVisualTitleHeader.getSceneTransform

▸ getShowEllipsis(): boolean

Returns ellipsis flag

boolean

LogVisualTitleHeader.getShowEllipsis

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

LogVisualTitleHeader.getTag

▸ getText(): string

Returns header title

string

title

LogVisualTitleHeader.getText

▸ Protected getTextBoundingBox(context, x?, y?, text?, style?, alignment?, theta?): Rect

Returns bounding box of the text

Rect

LogVisualTitleHeader.getTextBoundingBox

▸ Protected getTextShapeHelper(x?, y?, text?, textStyle?, alignment?): Text

Return text shape helper instance

Text

text shape helper

LogVisualTitleHeader.getTextShapeHelper

▸ getTextStyle(): TextStyle

Return a current text style

TextStyle

LogVisualTitleHeader.getTextStyle

▸ getVisible(): boolean

Return visibility of the header

boolean

true if header itself and associated LogVisual is visible

LogVisualTitleHeader.getVisible

▸ getVisual(): T

Gets visual to be used to render header

T

visual

LogVisualTitleHeader.getVisual

▸ getWorldTransform(): Transformation

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

Transformation

LogVisualTitleHeader.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

LogVisualTitleHeader.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

LogVisualTitleHeader.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

LogVisualTitleHeader.hasEventListener

▸ invalidate(bounds?, force?): LogTrackVisualHeader<T>

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

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.invalidate

▸ invalidateLayout(propagate?): LogTrackVisualHeader<T>

Notify that layout is invalidated. Send event Events.LayoutInvalidated

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.invalidateLayout

▸ Protected invalidateParent(bounds?, force?): LogTrackVisualHeader<T>

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

Fires

Events.Invalidate

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.invalidateParent

▸ isAutoBounds(): boolean

Enable automatic bounds. If auto bounds is enabled then it equals to parent model limits

Deprecated

since 4.1, use .getLayoutStyle instead

boolean

LogVisualTitleHeader.isAutoBounds

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

LogVisualTitleHeader.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

LogVisualTitleHeader.isEventPropagationEnabled

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

horizontal flip

LogVisualTitleHeader.isHorizontalFlip

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

LogVisualTitleHeader.isNotificationEnabled

▸ isRotationNeeded(): boolean

True if labels doesn't fit to header width

boolean

LogVisualTitleHeader.isRotationNeeded

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

LogVisualTitleHeader.isSelectable

▸ isSilent(): boolean

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

boolean

LogVisualTitleHeader.isSilent

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

Notify listeners of the Node

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.notify

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

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.

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.off

▸ on<E>(type, callback): LogTrackVisualHeader<T>

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.

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.on

▸ Protected onParentChanged(node): LogTrackVisualHeader<T>

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

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

LogVisualTitleHeader.onVisibilityChanged

▸ Protected onVisualChanged(): void

This method is called if visual is changed. Send event Events.VisualChanged

void

LogVisualTitleHeader.onVisualChanged

▸ Protected onVisualChanging(): void

This method is called if visual is changing.

void

LogVisualTitleHeader.onVisualChanging

▸ Protected onVisualStateChanged(type, source): void

void

LogVisualTitleHeader.onVisualStateChanged

▸ Protected postRendering(context): void

To be called after rendering. Call this method if you override method render

void

LogVisualTitleHeader.postRendering

▸ Protected preRendering(context): void

Occurs before rendering this method sets clipping by default. Call this method if you override method render

void

LogVisualTitleHeader.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

LogVisualTitleHeader.registerAnimationStyle

▸ removeCssClass(cssclass): LogTrackVisualHeader<T>

Removes css class from node

LogTrackVisualHeader<T>

LogVisualTitleHeader.removeCssClass

▸ removeInvalidateHandler(handler): LogTrackVisualHeader<T>

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.removeInvalidateHandler

▸ render(inputContext): void

Renders node

void

LogVisualTitleHeader.render

▸ renderAsync(context, callback): void

Render node in asynchronous mode. Default implementation creates call method "render" inside

void

LogVisualTitleHeader.renderAsync

▸ rotate(theta, x, y): LogTrackVisualHeader<T>

Rotate bounds around a given coordinate

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.rotate

▸ scale(xx, yy): LogTrackVisualHeader<T>

Scale node

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.scale

▸ setAdaptiveHeight(enable): LogTrackVisualHeader<T>

Set adaptive height flag

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.setAdaptiveHeight

▸ setAnchorType(anchorType): LogTrackVisualHeader<T>

Sets label anchor type

Example

import {AnchorType} from '@int/geotoolkit/util/AnchorType';

header.setAnchorType(AnchorType.BottomCenter);

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.setAnchorType

▸ setAnimationStyle(animationStyle): LogTrackVisualHeader<T>

Sets animation style

LogTrackVisualHeader<T>

LogVisualTitleHeader.setAnimationStyle

▸ setAutoBounds(enable): LogTrackVisualHeader<T>

Enable or disable auto bounds If auto bounds is enabled then it equals to parent model limits

Deprecated

since 4.1, use .setLayoutStyle instead

LogTrackVisualHeader<T>

LogVisualTitleHeader.setAutoBounds

▸ setAutoLabelRotation(value): LogTrackVisualHeader<T>

Set auto label rotation

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.setAutoLabelRotation

▸ setBorderLineStyle(lineStyle, merge?): LogTrackVisualHeader<T>

Sets border line style

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.setBorderLineStyle

▸ setBounds(bounds): LogTrackVisualHeader<T>

Sets bounds of the curve in the parent coordinates and set up auto bounds false

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.setBounds

▸ setClipStyle(style): LogTrackVisualHeader<T>

Sets a new clipping style

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.setClipStyle

▸ setCss(style, merge?): LogTrackVisualHeader<T>

Sets CSS style. This style will be applied for all inserted elements

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.setCss

▸ setCssClass(name): LogTrackVisualHeader<T>

Sets css class name of the node to be used to apply CSS style

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.setCssClass

▸ setCssTransform(transform): LogTrackVisualHeader<T>

Set CSS transformation

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.setCssTransform

▸ setDesiredHeight(value, silent?): LogTrackVisualHeader<T>

Sets desired height of the header as a layoutable object

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.setDesiredHeight

▸ setDisplayMode(displayMode): LogTrackVisualHeader<T>

Sets the displayed mode value

LogTrackVisualHeader<T>

LogVisualTitleHeader.setDisplayMode

▸ setDisplayString(displayString): LogTrackVisualHeader<T>

Sets the displayed value

LogTrackVisualHeader<T>

LogVisualTitleHeader.setDisplayString

▸ setEllipsisString(ellipsisValue): LogTrackVisualHeader<T>

Sets ellipsis text to string under 15 characters

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.setEllipsisString

▸ setFillStyle(fillStyle, merge?): LogTrackVisualHeader<T>

Sets fill style

LogTrackVisualHeader<T>

LogVisualTitleHeader.setFillStyle

▸ setHighlightOptions(options): LogTrackVisualHeader<T>

Set highlight options

LogTrackVisualHeader<T>

LogVisualTitleHeader.setHighlightOptions

▸ setHorizontalFlip(enable): LogTrackVisualHeader<T>

Set horizontal flip of the representation

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.setHorizontalFlip

▸ setId(id): LogTrackVisualHeader<T>

Allows the user to associate any identifier

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.setId

▸ setIsPointingUp(isPointingUp): LogTrackVisualHeader<T>

Sets whether the text is always pointing up.

LogTrackVisualHeader<T>

this

LogVisualTitleHeader.setIsPointingUp

▸ setLabelRotationAngle(angle): LogTrackVisualHeader<T>

Sets label rotation angle in radians

Example

// user can customize the label rotation angle
setLabelRotationAngle(-Math.PI / 2)