Class: CompositeLogCurve

• DefaultClippingType

• new CompositeLogCurve(data?, autoUpdate?)

Constructor

LogCurve.constructor

• new CompositeLogCurve(params?)

Constructor

LogCurve.constructor

• Static get DefaultClippingType(): ClippingType

Default Clipping type

ClippingType

LogCurve.DefaultClippingType

▸ Protected _getDisplayMode(): DisplayMode

Returns display mode

DisplayMode

LogCurve._getDisplayMode

▸ Protected _setDisplayMode(displayMode): CompositeLogCurve

Sets display mode

CompositeLogCurve

this

LogCurve._setDisplayMode

▸ addCssClass(cssclass): CompositeLogCurve

Adds new css class to node

CompositeLogCurve

this

LogCurve.addCssClass

▸ addInvalidateHandler(handler): CompositeLogCurve

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

CompositeLogCurve

this

LogCurve.addInvalidateHandler

▸ Protected applyOpacity(context): CompositeLogCurve

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

CompositeLogCurve

this

LogCurve.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

LogCurve.applyResponsiveStyle

▸ checkCollision(context): boolean

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

boolean

LogCurve.checkCollision

▸ clone(): CompositeLogCurve

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

CompositeLogCurve

clone

LogCurve.clone

▸ connectStyle(style, type, callback): CompositeLogCurve

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

CompositeLogCurve

this

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

LogCurve.convertCurveToDataValue

▸ 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

LogCurve.convertDataToCurveValue

▸ Protected copyConstructor(src, deepCopy?): CompositeLogCurve

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

CompositeLogCurve

this

LogCurve.copyConstructor

▸ disconnectStyle(style, type, callback): CompositeLogCurve

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

CompositeLogCurve

this

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

LogCurve.dispose

▸ enableEventPropagation(enable): CompositeLogCurve

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

CompositeLogCurve

this

LogCurve.enableEventPropagation

▸ execute(delegate): CompositeLogCurve

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

CompositeLogCurve

The result if any or this

LogCurve.execute

▸ execute<T>(delegate): T

T

LogCurve.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

LogCurve.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

LogCurve.getAnimationStyle

▸ getAutoLimitsStrategy(): LogCurveLimitsStrategy

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

LogCurveLimitsStrategy

LogCurve.getAutoLimitsStrategy

▸ getBarLineStyle(): LineStyle

Helper method to get value-bars line style

LineStyle

LogCurve.getBarLineStyle

▸ getBaseName(): string

Returns the base name

string

The base name

LogCurve.getBaseName

▸ getBounds(): Rect

Return curve bounds

Rect

LogCurve.getBounds

▸ getClassName(): string

string

LogCurve.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

LogCurve.getClipStyle

▸ getContentsTransform(): Transformation

Retrieves the world transformation of the spatial

Transformation

LogCurve.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

LogCurve.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

LogCurve.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

LogCurve.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

LogCurve.getCssTransform

▸ getDataLimits(fullLimits?): Rect

Return meaning data limits

Rect

LogCurve.getDataLimits

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

Returns data range

AbstractScaledData

data range

LogCurve.getDataRange

▸ getDataSource(): LogAbstractData

Returns WellLog Data

LogAbstractData

LogCurve.getDataSource

▸ getDescription(): string

Gets the description

string

The description

LogCurve.getDescription

▸ getDisplayMode(): string[]

Returns display mode

string[]

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

LogCurve.getDisplayMode

▸ getDisplayUnit(): AbstractUnit

Returns display unit

AbstractUnit

LogCurve.getDisplayUnit

▸ getDrawOutOfRangeValues(): boolean

Returns true if zero is a valid value in logarithmic mode

boolean

LogCurve.getDrawOutOfRangeValues

▸ getGapFillCutoffMode(): CutoffMode

Return cutoff mode

CutoffMode

LogCurve.getGapFillCutoffMode

▸ getGapFillCutoffUnit(): AbstractUnit

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

AbstractUnit

The cutoff unit

LogCurve.getGapFillCutoffUnit

▸ getGapFillCutoffValue(): number

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

number

The cutoff value

LogCurve.getGapFillCutoffValue

▸ getGapUnit(): AbstractUnit

Returns the unit of the gap

AbstractUnit

The cutoff unit

LogCurve.getGapUnit

▸ getGapValue(): number

Returns The maximum discontinuity allowed in depth or time

number

value

LogCurve.getGapValue

▸ getGradientLineStyle(): LogGradientStyle

Returns log gradient style

LogGradientStyle

log gradient style

LogCurve.getGradientLineStyle

▸ getHeader(name): LogVisualHeader<Node>

Return the header registered by the name

LogVisualHeader<Node>

header

LogCurve.getHeader

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

Return an object that contains all headers registered with the visual

Record<string, LogVisualHeader<Node>>

headers

LogCurve.getHeaders

▸ getHideOverlappedValues(): boolean

Gets hide overlapped values flag

boolean

hide overlapped values

LogCurve.getHideOverlappedValues

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

LogCurve.getId

▸ getInterpolationEdge(): InterpolationEdge

Returns edge values interpolation type

InterpolationEdge

LogCurve.getInterpolationEdge

▸ getInterpolationType(): InterpolationType

Returns interpolation type

InterpolationType

LogCurve.getInterpolationType

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

LogCurve.getInvalidateMethod

▸ getLeftFill(): LogFill

Return left fill

LogFill

▸ getLeftFillType(): FillType

returns the left fill type

FillType

▸ getLeftReferencePointSet(): LogCurve | LogReferenceLine

Sets reference point set

LogCurve | LogReferenceLine

▸ getLimitsType(): LimitsType

Returns limits type

LimitsType

LogCurve.getLimitsType

▸ getLineStyle(): LineStyle

Returns line style

LineStyle

LogCurve.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

LogCurve.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

LogCurve.getMarginsStyle

▸ getMaxWraps(): number

Returns maximum count of the wraps

number

LogCurve.getMaxWraps

▸ getMaximumClippingLimit(): number

Returns maximum clipping limit

number

LogCurve.getMaximumClippingLimit

▸ getMaximumNormalizationLimit(): number

Returns maximum normalization limit

number

LogCurve.getMaximumNormalizationLimit

▸ getMicroPositionLeft(): number

Returns micro position left

number

LogCurve.getMicroPositionLeft

▸ getMicroPositionRight(): number

Returns micro position right

number

LogCurve.getMicroPositionRight

▸ Protected getMicroPositionTransformation(): Transformation

Returns micro position transformation

Transformation

micro position transformation

LogCurve.getMicroPositionTransformation

▸ getMinimumClippingLimit(): number

Returns minimum clipping limit

number

LogCurve.getMinimumClippingLimit

▸ getMinimumNormalizationLimit(): number

Returns minimum normalization limit

number

LogCurve.getMinimumNormalizationLimit

▸ getModelLimits(): Rect

Returns model limits

Rect

LogCurve.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

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

LogCurve.getNearestSampleIndex

▸ getNeatLogLimits(): boolean

Gets the value of centerOnZeroOnNegativeMin property

boolean

LogCurve.getNeatLogLimits

▸ getNullValueSymbol(): SymbolShape

Returns symbol to be used to draw markers for null value

SymbolShape

LogCurve.getNullValueSymbol

▸ getOpacity(): number

Returns current node opacity

number

opacity

LogCurve.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

LogCurve.getOpacityBlendMode

▸ getOptimizationBar(): boolean

Returns bars optimization flag

boolean

LogCurve.getOptimizationBar

▸ getOptimizationCurve(): boolean

Returns curve optimization flag

boolean

LogCurve.getOptimizationCurve

▸ getOptimizationSymbol(): boolean

Returns symbol optimization flag

boolean

LogCurve.getOptimizationSymbol

▸ getOptimizationValue(): boolean

Returns values optimization flag

boolean

LogCurve.getOptimizationValue

▸ getParent(): Node

Return parent node

Node

parent node

LogCurve.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

LogCurve.getProperties

▸ getProperty(name): any

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

any

LogCurve.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

LogCurve.getPropertyKeys

▸ getReferenceCurve(): LogCurve | LogReferenceLine

Returns reference curve

LogCurve | LogReferenceLine

reference curve

LogCurve.getReferenceCurve

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

LogCurve.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

LogCurve.getResponsiveStyle

▸ getRightFill(): LogFill

Return right fill

LogFill

▸ getRightFillType(): FillType

returns the right fill type

FillType

▸ getRightReferencePointSet(): LogCurve | LogReferenceLine

returns the reference point set

LogCurve | LogReferenceLine

▸ getRoot(): Node

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

Node

the root node

LogCurve.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

LogCurve.getScaleScrollStrategy

▸ getScaleType(): ScaleType

Returns current scale type.

ScaleType

LogCurve.getScaleType

▸ getScaledData(transformation?): AbstractScaledData

Returns scaled data

AbstractScaledData

LogCurve.getScaledData

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

LogCurve.getSceneTransform

▸ getSymbol(): SymbolShape

Returns symbol to be used to draw markers

SymbolShape

LogCurve.getSymbol

▸ getSymbolDecimationDistance(): number

Returns symbol decimation distance

number

LogCurve.getSymbolDecimationDistance

▸ getSymbolDecimationStep(): number

Returns symbol decimation step

number

LogCurve.getSymbolDecimationStep

▸ getSymbolFormatter(): SymbolFormatterCallback

Return symbol formatter

SymbolFormatterCallback

LogCurve.getSymbolFormatter

▸ getSymbolsGap(): Dimension

Returns symbols gap

Dimension

LogCurve.getSymbolsGap

▸ getSymbolsSkipIntersectionRatio(): number

Gets symbols' skip intersection ratio

number

LogCurve.getSymbolsSkipIntersectionRatio

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

LogCurve.getTag

▸ getTextAnchorType(): AnchorType

Gets text anchor type

AnchorType

LogCurve.getTextAnchorType

▸ 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

LogCurve.getTextAutoAlignment

▸ getTextAutoAlignmentOffset(): Point

Gets text offset from anchor for automatic text alignment

Point

text offset for automatic text alignment

LogCurve.getTextAutoAlignmentOffset

▸ getTextDecimationStep(): number

Returns text decimation step

number

LogCurve.getTextDecimationStep

▸ getTextReference(): TextReference

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

TextReference

LogCurve.getTextReference

▸ getTextStyle(): TextStyle

Gets text style

TextStyle

LogCurve.getTextStyle

▸ getTrack(): ITrack

Returns parent track if LogTrack

ITrack

LogCurve.getTrack

▸ getValue(depth): number

Returns interpolated value

number

LogCurve.getValue

▸ getValueDataLimits(): Range

Returns original data value limits

Range

LogCurve.getValueDataLimits

▸ getValueFormat(): NumberFormat

Returns formatter to format values

NumberFormat

LogCurve.getValueFormat

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

LogCurve.getVisible

▸ getWorldTransform(): Transformation

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

Transformation

LogCurve.getWorldTransform

▸ getWrapLineStyleHandler(): WrapLineStyleHandlerCallback

Returns wrap line style handler

WrapLineStyleHandlerCallback

wrap style handler

LogCurve.getWrapLineStyleHandler

▸ getZIndex(): number

Returns node z-index (null if not set)

number

LogCurve.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

LogCurve.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

LogCurve.hasEventListener

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

Hit test symbols of the curve in the device coordinates

number[]

a collection of selected symbols indices

LogCurve.hitTest

▸ invalidate(bounds?, force?): CompositeLogCurve

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

CompositeLogCurve

this

LogCurve.invalidate

▸ invalidateParent(bounds?, force?): CompositeLogCurve

Invalidate bounds