Class: LogAnnotation

• new LogAnnotation(options, text)

• new LogAnnotation(options?, text?)

LogFrameVisual.constructor

▸ addCssClass(cssclass): LogAnnotation

Adds new css class to node

LogAnnotation

this

LogFrameVisual.addCssClass

▸ addInvalidateHandler(handler): LogAnnotation

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

LogAnnotation

this

LogFrameVisual.addInvalidateHandler

▸ Protected applyOpacity(context): LogAnnotation

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

LogAnnotation

this

LogFrameVisual.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

LogFrameVisual.applyResponsiveStyle

▸ checkCollision(context): boolean

Checks culling Returns true if object is inside of renderable area

boolean

LogFrameVisual.checkCollision

▸ clone(): LogAnnotation

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

LogAnnotation

clone

LogFrameVisual.clone

▸ connectStyle(style, type, callback): LogAnnotation

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

LogAnnotation

this

LogFrameVisual.connectStyle

▸ Protected copyConstructor(src, deepCopy?): LogAnnotation

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

LogAnnotation

this

LogFrameVisual.copyConstructor

▸ disconnectStyle(style, type, callback): LogAnnotation

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

LogAnnotation

this

LogFrameVisual.disconnectStyle

▸ dispose(): void

Disposes this node, once disposes a node should not be used anymore.
Clear all listeners, and disconnect styles to avoid memory leaks.
Also aggressively 'cleanup' this node by setting some of its members to null.

void

LogFrameVisual.dispose

▸ enableEventPropagation(enable): LogAnnotation

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

LogAnnotation

this

LogFrameVisual.enableEventPropagation

▸ execute(delegate): LogAnnotation

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

LogAnnotation

The result if any or this

LogFrameVisual.execute

▸ execute<T>(delegate): T

T

LogFrameVisual.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

LogFrameVisual.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

LogFrameVisual.getAnimationStyle

▸ getAutoHeight(): boolean

Returns auto height flag

boolean

▸ getBaseName(): string

Returns the base name

string

The base name

LogFrameVisual.getBaseName

▸ getBounds(context?): Rect

Returns calculated bounds

Rect

LogFrameVisual.getBounds

▸ getClassName(): string

string

LogFrameVisual.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

LogFrameVisual.getClipStyle

▸ getContentsTransform(): Transformation

Retrieves the world transformation of the spatial

Transformation

LogFrameVisual.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

LogFrameVisual.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

LogFrameVisual.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

LogFrameVisual.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

LogFrameVisual.getCssTransform

▸ getDataLimits(fullLimits?): Rect

Return meaning data limits

Rect

LogFrameVisual.getDataLimits

▸ getDescription(): string

Gets the description

string

The description

LogFrameVisual.getDescription

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

LogFrameVisual.getFillStyle

▸ getHeader(name): LogVisualHeader<Node>

Return the header registered by the name

LogVisualHeader<Node>

header

LogFrameVisual.getHeader

▸ getHeaders(): Record<string, LogVisualHeader<Node>>

Return an object that contains all headers registered with the visual

Record<string, LogVisualHeader<Node>>

headers

LogFrameVisual.getHeaders

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

LogFrameVisual.getId

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

LogFrameVisual.getInvalidateMethod

▸ getLineStyle(): LineStyle

Returns line style

LineStyle

LogFrameVisual.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

LogFrameVisual.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

LogFrameVisual.getMarginsStyle

▸ getMicroPositionLeft(): number

Returns micro position left

number

LogFrameVisual.getMicroPositionLeft

▸ getMicroPositionRight(): number

Returns micro position right

number

LogFrameVisual.getMicroPositionRight

▸ Protected getMicroPositionTransformation(): Transformation

Returns micro position transformation

Transformation

micro position transformation

LogFrameVisual.getMicroPositionTransformation

▸ getModelLimits(): Rect

Returns parent model limits

Rect

LogFrameVisual.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

LogFrameVisual.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

LogFrameVisual.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

LogFrameVisual.getOpacityBlendMode

▸ getPaddingStyle(): SpaceStyle<string | number>

Returns padding style

SpaceStyle<string | number>

padding

▸ getParent(): Node

Return parent node

Node

parent node

LogFrameVisual.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

An object containing the properties to set

LogFrameVisual.getProperties

▸ getProperty(name): any

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

any

LogFrameVisual.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

LogFrameVisual.getPropertyKeys

▸ getRect(): Rect

Return rectangle geometry

Rect

LogFrameVisual.getRect

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

LogFrameVisual.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

LogFrameVisual.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

LogFrameVisual.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

LogFrameVisual.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

LogFrameVisual.getSceneTransform

▸ getShowEllipsis(): boolean

Returns ellipsis flag

boolean

ellipsis flag

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

LogFrameVisual.getTag

▸ getText(): string

Returns the current text

string

▸ getTextAlignment(): TextAlignment

Return text alignment

TextAlignment

▸ getTextAutoRotation(): boolean

Return text autorotation

boolean

▸ getTextOrientation(): TextOrientation

Return text orientation

TextOrientation

▸ getTextPosition(): AnchorType

Returns text position inside the bounds

AnchorType

text anchor type

▸ getTextSizeMode(): SizeMode

Returns how the size is computed

SizeMode

returns textSizeMode

▸ getTextStyle(): TextStyle

Returns text style

TextStyle

▸ getTrack(): ITrack

Returns parent track if LogTrack

ITrack

LogFrameVisual.getTrack

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

LogFrameVisual.getVisible

▸ getWorldTransform(): Transformation

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

Transformation

LogFrameVisual.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

LogFrameVisual.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

LogFrameVisual.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

LogFrameVisual.hasEventListener

▸ invalidate(bounds?, force?): LogAnnotation

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

LogAnnotation

this

LogFrameVisual.invalidate

▸ invalidateParent(bounds?, force?): LogAnnotation

Invalidate bounds

LogAnnotation

this

LogFrameVisual.invalidateParent

▸ isAutoBounds(): boolean

Returns auto bounds value

boolean

LogFrameVisual.isAutoBounds

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

LogFrameVisual.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

LogFrameVisual.isEventPropagationEnabled

▸ isFixedHeight(): boolean

Returns true if height is fixed in the device coordinates

boolean

LogFrameVisual.isFixedHeight

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

horizontal flip

LogFrameVisual.isHorizontalFlip

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

LogFrameVisual.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

LogFrameVisual.isSelectable

▸ isSilent(): boolean

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

boolean

LogFrameVisual.isSilent

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

Notify listeners of the Node

LogAnnotation

this

LogFrameVisual.notify

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

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.

LogAnnotation

this

LogFrameVisual.off

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

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.

LogAnnotation

this

LogFrameVisual.on

▸ Protected onHeaderSet(name, headerInstance, silent?): void

This method is called if header is set. Send event Events.HeaderSet

void

LogFrameVisual.onHeaderSet

▸ Protected onMicroPositionChanged(): LogAnnotation

calls when microPosition has been changed

LogAnnotation

this

LogFrameVisual.onMicroPositionChanged

▸ Protected onParentChanged(node): LogAnnotation

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

LogAnnotation

this

LogFrameVisual.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

LogFrameVisual.onVisibilityChanged

▸ Protected postRendering(context): void

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

void

LogFrameVisual.postRendering

▸ Protected preRendering(context): void

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

void

LogFrameVisual.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

LogFrameVisual.registerAnimationStyle

▸ removeCssClass(cssclass): LogAnnotation

Removes css class from node

LogAnnotation

this

LogFrameVisual.removeCssClass

▸ removeInvalidateHandler(handler): LogAnnotation

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

LogAnnotation

this

LogFrameVisual.removeInvalidateHandler

▸ render(context): void

Renders node

void

LogFrameVisual.render

▸ renderAsync(context, callback): void

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

void

LogFrameVisual.renderAsync

▸ Protected renderContent(context): void

Renders node content

void

LogFrameVisual.renderContent

▸ rotate(theta, x, y): LogAnnotation

Rotate bounds around a given coordinate

LogAnnotation

this

LogFrameVisual.rotate

▸ scale(xx, yy): LogAnnotation

Scale node

LogAnnotation

this

LogFrameVisual.scale

▸ setAnimationStyle(animationStyle): LogAnnotation

Sets animation style

LogAnnotation

LogFrameVisual.setAnimationStyle

▸ setAutoBounds(enable): LogAnnotation

Enables or disables auto bounds. If auto bounds is enabled then it equals to parent model limits

LogAnnotation

this

LogFrameVisual.setAutoBounds

▸ setAutoHeight(enable): LogAnnotation

Set auto height flag

LogAnnotation

this

▸ setBaseName(name): LogAnnotation

Sets base name of the visual

LogAnnotation

this

LogFrameVisual.setBaseName

▸ setBounds(bounds): LogAnnotation

Sets bounds of the visual in the parent coordinates and sets up auto bounds to false

LogAnnotation

this

LogFrameVisual.setBounds

▸ setClipStyle(style): LogAnnotation

Sets a new clipping style

LogAnnotation

this

LogFrameVisual.setClipStyle

▸ setCss(style, merge?): LogAnnotation

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

LogAnnotation

this

LogFrameVisual.setCss

▸ setCssClass(name): LogAnnotation

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

LogAnnotation

this

LogFrameVisual.setCssClass

▸ setCssTransform(transform): LogAnnotation

Set CSS transformation

LogAnnotation

this

LogFrameVisual.setCssTransform

▸ setDescription(description): LogAnnotation

Sets the description

LogAnnotation

this

LogFrameVisual.setDescription

▸ setFillStyle(fillStyle, merge?): LogAnnotation

Sets fill style

LogAnnotation

this

LogFrameVisual.setFillStyle

▸ setFixedHeight(enable): LogAnnotation

Enables height of the frame to be fixed in the device coordinates

LogAnnotation

this

LogFrameVisual.setFixedHeight

▸ setHeader(name, headerInstance, silent?): LogAnnotation

Sets header instance with specified name. This name usually defines header or footer.

Throws

if header name is null

LogAnnotation

this

LogFrameVisual.setHeader

▸ setId(id): LogAnnotation

Allows the user to associate any identifier

LogAnnotation

this

LogFrameVisual.setId

▸ setLineStyle(lineStyle, merge?): LogAnnotation

Sets line style

LogAnnotation

this

LogFrameVisual.setLineStyle

▸ setLocalTransform(localTransform, force?): LogAnnotation

Sets local transformation to be used to transform from local to parent coordinate

LogAnnotation

this

LogFrameVisual.setLocalTransform

▸ setMarginsStyle(margins, merge?): LogAnnotation

Sets margins style

LogAnnotation

this

LogFrameVisual.setMarginsStyle

▸ setMicroPosition(left, right): LogAnnotation

Sets micro position (0 - 1). It allows application code to display the visual in a subarea of the track.
By default log visuals uses all space of the trace in the horizontal direction, but micro position allows to place log visual in the specified position of the track in horizontal direction. See example below

Example

// The following code places curve 20% from left and 20% from right.
curve.setMicroPosition(0.2,0.8);

LogAnnotation

this

LogFrameVisual.setMicroPosition

▸ setName(name): LogAnnotation

Sets name of the node

LogAnnotation

this

LogFrameVisual.setName

▸ setNotification(notify, force?): LogAnnotation

set notification state

LogAnnotation

this

LogFrameVisual.setNotification

▸ setOpacity(opacity, blendMode?): LogAnnotation

Sets node opacity

LogAnnotation

this

LogFrameVisual.setOpacity

▸ setPaddingStyle(paddingStyle, merge?): LogAnnotation

Sets padding style

LogAnnotation

this

▸ setProperties(properties?): LogAnnotation

Sets all the properties pertaining to this object

LogAnnotation

this

LogFrameVisual.setProperties

▸ setProperty(name, value): LogAnnotation

Sets dynamic property by name

LogAnnotation

this

LogFrameVisual.setProperty

▸ setRect(rect): LogAnnotation

Sets rectangle geometry

LogAnnotation

this

LogFrameVisual.setRect

▸ setRenderingFilter(filter): LogAnnotation

Sets filter to be applied before rendering and picking

LogAnnotation

this

LogFrameVisual.setRenderingFilter

▸ setResponsiveStyle(style): LogAnnotation

Sets responsive style.

LogAnnotation

this

LogFrameVisual.setResponsiveStyle

▸ setScaleScrollStrategy(strategy?): LogAnnotation

Sets scale scroll strategy

LogAnnotation

this

LogFrameVisual.setScaleScrollStrategy

▸ setSelectable(selectable): LogAnnotation

Allows to select node. If node is not selectable then child node is not selectable.

LogAnnotation

this

LogFrameVisual.setSelectable

▸ setShowEllipsis(showTextEllipsis): LogAnnotation

Set show ellipsis

LogAnnotation

this

▸ setSilent(bool): LogAnnotation

Set silent mode

LogAnnotation

this

LogFrameVisual.setSilent

▸ setTag(tag): LogAnnotation

Allows the user to associate any arbitrary object with the node.

LogAnnotation

this

LogFrameVisual.setTag

▸ setText(text): LogAnnotation

Sets text

LogAnnotation

▸ setTextAlignment(alignment): LogAnnotation

Sets text alignment.

LogAnnotation

▸ setTextAutoRotation(autoRotation): LogAnnotation

Sets text autorotation.

LogAnnotation

▸ setTextOrientation(orientation): LogAnnotation

Sets text orientation. if text orientation is regular then text follows the widgets orientation if text is rotated then text is always rotated on 90 degree.