Class: StackedLogFill

• new StackedLogFill(data, autoUpdate?)

Constructor

LogAbstractVisual.constructor

• new StackedLogFill(params?)

Constructor

LogAbstractVisual.constructor

▸ addCssClass(cssclass): StackedLogFill

Adds new css class to node

StackedLogFill

this

LogAbstractVisual.addCssClass

▸ addInvalidateHandler(handler): StackedLogFill

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

StackedLogFill

this

LogAbstractVisual.addInvalidateHandler

▸ Protected applyOpacity(context): StackedLogFill

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

StackedLogFill

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

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

StackedLogFill

clone

LogAbstractVisual.clone

▸ connectStyle(style, type, callback): StackedLogFill

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

StackedLogFill

this

LogAbstractVisual.connectStyle

▸ Protected copyConstructor(src, deepCopy?): StackedLogFill

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

StackedLogFill

this

LogAbstractVisual.copyConstructor

▸ disconnectStyle(style, type, callback): StackedLogFill

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

StackedLogFill

this

LogAbstractVisual.disconnectStyle

▸ dispose(): void

Disposes the stacked fill

void

LogAbstractVisual.dispose

▸ enableEventPropagation(enable): StackedLogFill

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

StackedLogFill

this

LogAbstractVisual.enableEventPropagation

▸ execute(delegate): StackedLogFill

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

StackedLogFill

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

Return bounds

Rect

bounds

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

▸ getCurveOptions(index): CurveOptionsOut

Returns curve and fill options

CurveOptionsOut

▸ getCurvesCount(): number

Return curve count

number

▸ getData(): Iterator<LogAbstractData>

Returns displayed data sources

Iterator<LogAbstractData>

▸ getDataLimits(fullLimits?): Rect

Return meaning data limits

Rect

LogAbstractVisual.getDataLimits

▸ getDescription(): string

Gets the description

string

The description

LogAbstractVisual.getDescription

▸ getGapFillCutoffMode(): CutoffMode

Return cutoff mode

CutoffMode

▸ getGapFillCutoffUnit(): AbstractUnit

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

AbstractUnit

▸ getGapFillCutoffValue(): number

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

number

▸ getGapStackingMode(): GapStackingMode

Return gap stacking mode

GapStackingMode

▸ 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

▸ getInterpolationType(): InterpolationType

Returns interpolation type ('Linear', 'MiddleStep', 'EndStep', 'StartStep')

InterpolationType

▸ 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

▸ getMaximumNormalizationLimit(): number

Returns maximum normalization limit

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

▸ getMinimumNormalizationLimit(): number

Returns minimum normalization limit

number

▸ getModelLimits(): Rect

Returns parent model limits

Rect

LogAbstractVisual.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

LogAbstractVisual.getName

▸ 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

An object containing the 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

▸ getReferenceLineOptions(): LineOptionsOut

Returns reference line options

LineOptionsOut

▸ 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

▸ 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

▸ 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

▸ hitTest(area, radius?): Hits

Hit test in the device coordinates

Hits

a collection of selected nodes

▸ invalidate(bounds?, force?): StackedLogFill

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

StackedLogFill

this

LogAbstractVisual.invalidate

▸ invalidateParent(bounds?, force?): StackedLogFill

Invalidate bounds

StackedLogFill

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?): StackedLogFill

Notify listeners of the Node

StackedLogFill

this

LogAbstractVisual.notify

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

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.

StackedLogFill

this

LogAbstractVisual.off

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

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.

StackedLogFill

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

calls when microPosition has been changed

StackedLogFill

this

LogAbstractVisual.onMicroPositionChanged

▸ Protected onParentChanged(node): StackedLogFill

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

StackedLogFill

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

Removes css class from node

StackedLogFill

this

LogAbstractVisual.removeCssClass

▸ removeInvalidateHandler(handler): StackedLogFill

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

StackedLogFill

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

Rotate bounds around a given coordinate

StackedLogFill

this

LogAbstractVisual.rotate

▸ scale(xx, yy): StackedLogFill

Scale node

StackedLogFill

this

LogAbstractVisual.scale

▸ setAnimationStyle(animationStyle): StackedLogFill

Sets animation style

StackedLogFill

LogAbstractVisual.setAnimationStyle

▸ setAutoBounds(enable): StackedLogFill

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

StackedLogFill

this

LogAbstractVisual.setAutoBounds

▸ setBaseName(name): StackedLogFill

Sets base name of the visual

StackedLogFill

this

LogAbstractVisual.setBaseName

▸ setBounds(bounds): StackedLogFill

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

StackedLogFill

this

LogAbstractVisual.setBounds

▸ setClipStyle(style): StackedLogFill

Sets a new clipping style

StackedLogFill

this

LogAbstractVisual.setClipStyle

▸ setCss(style, merge?): StackedLogFill

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

StackedLogFill

this

LogAbstractVisual.setCss

▸ setCssClass(name): StackedLogFill

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

StackedLogFill

this

LogAbstractVisual.setCssClass

▸ setCssTransform(transform): StackedLogFill

Set CSS transformation

StackedLogFill

this

LogAbstractVisual.setCssTransform

▸ setCurveOptions(index, options): StackedLogFill

Set curve and fill options

StackedLogFill

▸ setData(logDataArray, resetNormalizationLimits?, autoUpdate?): StackedLogFill

Sets data source to be displayed.

StackedLogFill

▸ setDescription(description): StackedLogFill

Sets the description

StackedLogFill

this

LogAbstractVisual.setDescription

▸ setGapFillCutoffMode(cutoffMode): StackedLogFill

Set a flag how to process NaN samples in cutoff range

StackedLogFill

this

▸ setGapFillCutoffUnit(unit): StackedLogFill

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.

StackedLogFill

▸ setGapFillCutoffValue(cutoff): StackedLogFill

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.

StackedLogFill

▸ setGapStackingMode(stackingMode): StackedLogFill

Set a flag how to stack sample after NaN value

StackedLogFill

this

▸ setGapUnit(unit): StackedLogFill

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.

StackedLogFill

this

▸ setGapValue(value, merge?): StackedLogFill

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

StackedLogFill

this

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

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

Throws

if header name is null

StackedLogFill

this

LogAbstractVisual.setHeader

▸ setId(id): StackedLogFill

Allows the user to associate any identifier

StackedLogFill

this

LogAbstractVisual.setId

▸ setInterpolationType(interpolationType): StackedLogFill

Sets interpolation type

Throws

If interpolationType is not correct

StackedLogFill

▸ setLineStyle(lineStyle, merge?): StackedLogFill

Sets line style

StackedLogFill

this

LogAbstractVisual.setLineStyle

▸ setLocalTransform(localTransform, force?): StackedLogFill

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

StackedLogFill

this

LogAbstractVisual.setLocalTransform

▸ setMarginsStyle(margins, merge?): StackedLogFill

Sets margins style

StackedLogFill

this

LogAbstractVisual.setMarginsStyle

▸ setMicroPosition(left, right): StackedLogFill

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

StackedLogFill

this

LogAbstractVisual.setMicroPosition

▸ setName(name): StackedLogFill

Sets name of the node

StackedLogFill

this

LogAbstractVisual.setName

▸ setNormalizationLimits(range): StackedLogFill

Sets normalization limits of the data values. The data limits are used by default.

StackedLogFill

this

▸ setNormalizationLimits(minValue, maxValue): StackedLogFill

Sets normalization limits of the data values. The data limits are used by default.

Example

StackedLogFill.setNormalizationLimits(100, 130); // It means that each sample value that is less than 100 should have value 100, Same for 130

StackedLogFill

this

▸ setNotification(notify, force?): StackedLogFill

set notification state

StackedLogFill

this

LogAbstractVisual.setNotification

▸ setOpacity(opacity, blendMode?): StackedLogFill

Sets node opacity

StackedLogFill

this

LogAbstractVisual.setOpacity

▸ setProperties(properties?): StackedLogFill

Sets all the properties pertaining to this object

StackedLogFill

this

LogAbstractVisual.setProperties

▸ setProperty(name, value): StackedLogFill

Sets dynamic property by name

StackedLogFill

this

LogAbstractVisual.setProperty

▸ setReferenceLineOptions(options): StackedLogFill

Set reference line options

StackedLogFill

▸ setRenderingFilter(filter): StackedLogFill

Sets filter to be applied before rendering and picking

StackedLogFill

this

LogAbstractVisual.setRenderingFilter

▸ setResponsiveStyle(style): StackedLogFill

Sets responsive style.

StackedLogFill

this

LogAbstractVisual.setResponsiveStyle

▸ setScaleScrollStrategy(strategy?): StackedLogFill

Sets scale scroll strategy

StackedLogFill

this

LogAbstractVisual.setScaleScrollStrategy

▸ setSelectable(selectable): StackedLogFill

Allows to select node. If node is not selectable then child node is not selectable.

StackedLogFill

this

LogAbstractVisual.setSelectable

▸ setSilent(bool): StackedLogFill

Set silent mode

StackedLogFill

this

LogAbstractVisual.setSilent

▸ setTag(tag): StackedLogFill

Allows the user to associate any arbitrary object with the node.

StackedLogFill

this

LogAbstractVisual.setTag

▸ setVisible(value): StackedLogFill

Sets visibility of the node. Send event Events.VisibilityChanged

StackedLogFill

this

LogAbstractVisual.setVisible

▸ setZIndex(value): StackedLogFill

Sets z-index for node (set null for default)

StackedLogFill

this

LogAbstractVisual.setZIndex

▸ shear(shx, shy): StackedLogFill