Class: LogFrameVisual

• new LogFrameVisual(options)

• Protected new LogFrameVisual(options?)

LogAbstractVisual.constructor

▸ addCssClass(cssclass): LogFrameVisual

Adds new css class to node

LogFrameVisual

this

LogAbstractVisual.addCssClass

▸ addInvalidateHandler(handler): LogFrameVisual

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

LogFrameVisual

this

LogAbstractVisual.addInvalidateHandler

▸ Protected applyOpacity(context): LogFrameVisual

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

LogFrameVisual

this

LogAbstractVisual.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

LogAbstractVisual.applyResponsiveStyle

▸ checkCollision(context): boolean

Checks culling Returns true if object is inside of renderable area

boolean

LogAbstractVisual.checkCollision

▸ clone(): Node

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

Node

clone

LogAbstractVisual.clone

▸ connectStyle(style, type, callback): LogFrameVisual

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

LogFrameVisual

this

LogAbstractVisual.connectStyle

▸ Protected copyConstructor(src, deepCopy?): LogFrameVisual

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

LogFrameVisual

this

LogAbstractVisual.copyConstructor

▸ disconnectStyle(style, type, callback): LogFrameVisual

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

LogFrameVisual

this

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

LogAbstractVisual.dispose

▸ enableEventPropagation(enable): LogFrameVisual

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

LogFrameVisual

this

LogAbstractVisual.enableEventPropagation

▸ execute(delegate): LogFrameVisual

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

LogFrameVisual

The result if any or this

LogAbstractVisual.execute

▸ execute<T>(delegate): T

T

LogAbstractVisual.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

LogAbstractVisual.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

LogAbstractVisual.getAnimationStyle

▸ getBaseName(): string

Returns the base name

string

The base name

LogAbstractVisual.getBaseName

▸ getBounds(context?): Rect

Returns calculated bounds

Rect

LogAbstractVisual.getBounds

▸ getClassName(): string

string

LogAbstractVisual.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

LogAbstractVisual.getClipStyle

▸ getContentsTransform(): Transformation

Retrieves the world transformation of the spatial

Transformation

LogAbstractVisual.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

LogAbstractVisual.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

LogAbstractVisual.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

LogAbstractVisual.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

LogAbstractVisual.getCssTransform

▸ getDataLimits(fullLimits?): Rect

Return meaning data limits

Rect

LogAbstractVisual.getDataLimits

▸ getDescription(): string

Gets the description

string

The description

LogAbstractVisual.getDescription

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

▸ getHeader(name): LogVisualHeader<Node>

Return the header registered by the name

LogVisualHeader<Node>

header

LogAbstractVisual.getHeader

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

Return an object that contains all headers registered with the visual

Record<string, LogVisualHeader<Node>>

headers

LogAbstractVisual.getHeaders

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

LogAbstractVisual.getId

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

LogAbstractVisual.getInvalidateMethod

▸ getLineStyle(): LineStyle

Returns line style

LineStyle

LogAbstractVisual.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

LogAbstractVisual.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

LogAbstractVisual.getMarginsStyle

▸ getMicroPositionLeft(): number

Returns micro position left

number

LogAbstractVisual.getMicroPositionLeft

▸ getMicroPositionRight(): number

Returns micro position right

number

LogAbstractVisual.getMicroPositionRight

▸ Protected getMicroPositionTransformation(): Transformation

Returns micro position transformation

Transformation

micro position transformation

LogAbstractVisual.getMicroPositionTransformation

▸ getModelLimits(): Rect

Returns parent model limits

Rect

LogAbstractVisual.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

LogAbstractVisual.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

LogAbstractVisual.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

LogAbstractVisual.getOpacityBlendMode

▸ getParent(): Node

Return parent node

Node

parent node

LogAbstractVisual.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

An object containing the properties to set

LogAbstractVisual.getProperties

▸ getProperty(name): any

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

any

LogAbstractVisual.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

LogAbstractVisual.getPropertyKeys

▸ getRect(): Rect

Return rectangle geometry

Rect

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

LogAbstractVisual.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

LogAbstractVisual.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

LogAbstractVisual.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

LogAbstractVisual.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

LogAbstractVisual.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

LogAbstractVisual.getTag

▸ getTrack(): ITrack

Returns parent track if LogTrack

ITrack

LogAbstractVisual.getTrack

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

LogAbstractVisual.getVisible

▸ getWorldTransform(): Transformation

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

Transformation

LogAbstractVisual.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

LogAbstractVisual.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

LogAbstractVisual.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

LogAbstractVisual.hasEventListener

▸ invalidate(bounds?, force?): LogFrameVisual

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

LogFrameVisual

this

LogAbstractVisual.invalidate

▸ invalidateParent(bounds?, force?): LogFrameVisual

Invalidate bounds

LogFrameVisual

this

LogAbstractVisual.invalidateParent

▸ isAutoBounds(): boolean

Returns auto bounds value

boolean

LogAbstractVisual.isAutoBounds

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

LogAbstractVisual.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

LogAbstractVisual.isEventPropagationEnabled

▸ isFixedHeight(): boolean

Returns true if height is fixed in the device coordinates

boolean

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

horizontal flip

LogAbstractVisual.isHorizontalFlip

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

LogAbstractVisual.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

LogAbstractVisual.isSelectable

▸ isSilent(): boolean

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

boolean

LogAbstractVisual.isSilent

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

Notify listeners of the Node

LogFrameVisual

this

LogAbstractVisual.notify

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

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.

LogFrameVisual

this

LogAbstractVisual.off

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

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.

LogFrameVisual

this

LogAbstractVisual.on

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

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

void

LogAbstractVisual.onHeaderSet

▸ Protected onMicroPositionChanged(): LogFrameVisual

calls when microPosition has been changed

LogFrameVisual

this

LogAbstractVisual.onMicroPositionChanged

▸ Protected onParentChanged(node): LogFrameVisual

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

LogFrameVisual

this

LogAbstractVisual.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

LogAbstractVisual.onVisibilityChanged

▸ Protected postRendering(context): void

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

void

LogAbstractVisual.postRendering

▸ Protected preRendering(context): void

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

void

LogAbstractVisual.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

LogAbstractVisual.registerAnimationStyle

▸ removeCssClass(cssclass): LogFrameVisual

Removes css class from node

LogFrameVisual

this

LogAbstractVisual.removeCssClass

▸ removeInvalidateHandler(handler): LogFrameVisual

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

LogFrameVisual

this

LogAbstractVisual.removeInvalidateHandler

▸ render(context): void

Renders node

void

LogAbstractVisual.render

▸ renderAsync(context, callback): void

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

void

LogAbstractVisual.renderAsync

▸ Protected renderContent(context): void

Renders node content

void

LogAbstractVisual.renderContent

▸ rotate(theta, x, y): LogFrameVisual

Rotate bounds around a given coordinate

LogFrameVisual

this

LogAbstractVisual.rotate

▸ scale(xx, yy): LogFrameVisual

Scale node

LogFrameVisual

this

LogAbstractVisual.scale

▸ setAnimationStyle(animationStyle): LogFrameVisual

Sets animation style

LogFrameVisual

LogAbstractVisual.setAnimationStyle

▸ setAutoBounds(enable): LogFrameVisual

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

LogFrameVisual

this

LogAbstractVisual.setAutoBounds

▸ setBaseName(name): LogFrameVisual

Sets base name of the visual

LogFrameVisual

this

LogAbstractVisual.setBaseName

▸ setBounds(bounds): LogFrameVisual

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

LogFrameVisual

this

LogAbstractVisual.setBounds

▸ setClipStyle(style): LogFrameVisual

Sets a new clipping style

LogFrameVisual

this

LogAbstractVisual.setClipStyle

▸ setCss(style, merge?): LogFrameVisual

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

LogFrameVisual

this

LogAbstractVisual.setCss

▸ setCssClass(name): LogFrameVisual

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

LogFrameVisual

this

LogAbstractVisual.setCssClass

▸ setCssTransform(transform): LogFrameVisual

Set CSS transformation

LogFrameVisual

this

LogAbstractVisual.setCssTransform

▸ setDescription(description): LogFrameVisual

Sets the description

LogFrameVisual

this

LogAbstractVisual.setDescription

▸ setFillStyle(fillStyle, merge?): LogFrameVisual

Sets fill style

LogFrameVisual

this

▸ setFixedHeight(enable): LogFrameVisual

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

LogFrameVisual

this

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

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

Throws

if header name is null

LogFrameVisual

this

LogAbstractVisual.setHeader

▸ setId(id): LogFrameVisual

Allows the user to associate any identifier

LogFrameVisual

this

LogAbstractVisual.setId

▸ setLineStyle(lineStyle, merge?): LogFrameVisual

Sets line style

LogFrameVisual

this

LogAbstractVisual.setLineStyle

▸ setLocalTransform(localTransform, force?): LogFrameVisual

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

LogFrameVisual

this

LogAbstractVisual.setLocalTransform

▸ setMarginsStyle(margins, merge?): LogFrameVisual

Sets margins style

LogFrameVisual

this

LogAbstractVisual.setMarginsStyle

▸ setMicroPosition(left, right): LogFrameVisual

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

LogFrameVisual

this

LogAbstractVisual.setMicroPosition

▸ setName(name): LogFrameVisual

Sets name of the node

LogFrameVisual

this

LogAbstractVisual.setName

▸ setNotification(notify, force?): LogFrameVisual

set notification state

LogFrameVisual

this

LogAbstractVisual.setNotification

▸ setOpacity(opacity, blendMode?): LogFrameVisual

Sets node opacity

LogFrameVisual

this

LogAbstractVisual.setOpacity

▸ setProperties(properties?): LogFrameVisual

Sets all the properties pertaining to this object

LogFrameVisual

this

LogAbstractVisual.setProperties

▸ setProperty(name, value): LogFrameVisual

Sets dynamic property by name

LogFrameVisual

this

LogAbstractVisual.setProperty

▸ setRect(rect): LogFrameVisual

Sets rectangle geometry

LogFrameVisual

this

▸ setRenderingFilter(filter): LogFrameVisual

Sets filter to be applied before rendering and picking

LogFrameVisual

this

LogAbstractVisual.setRenderingFilter

▸ setResponsiveStyle(style): LogFrameVisual

Sets responsive style.

LogFrameVisual

this

LogAbstractVisual.setResponsiveStyle

▸ setScaleScrollStrategy(strategy?): LogFrameVisual

Sets scale scroll strategy

LogFrameVisual

this

LogAbstractVisual.setScaleScrollStrategy

▸ setSelectable(selectable): LogFrameVisual

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

LogFrameVisual

this

LogAbstractVisual.setSelectable

▸ setSilent(bool): LogFrameVisual

Set silent mode

LogFrameVisual

this

LogAbstractVisual.setSilent

▸ setTag(tag): LogFrameVisual

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

LogFrameVisual

this

LogAbstractVisual.setTag

▸ setVisible(value): LogFrameVisual

Sets visibility of the node. Send event Events.VisibilityChanged

LogFrameVisual

this

LogAbstractVisual.setVisible

▸ setZIndex(value): LogFrameVisual

Sets z-index for node (set null for default)

LogFrameVisual

this

LogAbstractVisual.setZIndex

▸ shear(shx, shy): LogFrameVisual

Shear this node's bounds

LogFrameVisual

this

LogAbstractVisual.shear

▸ toString(): string

Returns a string representation of this object (generally the classname)

string

A string representation

LogAbstractVisual.toString

▸ translate(tx, ty): LogFrameVisual

Translate bounds

LogFrameVisual

this

LogAbstractVisual.translate

▸ unregisterAnimationStyle(root): void

Unregister animation style.

void

LogAbstractVisual.unregisterAnimationStyle

▸ updateSceneTransformation(): LogFrameVisual

Update scene transformation

LogFrameVisual

this

LogAbstractVisual.updateSceneTransformation

▸ updateState(regions?, changes?): LogFrameVisual

Update state. These methods reset node state and update state for children. this method is useful to refresh a scene graph

LogFrameVisual

this

LogAbstractVisual.updateState

▸ Protected updateTimeStamp(): LogFrameVisual

Update time stamp to indicate that Node or Children has been changed.

LogFrameVisual

this

LogAbstractVisual.updateTimeStamp

▸ Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

void

LogAbstractVisual.enableSceneGraphNotification

▸ Static findParent<T>(node, classType, filter?): InstanceType<T>

Find root of the node with specified type

InstanceType<T>

LogAbstractVisual.findParent

▸ Static findParent(node, classType, filter?): Node

Find root of the node with specified type

Node

LogAbstractVisual.findParent

▸ Static getClassName(): string

string

LogAbstractVisual.getClassName

▸ Static isSceneGraphNotificationEnabled(): boolean

Return status of the global notification for all nodes.

boolean

LogAbstractVisual.isSceneGraphNotificationEnabled