Class: LogAbstractVisual

• [new LogAbstractVisual(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.welllog.logabstractvisual.logabstractvisual.md#new logabstractvisual(options))

• Protected new LogAbstractVisual(options?)

Constructor

AbstractNode.constructor

▸ addCssClass(cssclass): LogAbstractVisual

Adds new css class to node

LogAbstractVisual

this

AbstractNode.addCssClass

▸ addInvalidateHandler(handler): LogAbstractVisual

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

LogAbstractVisual

this

AbstractNode.addInvalidateHandler

▸ Protected applyOpacity(context): LogAbstractVisual

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

LogAbstractVisual

this

AbstractNode.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

AbstractNode.applyResponsiveStyle

▸ checkCollision(context): boolean

Check culling. Returns true if object is inside of renderable area

boolean

AbstractNode.checkCollision

▸ clone(): Node

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

Node

clone

AbstractNode.clone

▸ connectStyle(style, type, callback): LogAbstractVisual

Connects style.<br> <br> This convenience method subscribes a listener to given style for the specified type.<br> And automatically un-subscribes listener if node is disposed to prevent memory leaks

LogAbstractVisual

this

AbstractNode.connectStyle

▸ Protected copyConstructor(src, deepCopy): LogAbstractVisual

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

LogAbstractVisual

this

AbstractNode.copyConstructor

▸ disconnectStyle(style, type, callback): LogAbstractVisual

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

LogAbstractVisual

this

AbstractNode.disconnectStyle

▸ dispose(): void

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

void

AbstractNode.dispose

▸ enableEventPropagation(enable): LogAbstractVisual

Enable event propagation from the node hierarchy from bottom to top <p> 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. </p>

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

LogAbstractVisual

this

AbstractNode.enableEventPropagation

▸ execute(delegate): LogAbstractVisual

Executes delegate and return the result. It allows us to keep all initialization calls in one place, <br> 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");
});

LogAbstractVisual

The result if any or this

AbstractNode.execute

▸ execute<T&gt;(delegate): T

T

AbstractNode.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

AbstractNode.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

AbstractNode.getAnimationStyle

▸ getBaseName(): string

Returns the base name

string

The base name

▸ getBounds(): Rect

Returns bounds in the parent coordinates

Rect

▸ getClassName(): string

string

AbstractNode.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

AbstractNode.getClipStyle

▸ getContentsTransform(): Transformation

Retrieves the world transformation of the spatial

Transformation

▸ getCss(): CssStyle

Return CSS style

CssStyle

AbstractNode.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

AbstractNode.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

AbstractNode.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

AbstractNode.getCssTransform

▸ getDataLimits(fullLimits?): Rect

Return meaning data limits

Rect

▸ getDescription(): string

Gets the description

string

The description

▸ getHeader(name): LogVisualHeader<Node&gt;

Return the header registered by the name

LogVisualHeader<Node&gt;

header

▸ getHeaders(): Record<string, LogVisualHeader<Node&gt;&gt;

Return an object that contains all headers registered with the visual

Record<string, LogVisualHeader<Node&gt;&gt;

headers

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

AbstractNode.getId

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher&gt;

Gets invalidate method

AttributeCallback<EventDispatcher&gt;

method to invalidate this object

AbstractNode.getInvalidateMethod

▸ getLineStyle(): LineStyle

Returns line style

LineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

AbstractNode.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number&gt;

Return margins style

SpaceStyle<string | number&gt;

AbstractNode.getMarginsStyle

▸ getMicroPositionLeft(): number

Returns micro position left

number

▸ getMicroPositionRight(): number

Returns micro position right

number

▸ Protected getMicroPositionTransformation(): Transformation

Returns micro position transformation

Transformation

micro position transformation

▸ getModelLimits(): Rect

Returns parent model limits

Rect

▸ getName(): string

Returns the node name

string

The node name

AbstractNode.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

AbstractNode.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

AbstractNode.getOpacityBlendMode

▸ getParent(): Node

Return parent node

Node

parent node

AbstractNode.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

An object containing the properties

AbstractNode.getProperties

▸ getProperty(name): any

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

any

AbstractNode.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AbstractNode.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

AbstractNode.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

AbstractNode.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

AbstractNode.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

AbstractNode.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

AbstractNode.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

AbstractNode.getTag

▸ getTrack(): ITrack

Returns parent track if LogTrack

ITrack

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

AbstractNode.getVisible

▸ getWorldTransform(): Transformation

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

Transformation

AbstractNode.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

AbstractNode.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

AbstractNode.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

AbstractNode.hasEventListener

▸ invalidate(bounds?, force?): LogAbstractVisual

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

LogAbstractVisual

this

AbstractNode.invalidate

▸ invalidateParent(bounds?, force?): LogAbstractVisual

Invalidate bounds

LogAbstractVisual

this

AbstractNode.invalidateParent

▸ isAutoBounds(): boolean

Returns auto bounds value

boolean

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractNode.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

AbstractNode.isEventPropagationEnabled

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

horizontal flip

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

AbstractNode.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

AbstractNode.isSelectable

▸ isSilent(): boolean

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

boolean

AbstractNode.isSilent

▸ notify<E&gt;(type, source, args?): LogAbstractVisual

Notify listeners of the Node

LogAbstractVisual

this

AbstractNode.notify

▸ off<E&gt;(type?, callback?): LogAbstractVisual

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.

LogAbstractVisual

this

AbstractNode.off

▸ on<E&gt;(type, callback): LogAbstractVisual

Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> 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. </p>

LogAbstractVisual

this

AbstractNode.on

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

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

void

▸ Protected onMicroPositionChanged(): LogAbstractVisual

calls when microPosition has been changed

LogAbstractVisual

this

▸ Protected onParentChanged(node): LogAbstractVisual

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

LogAbstractVisual

this

AbstractNode.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

AbstractNode.onVisibilityChanged

▸ Protected postRendering(context): void

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

void

AbstractNode.postRendering

▸ Protected preRendering(context): void

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

void

AbstractNode.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

AbstractNode.registerAnimationStyle

▸ removeCssClass(cssclass): LogAbstractVisual

Removes css class from node

LogAbstractVisual

this

AbstractNode.removeCssClass

▸ removeInvalidateHandler(handler): LogAbstractVisual

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

LogAbstractVisual

this

AbstractNode.removeInvalidateHandler

▸ render(context): void

Renders node

void

AbstractNode.render

▸ renderAsync(context, callback): void

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

void

AbstractNode.renderAsync

▸ Protected renderContent(context): void

Renders node content

void

▸ rotate(theta, x, y): LogAbstractVisual

Rotate bounds around a given coordinate

LogAbstractVisual

this

AbstractNode.rotate

▸ scale(xx, yy): LogAbstractVisual

Scale node

LogAbstractVisual

this

AbstractNode.scale

▸ setAnimationStyle(animationStyle): LogAbstractVisual

Sets animation style

LogAbstractVisual

AbstractNode.setAnimationStyle

▸ setAutoBounds(enable): LogAbstractVisual

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

LogAbstractVisual

this

▸ setBaseName(name): LogAbstractVisual

Sets base name of the visual

LogAbstractVisual

this

▸ setBounds(bounds): LogAbstractVisual

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

LogAbstractVisual

this

▸ setClipStyle(style): LogAbstractVisual

Sets a new clipping style

LogAbstractVisual

this

AbstractNode.setClipStyle

▸ setCss(style, merge?): LogAbstractVisual

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

LogAbstractVisual

this

AbstractNode.setCss

▸ setCssClass(name): LogAbstractVisual

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

LogAbstractVisual

this

AbstractNode.setCssClass

▸ setCssTransform(transform): LogAbstractVisual

Set CSS transformation

LogAbstractVisual

this

AbstractNode.setCssTransform

▸ setDescription(description): LogAbstractVisual

Sets the description

LogAbstractVisual

this

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

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

Throws

if header name is null

LogAbstractVisual

this

▸ setId(id): LogAbstractVisual

Allows the user to associate any identifier

LogAbstractVisual

this

AbstractNode.setId

▸ setLineStyle(lineStyle, merge?): LogAbstractVisual

Sets line style

LogAbstractVisual

this

▸ setLocalTransform(localTransform, force?): LogAbstractVisual

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

LogAbstractVisual

this

AbstractNode.setLocalTransform

▸ setMarginsStyle(margins, merge?): LogAbstractVisual

Sets margins style

LogAbstractVisual

this

AbstractNode.setMarginsStyle

▸ setMicroPosition(left, right): LogAbstractVisual

Sets micro position (0 - 1). It allows application code to display the visual in a subarea of the track.<br> 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);

LogAbstractVisual

this

▸ setName(name): LogAbstractVisual

Sets name of the node

LogAbstractVisual

this

AbstractNode.setName

▸ setNotification(notify, force?): LogAbstractVisual

set notification state

LogAbstractVisual

this

AbstractNode.setNotification

▸ setOpacity(opacity, blendMode?): LogAbstractVisual

Sets node opacity

LogAbstractVisual

this

AbstractNode.setOpacity

▸ setParent(parent): LogAbstractVisual

Sets parent node. Don't call this method directly. It is internal method.

LogAbstractVisual

this

AbstractNode.setParent

▸ setProperties(properties?): LogAbstractVisual

Sets all the properties pertaining to this object

LogAbstractVisual

this

AbstractNode.setProperties

▸ setProperty(name, value): LogAbstractVisual

Sets dynamic property by name

LogAbstractVisual

this

AbstractNode.setProperty

▸ setRenderingFilter(filter): LogAbstractVisual

Sets filter to be applied before rendering and picking

LogAbstractVisual

this

AbstractNode.setRenderingFilter

▸ setResponsiveStyle(style): LogAbstractVisual

Sets responsive style.

LogAbstractVisual

this

AbstractNode.setResponsiveStyle

▸ setScaleScrollStrategy(strategy?): LogAbstractVisual

Sets scale scroll strategy

LogAbstractVisual

this

AbstractNode.setScaleScrollStrategy

▸ setSelectable(selectable): LogAbstractVisual

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

LogAbstractVisual

this

AbstractNode.setSelectable

▸ setSilent(bool): LogAbstractVisual

Set silent mode

LogAbstractVisual

this

AbstractNode.setSilent

▸ setTag(tag): LogAbstractVisual

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

LogAbstractVisual

this

AbstractNode.setTag

▸ setVisible(value): LogAbstractVisual

Sets visibility of the node. Send event Events.VisibilityChanged

LogAbstractVisual

this

AbstractNode.setVisible

▸ setZIndex(value): LogAbstractVisual

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

LogAbstractVisual

this

AbstractNode.setZIndex

▸ shear(shx, shy): LogAbstractVisual

Shear this node's bounds

LogAbstractVisual

this

AbstractNode.shear

▸ toString(): string

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

string

A string representation

AbstractNode.toString

▸ translate(tx, ty): LogAbstractVisual

Translate bounds

LogAbstractVisual

this

AbstractNode.translate

▸ unregisterAnimationStyle(root): void

Unregister animation style.

void

AbstractNode.unregisterAnimationStyle

▸ updateSceneTransformation(): LogAbstractVisual

Update scene transformation

LogAbstractVisual

this

AbstractNode.updateSceneTransformation

▸ updateState(regions?, changes?): LogAbstractVisual

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

LogAbstractVisual

this

AbstractNode.updateState

▸ Protected updateTimeStamp(): LogAbstractVisual

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

LogAbstractVisual

this

AbstractNode.updateTimeStamp

▸ Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

void

AbstractNode.enableSceneGraphNotification

▸ Static findParent<T&gt;(node, classType, filter?): InstanceType<T&gt;

Find root of the node with specified type

InstanceType<T&gt;

AbstractNode.findParent

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

Find root of the node with specified type

Node

AbstractNode.findParent

▸ Static getClassName(): string

string

AbstractNode.getClassName

▸ Static isSceneGraphNotificationEnabled(): boolean

Return status of the global notification for all nodes.

boolean

AbstractNode.isSceneGraphNotificationEnabled