Class: LogLithology

• new LogLithology(depths, left, right, fillStyles, names, titles, labelfillstyle, labelfillmode, nameorientation)

• new LogLithology(depths?, left?, right?, fillStyles?, names?, titles?, labelfillstyle?, labelfillmode?, nameorientation?)

Constructor

LogFill.constructor

▸ addCssClass(cssclass): LogLithology

Adds new css class to node

LogLithology

this

LogFill.addCssClass

▸ addInvalidateHandler(handler): LogLithology

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

LogLithology

this

LogFill.addInvalidateHandler

▸ Protected applyOpacity(context): LogLithology

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

LogLithology

this

LogFill.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

LogFill.applyResponsiveStyle

▸ checkCollision(context): boolean

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

boolean

LogFill.checkCollision

▸ clone(): LogLithology

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

LogLithology

clone

LogFill.clone

▸ connectStyle(style, type, callback): LogLithology

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

LogLithology

this

LogFill.connectStyle

▸ Protected copyConstructor(src, deepCopy?): LogLithology

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

LogLithology

this

LogFill.copyConstructor

▸ disconnectStyle(style, type, callback): LogLithology

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

LogLithology

this

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

LogFill.dispose

▸ Protected drawBackground(context, index): Rect | GraphicsPath

Rect | GraphicsPath

▸ Protected drawBackground(context, index, depthTop?, depthBottom?): Rect | GraphicsPath

Rect | GraphicsPath

▸ Protected drawBackground(context, index, depthTop, depthBottom, isTopOverlapped, isBottomOverlapped): Rect | GraphicsPath

Rect | GraphicsPath

▸ enableEventPropagation(enable): LogLithology

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

LogLithology

this

LogFill.enableEventPropagation

▸ execute(delegate): LogLithology

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

LogLithology

The result if any or this

LogFill.execute

▸ execute<T>(delegate): T

T

LogFill.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

LogFill.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

LogFill.getAnimationStyle

▸ getBaseName(): string

Returns the base name

string

The base name

LogFill.getBaseName

▸ getBorderMode(): BorderMode

Returns current border mode

BorderMode

mode

▸ getBounds(): Rect

Gets bounds

Rect

LogFill.getBounds

▸ getClassName(): string

string

LogFill.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

LogFill.getClipStyle

▸ getContentsTransform(): Transformation

Retrieves the world transformation of the spatial

Transformation

LogFill.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

LogFill.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

LogFill.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

LogFill.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

LogFill.getCssTransform

▸ getCurve1(): LogCurve | LogReferenceLine

Returns a point set to fill from

LogCurve | LogReferenceLine

LogFill.getCurve1

▸ getCurve2(): LogCurve | LogReferenceLine

Returns a point set to fill to

LogCurve | LogReferenceLine

LogFill.getCurve2

▸ getDataLimits(fullLimits?): Rect

return meaning data limits

Rect

LogFill.getDataLimits

▸ getDepths(): number[]

Returns depths

number[]

▸ getDescription(): string

Gets the description

string

The description

LogFill.getDescription

▸ getEllipsisOptions(): EllipsisOptions

Returns ellipsis options

EllipsisOptions

ellipsis options

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

LogFill.getFillStyle

▸ getFillStyles(): FillStyle[]

Returns array of fillstyles

FillStyle[]

▸ getFillType(): FillType

Gets the fill type

FillType

LogFill.getFillType

▸ getHeader(name): LogVisualHeader<Node>

Return the header registered by the name

LogVisualHeader<Node>

header

LogFill.getHeader

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

Return an object that contains all headers registered with the visual

Record<string, LogVisualHeader<Node>>

headers

LogFill.getHeaders

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

LogFill.getId

▸ getIds(): (string | number)[]

Gets an array of range identifiers

(string | number)[]

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

LogFill.getInvalidateMethod

▸ getLabelFillMode(): LabelFillMode

Returns Label fill mode

LabelFillMode

▸ getLabelFillStyle(): FillStyle

Returns label fill style used if the mode is set to SINGLECOLOR

FillStyle

▸ getLeftFillStyle(): FillStyle

Returns fill style to be used to fill left (positive) areas

FillStyle

LogFill.getLeftFillStyle

▸ getLineStyle(): LineStyle

Returns line style

LineStyle

LogFill.getLineStyle

▸ getLineStyles(): LineStyle[]

Returns array of linestyles

LineStyle[]

▸ getLineTypes(): LineType[]

Return Lithology Line Types

LineType[]

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

LogFill.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

LogFill.getMarginsStyle

▸ getMicroPositionLeft(): number

Returns micro position left

number

LogFill.getMicroPositionLeft

▸ getMicroPositionRight(): number

Returns micro position right

number

LogFill.getMicroPositionRight

▸ Protected getMicroPositionTransformation(): Transformation

Returns micro position transformation

Transformation

micro position transformation

LogFill.getMicroPositionTransformation

▸ getMinHeightForLabel(): number

Return minimum height for label

number

▸ getModelLimits(): Rect

Returns null

Rect

LogFill.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

LogFill.getName

▸ getNameOrientation(): NameOrientation

Returns name orientation

NameOrientation

▸ getNameVisible(): boolean

Returns name visibility flag

boolean

▸ getNames(): string[]

Returns lithology names

string[]

▸ getNegativeFillStyle(): FillStyle

Returns fill style to be used to fill negative areas

FillStyle

LogFill.getNegativeFillStyle

▸ getOpacity(): number

Returns current node opacity

number

opacity

LogFill.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

LogFill.getOpacityBlendMode

▸ getParent(): Node

Return parent node

Node

parent node

LogFill.getParent

▸ getPositiveFillStyle(): FillStyle

Returns fill style to be used to fill positive areas

FillStyle

LogFill.getPositiveFillStyle

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties object

LogFill.getProperties

▸ getProperty(name): any

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

any

LogFill.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

LogFill.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

LogFill.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

LogFill.getResponsiveStyle

▸ getRightFillStyle(): FillStyle

Returns fill style to be used to fill right (negative) areas

FillStyle

LogFill.getRightFillStyle

▸ getRoot(): Node

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

Node

the root node

LogFill.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

LogFill.getScaleScrollStrategy

▸ getScaledData(): AbstractScaledData

Gets the visual's scaled data

AbstractScaledData

(the implementation returns null).

LogFill.getScaledData

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

LogFill.getSceneTransform

▸ getShowEllipsis(): boolean

Returns ellipsis flag

boolean

ellipsis flag

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

LogFill.getTag

▸ getText(): string

Returns text

string

text

▸ getTextExpand(): boolean

Returns true if text can expand lithology bounds

boolean

returns textExpand

▸ getTextPosition(): AnchorType

Returns text position inside the text area

AnchorType

returns anchor type

▸ getTextSizeMode(): SizeMode

Returns how the size is computed

SizeMode

returns textSizeMode

▸ getTextStyle(): TextStyle

Return text style

TextStyle

▸ getTextStyles(): TextStyle[]

Returns list of the text styles for the lithology

TextStyle[]

▸ getTitles(): string[]

Returns lithology titles

string[]

▸ getTrack(): ITrack

Returns parent track if LogTrack

ITrack

LogFill.getTrack

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

LogFill.getVisible

▸ getWorldTransform(): Transformation

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

Transformation

LogFill.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

LogFill.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

LogFill.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

LogFill.hasEventListener

▸ hitTest(area, radius?): Hits

Hit test in device coordinates

Hits

▸ invalidate(bounds?, force?): LogLithology

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

LogLithology

this

LogFill.invalidate

▸ invalidateParent(bounds?, force?): LogLithology

Invalidate bounds

LogLithology

this

LogFill.invalidateParent

▸ isAutoBounds(): boolean

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

boolean

LogFill.isAutoBounds

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

LogFill.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

LogFill.isEventPropagationEnabled

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

horizontal flip

LogFill.isHorizontalFlip

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

LogFill.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

LogFill.isSelectable

▸ isSilent(): boolean

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

boolean

LogFill.isSilent

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

Notify listeners of the Node

LogLithology

this

LogFill.notify

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

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.

LogLithology

this

LogFill.off

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

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.

LogLithology

this

LogFill.on

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

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

void

LogFill.onHeaderSet

▸ Protected onMicroPositionChanged(): LogLithology

calls when microPosition has been changed

LogLithology

this

LogFill.onMicroPositionChanged

▸ Protected onParentChanged(node): LogLithology

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

LogLithology

this

LogFill.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

LogFill.onVisibilityChanged

▸ Protected postRendering(context): void

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

void

LogFill.postRendering

▸ Protected preRendering(context): void

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

void

LogFill.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

LogFill.registerAnimationStyle

▸ removeCssClass(cssclass): LogLithology

Removes css class from node

LogLithology

this

LogFill.removeCssClass

▸ removeInvalidateHandler(handler): LogLithology

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

LogLithology

this

LogFill.removeInvalidateHandler

▸ render(context): void

Renders node

void

LogFill.render

▸ renderAsync(context, callback): void

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

void

LogFill.renderAsync

▸ Protected renderContent(context): void

Renders node content

void

LogFill.renderContent

▸ Protected renderDepthRange(context, fromDepth, toDepth, clipByDepth?, index?): void

Render depth range

void

LogFill.renderDepthRange

▸ Protected renderInternal(localContext): LogLithology

Render internal

LogLithology

this

LogFill.renderInternal

▸ rotate(theta, x, y): LogLithology

Rotate bounds around a given coordinate

LogLithology

this

LogFill.rotate

▸ scale(xx, yy): LogLithology

Scale node

LogLithology

this