Class: Log2DVisual

• new Log2DVisual(options, autoUpdate)

• new Log2DVisual(options?, autoUpdate?)

Constructor

Throws

if the decimation strategy type is not based on the AbstractDecimationStrategy

LogAbstractVisual.constructor

▸ addCssClass(cssclass): Log2DVisual

Adds new css class to node

Log2DVisual

this

LogAbstractVisual.addCssClass

▸ addInvalidateHandler(handler): Log2DVisual

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

Log2DVisual

this

LogAbstractVisual.addInvalidateHandler

▸ Protected applyOpacity(context): Log2DVisual

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

Log2DVisual

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

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

Log2DVisual

clone

LogAbstractVisual.clone

▸ connectStyle(style, type, callback): Log2DVisual

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

Log2DVisual

this

LogAbstractVisual.connectStyle

▸ Protected copyConstructor(src, deepCopy?): Log2DVisual

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

Log2DVisual

this

LogAbstractVisual.copyConstructor

▸ disconnectStyle(style, type, callback): Log2DVisual

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

Log2DVisual

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

▸ enableColumnDecimation(enable): Log2DVisual

Enable columns decimation

Log2DVisual

this

▸ enableEventPropagation(enable): Log2DVisual

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

Log2DVisual

this

LogAbstractVisual.enableEventPropagation

▸ execute(delegate): Log2DVisual

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

Log2DVisual

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

▸ getAlignment(): ColumnAlignment

Return interpolation alignment

ColumnAlignment

wrapInterpolation

▸ getAnglesLimits(): Range

Returns angle limits

Range

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

LogAbstractVisual.getAnimationStyle

▸ getAutoAnglesLimits(): boolean

Returns the status of the auto angle limits

boolean

▸ 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

▸ getColorProvider(): ColorProvider

Gets color provider

ColorProvider

IColorProviderVisual.getColorProvider

▸ 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

▸ getData(): ArrayLogDataSource | Log2DVisualData

Returns data

ArrayLogDataSource | Log2DVisualData

▸ getDataLimits(fullLimits?): Rect

Rect

LogAbstractVisual.getDataLimits

▸ getDecimationStrategy(): AbstractDecimationStrategy

Get decimation strategy for dense areas

AbstractDecimationStrategy

▸ getDescription(): string

Gets the description

string

The description

LogAbstractVisual.getDescription

▸ getGapDistance(): number

Returns The maximum discontinuity distance to render discontinuity

number

gap distance

▸ getGapDistanceUnit(): AbstractUnit

Returns the unit of the gap distance

AbstractUnit

The gap distance unit

▸ getGapFillCutoffUnit(): AbstractUnit

Returns the unit of the cutoff used for removing NaN valued samples

AbstractUnit

The cutoff unit

▸ getGapFillCutoffValue(): number

Returns the value of the cutoff used for removing NaN valued samples

number

The cutoff value

▸ getGapUnit(): AbstractUnit

Returns the unit of the gap

AbstractUnit

The cutoff unit

▸ getGapValue(): number

Returns The maximum discontinuity allowed in depth or time

number

value

▸ 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

▸ getMaxDepth(): number

Returns maximum depth of the data set

number

▸ 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

▸ getMinDepth(): number

Returns minimum depth of the data set

number

▸ getModelLimits(): Rect

Returns parent model limits

Rect

LogAbstractVisual.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

LogAbstractVisual.getName

▸ getOffsets(): number | number[]

Returns the offset of data

number | number[]

offset array of the same size as data set

▸ 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

▸ getPlotType(): string

Gets plot type

string

▸ 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

▸ getRowAlignment(): RowAlignment

Return interpolation alignment

RowAlignment

row alignment

▸ getRowsInterpolation(): InterpolationType

Returns type of interpolation for rows values

InterpolationType

interpolation

▸ 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

▸ getWebGLRendering(): boolean

Gets webGL rendering

boolean

true, if webGL is used for rendering

▸ getWorldTransform(): Transformation

Retrieves the world transformation of the node to transform model coordinates to the parent track

Transformation

LogAbstractVisual.getWorldTransform

▸ getWrapInterpolation(): boolean

Return wrap interpolation

boolean

wrapInterpolation

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

Hit test in the device coordinates

Hits

hit test result

▸ invalidate(bounds?, force?): Log2DVisual

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

Log2DVisual

this

LogAbstractVisual.invalidate

▸ invalidateParent(bounds?, force?): Log2DVisual

Invalidate bounds

Log2DVisual

this

LogAbstractVisual.invalidateParent

▸ isAutoBounds(): boolean

Returns auto bounds value

boolean

LogAbstractVisual.isAutoBounds

▸ isColumnDecimationEnabled(): boolean

Returns if column decimation is enabled

boolean

status if it is enabled

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

Notify listeners of the Node

Log2DVisual

this

LogAbstractVisual.notify

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

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.

Log2DVisual

this

LogAbstractVisual.off

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

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.

Log2DVisual

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

calls when microPosition has been changed

Log2DVisual

this

LogAbstractVisual.onMicroPositionChanged

▸ Protected onParentChanged(node): Log2DVisual

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

Log2DVisual

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

Removes css class from node

Log2DVisual

this

LogAbstractVisual.removeCssClass

▸ removeInvalidateHandler(handler): Log2DVisual

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

Log2DVisual

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

▸ Protected requestData(range, scale, callback?): void

void

▸ rotate(theta, x, y): Log2DVisual

Rotate bounds around a given coordinate

Log2DVisual

this

LogAbstractVisual.rotate

▸ scale(xx, yy): Log2DVisual

Scale node

Log2DVisual

this

LogAbstractVisual.scale

▸ setAlignment(alignment): Log2DVisual

Set interpolation alignment

Log2DVisual

this

▸ setAnglesLimits(left, right): Log2DVisual

Sets angles limits of the data. By default it is from 0 to 2*PI

Log2DVisual

▸ setAnimationStyle(animationStyle): Log2DVisual

Sets animation style

Log2DVisual

LogAbstractVisual.setAnimationStyle

▸ setAutoAnglesLimits(enable): Log2DVisual

Enable / disable usage limits from data. By default automatic limit is disabled

Log2DVisual

▸ setAutoBounds(enable): Log2DVisual

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

Log2DVisual

this

LogAbstractVisual.setAutoBounds

▸ setBaseName(name): Log2DVisual

Sets base name of the visual

Log2DVisual

this

LogAbstractVisual.setBaseName

▸ setBounds(bounds): Log2DVisual

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

Log2DVisual

this

LogAbstractVisual.setBounds

▸ setClipStyle(style): Log2DVisual

Sets a new clipping style

Log2DVisual

this

LogAbstractVisual.setClipStyle

▸ setColorProvider(colorProvider?): Log2DVisual

Sets color provider

Log2DVisual

▸ setCss(style, merge?): Log2DVisual

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

Log2DVisual

this

LogAbstractVisual.setCss

▸ setCssClass(name): Log2DVisual

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

Log2DVisual

this

LogAbstractVisual.setCssClass

▸ setCssTransform(transform): Log2DVisual

Set CSS transformation

Log2DVisual

this

LogAbstractVisual.setCssTransform

▸ setData(data, autoUpdate?): Log2DVisual

Sets data

Log2DVisual

this

▸ setDecimationStrategy(decimationStrategy): Log2DVisual

Set decimation strategy for dense areas

Throws

if the decimation strategy is null or its type is not based on the AbstractDecimationStrategy

Log2DVisual

▸ setDescription(description): Log2DVisual

Sets the description

Log2DVisual

this

LogAbstractVisual.setDescription

▸ setGapDistance(distance, merge?): Log2DVisual

Set the value of the gap distance. Discontinuity will be rendered in specified distance, use gap value if distance is not specified or NaN

Log2DVisual

this

▸ setGapDistanceUnit(unit): Log2DVisual

Sets the unit of the gap distance to show discontinuity in sample when the cutoff value is non zero and the unit is convertible to the index unit. If unit is not specified then curve index unit is used. if a depth or time interval is less than specified cutoff value then interval is connected and NaN values between are removed.

Log2DVisual

this

▸ setGapFillCutoffUnit(unit): Log2DVisual

Sets the unit of the cutoff used for removing NaN valued samples. Gaps will only be 'filled' when the cutoff value is non zero and the unit is convertible to the index unit. If unit is not specified then curve index unit is used. if a depth or time interval is less than specified cutoff value then interval is connected and NaN values between are removed.

Log2DVisual

this

▸ setGapFillCutoffValue(cutoff, merge?): Log2DVisual

Sets the value of the cutoff used for removing NaN valued samples. Gaps will only be 'filled' when the cutoff value is non zero and the unit is convertible to the index unit.

Log2DVisual

this

▸ setGapUnit(unit): Log2DVisual

Sets the unit of the gap to show discontinuity in sample when the cutoff value is non zero and the unit is convertible to the index unit. If unit is not specified then curve index unit is used. if a depth or time interval is less than specified cutoff value then interval is connected and NaN values between are removed.

Log2DVisual

this

▸ setGapValue(value, merge?): Log2DVisual

Set the value of the gap. Value will be used to disconnect the sample if the distance between two samples in depth or time is more than specified value

Log2DVisual

this

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

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

Throws

if header name is null

Log2DVisual

this

LogAbstractVisual.setHeader

▸ setHorizontalFlip(enable): Log2DVisual

Set horizontal flip of the representation

Log2DVisual

this

▸ setId(id): Log2DVisual

Allows the user to associate any identifier

Log2DVisual

this

LogAbstractVisual.setId

▸ setLineStyle(lineStyle, merge?): Log2DVisual

Sets line style

Log2DVisual

this

LogAbstractVisual.setLineStyle

▸ setLocalTransform(localTransform, force?): Log2DVisual

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

Log2DVisual

this

LogAbstractVisual.setLocalTransform

▸ setMarginsStyle(margins, merge?): Log2DVisual

Sets margins style

Log2DVisual

this

LogAbstractVisual.setMarginsStyle

▸ setMicroPosition(left, right): Log2DVisual

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

Log2DVisual

this

LogAbstractVisual.setMicroPosition

▸ setName(name): Log2DVisual

Sets name of the node

Log2DVisual

this

LogAbstractVisual.setName

▸ setNotification(notify, force?): Log2DVisual

set notification state

Log2DVisual

this

LogAbstractVisual.setNotification

▸ setOffsets(offsets): Log2DVisual

Sets the offset of data

Example

// following example shows how to use setOffsets() method to rotate Log2DVisual
let degreesToRadians = function(degrees){
return degrees * Math.PI / 180;
};

function createOffsets (data, offset) {
let offsets = [];
for (let i = 0; i < data.getRows().length; i++)
offsets.push(offset);
return offsets;
}

log2dVisual.setOffsets(createOffsets(log2d.getData(), degreesToRadians(val)));

Log2DVisual

▸ setOpacity(opacity, blendMode?): Log2DVisual

Sets node opacity

Log2DVisual

this

LogAbstractVisual.setOpacity

▸ setPlotType(mode): Log2DVisual

Sets Plot type to specify linear o step interpolation of values in columns

In linear interpolation mode it interpolates value from the previous column to the end of the current column and the first column is ignored, which can be represented as end of the sector if consider each column as a sector. if it is necessary to start from beginning of the sector or in the middle then you can specify offset equal to the first column angle or the half the first column angle.