Class: LogCurve

• DefaultClippingType

• new LogCurve(data?, autoUpdate?)

LogPointSet.constructor

• new LogCurve(params?)

LogPointSet.constructor

• Static get DefaultClippingType(): ClippingType

Default Clipping type

ClippingType

▸ Protected _getDisplayMode(): DisplayMode

Returns display mode

DisplayMode

▸ Protected _setDisplayMode(displayMode): LogCurve

Sets display mode

LogCurve

this

▸ addCssClass(cssclass): LogCurve

Adds new css class to node

LogCurve

this

LogPointSet.addCssClass

▸ addInvalidateHandler(handler): LogCurve

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

LogCurve

this

LogPointSet.addInvalidateHandler

▸ Protected applyOpacity(context): LogCurve

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

LogCurve

this

LogPointSet.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

LogPointSet.applyResponsiveStyle

▸ checkCollision(context): boolean

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

boolean

LogPointSet.checkCollision

▸ clone(): LogCurve

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

LogCurve

clone

LogPointSet.clone

▸ connectStyle(style, type, callback): LogCurve

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

LogCurve

this

LogPointSet.connectStyle

▸ convertCurveToDataValue(v): number

Converts curve model value to data sample value If the data source is not set, the method will yield NaN as a result.

number

a data value

▸ convertDataToCurveValue(v, d?): number

Converts data sample value to curve model value If the data source is not set, the method will yield NaN as a result.

number

a curve value

▸ Protected copyConstructor(src, deepCopy?): LogCurve

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

LogCurve

this

LogPointSet.copyConstructor

▸ disconnectStyle(style, type, callback): LogCurve

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

LogCurve

this

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

LogPointSet.dispose

▸ enableEventPropagation(enable): LogCurve

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

LogCurve

this

LogPointSet.enableEventPropagation

▸ execute(delegate): LogCurve

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

LogCurve

The result if any or this

LogPointSet.execute

▸ execute<T>(delegate): T

T

LogPointSet.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

LogPointSet.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

LogPointSet.getAnimationStyle

▸ getAutoLimitsStrategy(): LogCurveLimitsStrategy

Return auto limits strategy. If it is null then default logic will be used depending on limits type

LogCurveLimitsStrategy

▸ getBarLineStyle(): LineStyle

Helper method to get value-bars line style

LineStyle

▸ getBaseName(): string

Returns the base name

string

The base name

LogPointSet.getBaseName

▸ getBounds(): Rect

Return bound in the parent coordinates

Rect

LogPointSet.getBounds

▸ getClassName(): string

string

LogPointSet.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

LogPointSet.getClipStyle

▸ getContentsTransform(): Transformation

Retrieves the world transformation of the spatial

Transformation

LogPointSet.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

LogPointSet.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

LogPointSet.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

LogPointSet.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

LogPointSet.getCssTransform

▸ getDataLimits(fullLimits?): Rect

Return meaning data limits

Rect

LogPointSet.getDataLimits

▸ getDataRange(fromDepth, toDepth, transformation?): AbstractScaledData

Returns data range

AbstractScaledData

data range

▸ getDataSource(): LogAbstractData

Returns WellLog Data

LogAbstractData

▸ getDescription(): string

Gets the description

string

The description

LogPointSet.getDescription

▸ getDisplayMode(): string[]

Returns display mode

string[]

any combination of values: 'line', 'symbol', 'value', 'bar' or an empty array

▸ getDisplayUnit(): AbstractUnit

Returns display unit

AbstractUnit

▸ getDrawOutOfRangeValues(): boolean

Returns true if zero is a valid value in logarithmic mode

boolean

▸ getGapFillCutoffMode(): CutoffMode

Return cutoff mode

CutoffMode

▸ 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

▸ getGradientLineStyle(): LogGradientStyle

Returns log gradient style

LogGradientStyle

log gradient style

▸ getHeader(name): LogVisualHeader<Node>

Return the header registered by the name

LogVisualHeader<Node>

header

LogPointSet.getHeader

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

Return an object that contains all headers registered with the visual

Record<string, LogVisualHeader<Node>>

headers

LogPointSet.getHeaders

▸ getHideOverlappedValues(): boolean

Gets hide overlapped values flag

boolean

hide overlapped values

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

LogPointSet.getId

▸ getInterpolationEdge(): InterpolationEdge

Returns edge values interpolation type

InterpolationEdge

▸ getInterpolationType(): InterpolationType

Returns interpolation type

InterpolationType

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

LogPointSet.getInvalidateMethod

▸ getLimitsType(): LimitsType

Returns limits type

LimitsType

▸ getLineStyle(): LineStyle

Returns line style

LineStyle

LogPointSet.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

LogPointSet.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

LogPointSet.getMarginsStyle

▸ getMaxWraps(): number

Returns maximum count of the wraps

number

▸ getMaximumClippingLimit(): number

Returns maximum clipping limit

number

▸ getMaximumNormalizationLimit(): number

Returns maximum normalization limit

number

▸ getMicroPositionLeft(): number

Returns micro position left

number

LogPointSet.getMicroPositionLeft

▸ getMicroPositionRight(): number

Returns micro position right

number

LogPointSet.getMicroPositionRight

▸ Protected getMicroPositionTransformation(): Transformation

Returns micro position transformation

Transformation

micro position transformation

LogPointSet.getMicroPositionTransformation

▸ getMinimumClippingLimit(): number

Returns minimum clipping limit

number

▸ getMinimumNormalizationLimit(): number

Returns minimum normalization limit

number

▸ getModelLimits(): Rect

Returns model limits

Rect

LogPointSet.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

LogPointSet.getName

▸ getNearestSampleIndex(pt, maxDistance?, transformation?): number

Return nearest original sample index from data source by device point

number

index of the sample. if data is not specified or sample is nof found it returns -1

▸ getNeatLogLimits(): boolean

Gets the value of centerOnZeroOnNegativeMin property

boolean

▸ getNullValueSymbol(): SymbolShape

Returns symbol to be used to draw markers for null value

SymbolShape

▸ getOpacity(): number

Returns current node opacity

number

opacity

LogPointSet.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

LogPointSet.getOpacityBlendMode

▸ getOptimizationBar(): boolean

Returns bars optimization flag

boolean

▸ getOptimizationCurve(): boolean

Returns curve optimization flag

boolean

▸ getOptimizationSymbol(): boolean

Returns symbol optimization flag

boolean

▸ getOptimizationValue(): boolean

Returns values optimization flag

boolean

▸ getParent(): Node

Return parent node

Node

parent node

LogPointSet.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

LogPointSet.getProperties

▸ getProperty(name): any

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

any

LogPointSet.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

LogPointSet.getPropertyKeys

▸ getReferenceCurve(): LogCurve | LogReferenceLine

Returns reference curve

LogCurve | LogReferenceLine

reference curve

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

LogPointSet.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

LogPointSet.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

LogPointSet.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

LogPointSet.getScaleScrollStrategy

▸ getScaleType(): ScaleType

Returns current scale type.

ScaleType

▸ getScaledData(transformation?): AbstractScaledData

Returns scaled data

AbstractScaledData

LogPointSet.getScaledData

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

LogPointSet.getSceneTransform

▸ getSymbol(): SymbolShape

Returns symbol to be used to draw markers

SymbolShape

▸ getSymbolDecimationDistance(): number

Returns symbol decimation distance

number

▸ getSymbolDecimationStep(): number

Returns symbol decimation step

number

▸ getSymbolFormatter(): SymbolFormatterCallback

Return symbol formatter

SymbolFormatterCallback

▸ getSymbolsGap(): Dimension

Returns symbols gap

Dimension

▸ getSymbolsSkipIntersectionRatio(): number

Gets symbols' skip intersection ratio

number

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

LogPointSet.getTag

▸ getTextAnchorType(): AnchorType

Gets text anchor type

AnchorType

▸ getTextAutoAlignment(): boolean

Gets status if automatic text alignment is enabled for text values which intersect border of the track

boolean

enable enable automatic text alignment

▸ getTextAutoAlignmentOffset(): Point

Gets text offset from anchor for automatic text alignment

Point

text offset for automatic text alignment

▸ getTextDecimationStep(): number

Returns text decimation step

number

▸ getTextReference(): TextReference

Gets sample's text reference type: 'track' or 'sample'

TextReference

▸ getTextStyle(): TextStyle

Gets text style

TextStyle

▸ getTrack(): ITrack

Returns parent track if LogTrack

ITrack

LogPointSet.getTrack

▸ getValue(depth): number

Returns interpolated value

number

▸ getValueDataLimits(): Range

Returns original data value limits

Range

▸ getValueFormat(): NumberFormat

Returns formatter to format values

NumberFormat

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

LogPointSet.getVisible

▸ getWorldTransform(): Transformation

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

Transformation

LogPointSet.getWorldTransform

▸ getWrapLineStyleHandler(): WrapLineStyleHandlerCallback

Returns wrap line style handler

WrapLineStyleHandlerCallback

wrap style handler

▸ getZIndex(): number

Returns node z-index (null if not set)

number

LogPointSet.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

LogPointSet.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

LogPointSet.hasEventListener

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

Hit test symbols of the curve in the device coordinates

number[]

a collection of selected symbols indices

▸ invalidate(bounds?, force?): LogCurve

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

LogCurve

this

LogPointSet.invalidate

▸ invalidateParent(bounds?, force?): LogCurve

Invalidate bounds

LogCurve

this

LogPointSet.invalidateParent

▸ isAutoBounds(): boolean

Enable automatic bounds. If auto bounds is enabled then it equals to parent model limits

boolean

LogPointSet.isAutoBounds

▸ isBarsRightAligned(): boolean

Returns true if value-bars right align is true

boolean

▸ isClippingEnabled(): boolean

Returns true if clipping is enabled

boolean

▸ isCustomLimits(): boolean

Returns true if limits are custom

boolean

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

LogPointSet.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

LogPointSet.isEventPropagationEnabled

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

horizontal flip

LogPointSet.isHorizontalFlip

▸ isNormalizationEnabled(): boolean

Returns true if normalization is enabled

boolean

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

LogPointSet.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

LogPointSet.isSelectable

▸ isSilent(): boolean

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

boolean

LogPointSet.isSilent

▸ isVisibleBar(): boolean

Returns true if value-bars are visible

boolean

▸ isVisibleLine(): boolean

Returns true if line is visible (convenience method)

boolean

▸ isVisibleNullValueSymbol(): boolean

Returns true if symbol to be used to draw markers for null value is visible

boolean

▸ isVisibleSymbol(): boolean

Returns true if symbols are visible (convenience method)

boolean

▸ isVisibleValue(): boolean

Returns true if values are visible (convenience method)

boolean

▸ isWrapping(): boolean

Returns whether wrapping is enabled

boolean

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

Notify listeners of the Node

LogCurve

this

LogPointSet.notify

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

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.

LogCurve

this

LogPointSet.off

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

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.

LogCurve

this

LogPointSet.on

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

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

void

LogPointSet.onHeaderSet

▸ Protected onMicroPositionChanged(): LogCurve

calls when microPosition has been changed

LogCurve

this

LogPointSet.onMicroPositionChanged

▸ Protected onParentChanged(node): LogCurve

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

LogCurve

this

LogPointSet.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

LogPointSet.onVisibilityChanged

▸ Protected postRendering(context): void

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

void

LogPointSet.postRendering

▸ Protected preRendering(context): void

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

void

LogPointSet.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

LogPointSet.registerAnimationStyle

▸ removeCssClass(cssclass): LogCurve

Removes css class from node

LogCurve

this

LogPointSet.removeCssClass

▸ removeInvalidateHandler(handler): LogCurve

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

LogCurve

this

LogPointSet.removeInvalidateHandler

▸ render(context): void

Renders node

void

LogPointSet.render

▸ renderAsync(context, callback): void

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

void

LogPointSet.renderAsync

▸ Protected renderContent(context): void

Renders node content

void

LogPointSet.renderContent

▸ resetClippingLimits(): LogCurve

This method resets clipping limits

LogCurve

this

▸ resetNormalizationLimits(): LogCurve

This method resets custom normalization limits

LogCurve

this

▸ rotate(theta, x, y): LogCurve

Rotate bounds around a given coordinate

LogCurve

this

LogPointSet.rotate

▸ scale(xx, yy): LogCurve

Scale node