Class: LogMarker

• new LogMarker(depth?, nameLabel?, depthLabel?, horizontalTextOffset?, verticalTextOffset?)

Constructor

LogAbstractVisual.constructor

• new LogMarker(params?)

Constructor

LogAbstractVisual.constructor

▸ addCssClass(cssclass): LogMarker

Adds new css class to node

LogMarker

this

LogAbstractVisual.addCssClass

▸ addInvalidateHandler(handler): LogMarker

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

LogMarker

this

LogAbstractVisual.addInvalidateHandler

▸ Protected applyOpacity(context): LogMarker

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

LogMarker

this

LogAbstractVisual.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

LogAbstractVisual.applyResponsiveStyle

▸ checkCollision(context): boolean

Verifies if object is within given context.

boolean

LogAbstractVisual.checkCollision

▸ clone(): LogMarker

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

LogMarker

clone

LogAbstractVisual.clone

▸ connectStyle(style, type, callback): LogMarker

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

LogMarker

this

LogAbstractVisual.connectStyle

▸ Protected copyConstructor(src, deepCopy?): LogMarker

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

LogMarker

this

LogAbstractVisual.copyConstructor

▸ disconnectStyle(style, type, callback): LogMarker

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

LogMarker

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

▸ Protected drawMarker(localContext, nameLabelRect, depthLabelRect): void

Draws marker

void

▸ Protected drawText(context, x, y, text, textStyle, alignment, lineStyle, fillStyle, radius?): void

Draw text

void

▸ enableEventPropagation(enable): LogMarker

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

LogMarker

this

LogAbstractVisual.enableEventPropagation

▸ execute(delegate): LogMarker

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

LogMarker

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(tr?): Rect

Return model limits

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

▸ getDepth(): number

Return depth

number

depth

▸ getDepthBorderRadius(): number

Returns depth label border radius

number

▸ getDepthLabel(): string

Returns depth label to be displayed

string

▸ getDepthLabelPosition(): AnchorType

Return depth label position as an anchor point

AnchorType

▸ getDescription(): string

Gets the description

string

The description

LogAbstractVisual.getDescription

▸ getFillStyleDepth(): FillStyle

Return fill style of depth label

FillStyle

▸ getFillStyleName(): FillStyle

Return fill style of name label

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

▸ getHorizontalTextOffset(): number

Gets horizontal label offset in device space

number

▸ 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

▸ getLineDecoration(): ILineDecoration

Return LogMarker Line Decoration Style

ILineDecoration

▸ 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

▸ getMeaningDepthLimits(): Range

return meaning depth limits

Range

▸ 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(tr?): Rect

Return model limits

Rect

LogAbstractVisual.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

LogAbstractVisual.getName

▸ getNameBorderRadius(): number

Returns name label border radius

number

▸ getNameLabel(): string

Returns name to be displayed

string

▸ getNameLabelPosition(): AnchorType

Return name label position as an anchor point

AnchorType

▸ 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

properties object

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

▸ 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

▸ getTextOrientation(): Orientation

return orientation of text

Orientation

▸ getTextStyle(): TextStyle

Return text style

TextStyle

▸ getTrack(): ITrack

Returns parent track if LogTrack

ITrack

LogAbstractVisual.getTrack

▸ getVerticalTextOffset(): number

Gets vertical label offset in device space

number

▸ 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?): LogMarker

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

LogMarker

this

LogAbstractVisual.invalidate

▸ invalidateParent(bounds?, force?): LogMarker

Invalidate bounds

LogMarker

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

▸ isFillDepthLabel(): boolean

Return true if depth label fill style enabled. It is enabled by default.

boolean

▸ isFillNameLabel(): boolean

Return true if name label fill style enabled. It is enabled by default.

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

▸ isVisibleDepthBorder(): boolean

Return true if depth label border is visible. It is visible by default.

boolean

▸ isVisibleDepthLabel(): boolean

Return true if depth label is visible. It is visible by default.

boolean

▸ isVisibleNameBorder(): boolean

Return true if Name label border is visible. It is visible by default.

boolean

▸ isVisibleNameLabel(): boolean

Return true if name label is visible. It is visible by default.

boolean

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

Notify listeners of the Node

LogMarker

this

LogAbstractVisual.notify

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

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.

LogMarker

this

LogAbstractVisual.off

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

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.

LogMarker

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(): LogMarker

calls when microPosition has been changed

LogMarker

this

LogAbstractVisual.onMicroPositionChanged

▸ Protected onParentChanged(node): LogMarker

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

LogMarker

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): LogMarker

Removes css class from node

LogMarker

this

LogAbstractVisual.removeCssClass

▸ removeInvalidateHandler(handler): LogMarker

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

LogMarker

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): LogMarker

Rotate bounds around a given coordinate

LogMarker

this

LogAbstractVisual.rotate

▸ scale(xx, yy): LogMarker

Scale node

LogMarker

this

LogAbstractVisual.scale

▸ setAnimationStyle(animationStyle): LogMarker

Sets animation style

LogMarker

LogAbstractVisual.setAnimationStyle

▸ setAutoBounds(enable): LogMarker

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

LogMarker

this

LogAbstractVisual.setAutoBounds

▸ setBaseName(name): LogMarker

Sets base name of the visual

LogMarker

this

LogAbstractVisual.setBaseName

▸ setBounds(bounds): LogMarker

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

LogMarker

this

LogAbstractVisual.setBounds

▸ setClipStyle(style): LogMarker

Sets a new clipping style

LogMarker

this

LogAbstractVisual.setClipStyle

▸ setCss(style, merge?): LogMarker

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

LogMarker

this

LogAbstractVisual.setCss

▸ setCssClass(name): LogMarker

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

LogMarker

this

LogAbstractVisual.setCssClass

▸ setCssTransform(transform): LogMarker

Set CSS transformation

LogMarker

this

LogAbstractVisual.setCssTransform

▸ setDepth(depth): LogMarker

Set depth

LogMarker

this

▸ setDepthBorderRadius(radius): LogMarker

Sets depth label border radius

LogMarker

▸ setDepthLabel(depthLabel): LogMarker

Sets depth value to be displayed

LogMarker

this

▸ setDepthLabelPosition(anchorPoint): LogMarker

Set depth label position

LogMarker

this

▸ setDepthValue(depth, displayNameLabel?, displayDepthLabel?): LogMarker

Sets marker

LogMarker

this

▸ setDescription(description): LogMarker

Sets the description

LogMarker

this

LogAbstractVisual.setDescription

▸ setFillDepthLabel(enable): LogMarker

Specify depth label fill style enabled or not.

LogMarker

this

▸ setFillNameLabel(enable): LogMarker

Specify name label fill style enabled or not.

LogMarker

this

▸ setFillStyle(fillStyle, merge?): LogMarker

Specify fill style for both name and depth labels.

LogMarker

this

▸ setFillStyleDepth(fillStyle, merge?): LogMarker

Sets fill style of depth label

LogMarker

this

▸ setFillStyleName(fillStyle, merge?): LogMarker

Sets fill style of name label

LogMarker

this

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

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

Throws

if header name is null

LogMarker

this

LogAbstractVisual.setHeader

▸ setHorizontalTextOffset(offset): LogMarker

Sets horizontal label offset in device space

LogMarker

this

▸ setId(id): LogMarker

Allows the user to associate any identifier

LogMarker

this

LogAbstractVisual.setId

▸ setLineDecoration(lineDecoration): LogMarker

Specify LogMarker Line Decoration style

LogMarker

this

▸ setLineStyle(lineStyle, merge?): LogMarker

Sets line style

LogMarker

this

LogAbstractVisual.setLineStyle

▸ setLocalTransform(localTransform, force?): LogMarker

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