Class: LogMudLogSection<T>

• new LogMudLogSection<T>(depths?, values?, fillstyles?)

Constructor

LogAbstractVisual.constructor

• new LogMudLogSection<T>(params?)

Constructor

LogAbstractVisual.constructor

▸ addCssClass(cssclass): LogMudLogSection<T>

Adds new css class to node

LogMudLogSection<T>

this

LogAbstractVisual.addCssClass

▸ addInvalidateHandler(handler): LogMudLogSection<T>

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

LogMudLogSection<T>

this

LogAbstractVisual.addInvalidateHandler

▸ Protected applyOpacity(context): LogMudLogSection<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

LogMudLogSection<T>

this

LogAbstractVisual.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

LogAbstractVisual.applyResponsiveStyle

▸ checkCollision(context): boolean

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

boolean

LogAbstractVisual.checkCollision

▸ clone(): LogMudLogSection<T>

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

LogMudLogSection<T>

clone

LogAbstractVisual.clone

▸ connectStyle(style, type, callback): LogMudLogSection<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

LogMudLogSection<T>

this

LogAbstractVisual.connectStyle

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

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

LogMudLogSection<T>

this

LogAbstractVisual.copyConstructor

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

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

LogMudLogSection<T>

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

LogMudLogSection<T>

this

LogAbstractVisual.enableEventPropagation

▸ execute(delegate): LogMudLogSection<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");
});

LogMudLogSection<T>

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

▸ getAggregation(): Aggregation

Returns symbols aggregation

Aggregation

object containing aggregation properties

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

Returns bounds in the parent coordinates

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

▸ getCornerRadius(): number

return corner radius

number

radius

▸ 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

▸ getDepths(): number[]

Returns array of depths

number[]

▸ getDescription(): string

Gets the description

string

The description

LogAbstractVisual.getDescription

▸ getEllipsisString(): string

Get ellipsis text to string

string

▸ getEvenFillStyle(): FillStyle

Returns even fill style

FillStyle

▸ getEvenLineStyle(): LineStyle

Returns even line style

LineStyle

▸ getEvenSymbol(): SymbolShape

Returns even symbol shape

SymbolShape

▸ getEvenTextStyle(): TextStyle

Returns even text style

TextStyle

▸ getFillMode(): FillMode

Returns fill mode

FillMode

▸ getFillStyles(): FillStyle[] | FillStylesCallback<T>

Returns array of fill styles or a fill style callback

FillStyle[] | FillStylesCallback<T>

▸ 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

▸ getLineStyles(): LineStyle[] | LineStylesCallback<T>

Returns array of line styles or a line style callback

LineStyle[] | LineStylesCallback<T>

▸ 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>

margins

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

▸ getOddFillStyle(): FillStyle

Returns odd fill style

FillStyle

▸ getOddLineStyle(): LineStyle

Returns odd line style

LineStyle

▸ getOddSymbol(): SymbolShape

Returns odd symbol shape

SymbolShape

▸ getOddTextStyle(): TextStyle

Returns odd text style

TextStyle

▸ getOpacity(): number

Returns current node opacity

number

opacity

LogAbstractVisual.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

LogAbstractVisual.getOpacityBlendMode

▸ getPaddingStyle(): SpaceStyle<string | number>

Returns padding style

SpaceStyle<string | number>

padding

▸ getParent(): Node

Return parent node

Node

parent node

LogAbstractVisual.getParent

▸ getProperties(): OptionsOut<T>

Gets all the properties pertaining to this object

OptionsOut<T>

properties

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

▸ getSelectedFillStyle(): FillStyle | SelectedFillStylesCallback<T>

Returns selected segment fill style

FillStyle | SelectedFillStylesCallback<T>

fill style

▸ getSelectedIndices(): number[]

Return selected indices

number[]

selected indices

▸ getSelectedLineStyle(): LineStyle | SelectedLineStylesCallback<T>

Returns selected segment line style

LineStyle | SelectedLineStylesCallback<T>

line style

▸ getSelectedSymbol(): SymbolShape | SelectedSymbolStylesCallback<T>

Return selected segment symbol

SymbolShape | SelectedSymbolStylesCallback<T>

symbol

▸ getSelectedTextStyle(): TextStyle | SelectedTextStylesCallback<T>

Returns selected segment text style

TextStyle | SelectedTextStylesCallback<T>

text style

▸ getSymbolMarginsStyle(): SpaceStyle<string | number>

Return symbols margins style

SpaceStyle<string | number>

margins

▸ getSymbolPosition(): SymbolPosition

Returns symbols position

SymbolPosition

▸ getSymbols(): SymbolShape | SymbolShape[] | SymbolStylesCallback<T>

Returns array of symbol shapes or a symbol shape callback

SymbolShape | SymbolShape[] | SymbolStylesCallback<T>

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

LogAbstractVisual.getTag

▸ getTextAlign(): TextAlign

Returns text alignment

TextAlign

▸ getTextOrientation(): TextOrientation

Returns text orientation

TextOrientation

▸ getTextStyle(): TextStyle

Returns a text style

TextStyle

▸ getTextStyles(): TextStyle[] | TextStylesCallback<T>

Returns array of text styles or a text style callback

TextStyle[] | TextStylesCallback<T>

▸ getTrack(): ITrack

Returns parent track if LogTrack

ITrack

LogAbstractVisual.getTrack

▸ getValueAtDepth(depth): Object

Returns value closest to specified depth

Object

value properties, null if no section found

▸ getValueAtIndex(index, depth?): Object

Returns value at specified index

Object

value properties, null if no section found

▸ getValues(): ValueCallback<T> | T[]

Returns array of values

ValueCallback<T> | T[]

▸ 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

▸ getWrapMode(): WrapMode

Return text wrapping mode

WrapMode

▸ 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

▸ hitTest(area, radius?): SectionInfo[]

Hit test in the device coordinate. This method checks if any point is intersects <html>node inside text

SectionInfo[]

selected indices

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

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

LogMudLogSection<T>

this

LogAbstractVisual.invalidate

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

Invalidate bounds

LogMudLogSection<T>

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

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

Notify listeners of the Node

LogMudLogSection<T>

this

LogAbstractVisual.notify

▸ off<E>(type?, callback?): LogMudLogSection<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.

LogMudLogSection<T>

this

LogAbstractVisual.off

▸ on<E>(type, callback): LogMudLogSection<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.

LogMudLogSection<T>

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(): LogMudLogSection<T>

calls when microPosition has been changed

LogMudLogSection<T>

this

LogAbstractVisual.onMicroPositionChanged

▸ Protected onParentChanged(node): LogMudLogSection<T>

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

LogMudLogSection<T>

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): LogMudLogSection<T>

Removes css class from node

LogMudLogSection<T>

this

LogAbstractVisual.removeCssClass

▸ removeInvalidateHandler(handler): LogMudLogSection<T>

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

LogMudLogSection<T>

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): LogMudLogSection<T>

Rotate bounds around a given coordinate

LogMudLogSection<T>

this

LogAbstractVisual.rotate

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

Scale node

LogMudLogSection<T>

this

LogAbstractVisual.scale

▸ setAggregation(aggregation): LogMudLogSection<T>

Set symbols aggregation

LogMudLogSection<T>

this

▸ setAnimationStyle(animationStyle): LogMudLogSection<T>

Sets animation style

LogMudLogSection<T>

LogAbstractVisual.setAnimationStyle

▸ setAutoBounds(enable): LogMudLogSection<T>

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

LogMudLogSection<T>

this

LogAbstractVisual.setAutoBounds

▸ setBaseName(name): LogMudLogSection<T>

Sets base name of the visual

LogMudLogSection<T>

this

LogAbstractVisual.setBaseName

▸ setBounds(bounds): LogMudLogSection<T>

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

LogMudLogSection<T>

this

LogAbstractVisual.setBounds

▸ setClipStyle(style): LogMudLogSection<T>

Sets a new clipping style

LogMudLogSection<T>

this

LogAbstractVisual.setClipStyle

▸ setCornerRadius(radius): LogMudLogSection<T>

Set border radius in device coordinates.

LogMudLogSection<T>

this

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

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

LogMudLogSection<T>

this

LogAbstractVisual.setCss

▸ setCssClass(name): LogMudLogSection<T>

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

LogMudLogSection<T>

this

LogAbstractVisual.setCssClass

▸ setCssTransform(transform): LogMudLogSection<T>

Set CSS transformation

LogMudLogSection<T>

this

LogAbstractVisual.setCssTransform

▸ setDepthsAndValues(depths, values): LogMudLogSection<T>

Sets array of depths and array of corresponding values

LogMudLogSection<T>

this

▸ setDescription(description): LogMudLogSection<T>

Sets the description

LogMudLogSection<T>

this

LogAbstractVisual.setDescription

▸ setEllipsisString(str): LogMudLogSection<T>

Sets ellipsis text to string under 15 characters

LogMudLogSection<T>

this

▸ setEvenFillStyle(fillStyle, merge?): LogMudLogSection<T>

Sets even fill style

LogMudLogSection<T>

this

▸ setEvenLineStyle(lineStyle, merge?): LogMudLogSection<T>

Sets even line style

LogMudLogSection<T>

this

▸ setEvenSymbol(symbol): LogMudLogSection<T>

Sets even symbol shape

LogMudLogSection<T>

this

▸ setEvenTextStyle(textStyle, merge?): LogMudLogSection<T>

Sets even text style