Class: LogLithologyHeader

• new LogLithologyHeader(options)

• new LogLithologyHeader(options?)

LogVisualHeader<LogLithology>.constructor

▸ addCssClass(cssclass): LogLithologyHeader

Adds new css class to node

LogLithologyHeader

LogVisualHeader.addCssClass

▸ addInvalidateHandler(handler): LogLithologyHeader

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

LogLithologyHeader

this

LogVisualHeader.addInvalidateHandler

▸ Protected applyOpacity(context): LogLithologyHeader

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

LogLithologyHeader

this

LogVisualHeader.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

LogVisualHeader.applyResponsiveStyle

▸ Protected calculateDesiredHeight(): number

Get header desired height

number

header desired height

LogVisualHeader.calculateDesiredHeight

▸ checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

boolean

LogVisualHeader.checkCollision

▸ checkTextSize(context, text, maxLen): string

Returns biggest text in specified width

string

LogVisualHeader.checkTextSize

▸ clone(): LogLithologyHeader

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

LogLithologyHeader

clone

LogVisualHeader.clone

▸ connectStyle(style, type, callback): LogLithologyHeader

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

LogLithologyHeader

this

LogVisualHeader.connectStyle

▸ Protected copyConstructor(src, deepCopy?): LogLithologyHeader

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

LogLithologyHeader

this

LogVisualHeader.copyConstructor

▸ disconnectStyle(style, type, callback): LogLithologyHeader

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

LogLithologyHeader

this

LogVisualHeader.disconnectStyle

▸ dispose(): void

Dispose node. Clear all listeners and disconnect style to avoid memory leaks

void

LogVisualHeader.dispose

▸ drawBorder(context, borderLineStyle?, modelLimits?): LogLithologyHeader

Stroke border with specified

LogLithologyHeader

LogVisualHeader.drawBorder

▸ Protected drawRoundedBox(context, bounds, options?): LogLithologyHeader

LogLithologyHeader

LogVisualHeader.drawRoundedBox

▸ Protected drawText(context, x?, y?, text?, style?, alignment?, theta?, maxSize?): void

for internal use only, make text always readable

void

LogVisualHeader.drawText

▸ enableEventPropagation(enable): LogLithologyHeader

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

LogLithologyHeader

this

LogVisualHeader.enableEventPropagation

▸ execute(delegate): LogLithologyHeader

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

LogLithologyHeader

The result if any or this

LogVisualHeader.execute

▸ execute<T>(delegate): T

T

LogVisualHeader.execute

▸ fillBorder(context, fillStyle?, modelLimits?): LogLithologyHeader

Draws a rectangle at the model limits and fill it with specified fillStyle

LogLithologyHeader

LogVisualHeader.fillBorder

▸ Protected filter(context): boolean

Filter node

boolean

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

LogVisualHeader.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

LogVisualHeader.getAnimationStyle

▸ getBorderLineStyle(): LineStyle

Gets border line style

LineStyle

LogVisualHeader.getBorderLineStyle

▸ getBounds(): Rect

Return bound in the parent coordinates

Rect

LogVisualHeader.getBounds

▸ getClassName(): string

string

LogVisualHeader.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

LogVisualHeader.getClipStyle

▸ getContentsArea(transformation?): Rect

Return area without paddings. Model limits are mapped to content area, where children are layout.

Rect

LogVisualHeader.getContentsArea

▸ getContentsTransform(): Transformation

Return transformation from model to bounds

Transformation

LogVisualHeader.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

LogVisualHeader.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

LogVisualHeader.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

LogVisualHeader.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

LogVisualHeader.getCssTransform

▸ getDesiredHeight(width?): number

Return header desired height

number

LogVisualHeader.getDesiredHeight

▸ getDisplayDepth(): number

Returns the displayed depth value

number

LogVisualHeader.getDisplayDepth

▸ getDisplayMode(): string | string[]

Returns the displayed mode value

string | string[]

LogVisualHeader.getDisplayMode

▸ getDisplayString(): string

Returns the displayed value

string

displayString

LogVisualHeader.getDisplayString

▸ getDisplayValue(): number

Returns 0

number

LogVisualHeader.getDisplayValue

▸ getDisplayValueTextStyle(): TextStyle

Return a current text style for displayed value

Deprecated

since 4.0. Use getTextStyle() instead

TextStyle

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

LogVisualHeader.getFillStyle

▸ getFlexBoxOptions(): FlexBoxOptionsOut

Get flexbox layout options

FlexBoxOptionsOut

flexbox layout options

▸ getHeaderType(): HeaderType

Gets the current header type

HeaderType

▸ getHighlightOptions(): HighlightOptions

Returns highlight options

HighlightOptions

highlight options

LogVisualHeader.getHighlightOptions

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

LogVisualHeader.getId

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

LogVisualHeader.getInvalidateMethod

▸ getIsPointingUp(): boolean

Returns true if the text is always pointing up

boolean

true if the text is always pointing up

LogVisualHeader.getIsPointingUp

▸ getLayoutStyle(): LayoutStyle<string | number>

Return desired layout style

LayoutStyle<string | number>

LogVisualHeader.getLayoutStyle

▸ getLineStyle(): LineStyle

Return line style

LineStyle

LogVisualHeader.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

LogVisualHeader.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

LogVisualHeader.getMarginsStyle

▸ getModelLimits(): Rect

Return model limits

Rect

LogVisualHeader.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

LogVisualHeader.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

LogVisualHeader.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

LogVisualHeader.getOpacityBlendMode

▸ getPaddingStyle(): SpaceStyle<string | number>

Return padding style

SpaceStyle<string | number>

padding

LogVisualHeader.getPaddingStyle

▸ getParent(): Node

Return parent node

Node

parent node

LogVisualHeader.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties object

LogVisualHeader.getProperties

▸ getProperty(name): any

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

any

LogVisualHeader.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

LogVisualHeader.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

LogVisualHeader.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

LogVisualHeader.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

LogVisualHeader.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

LogVisualHeader.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

LogVisualHeader.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

LogVisualHeader.getTag

▸ Protected getTextBoundingBox(context, x?, y?, text?, style?, alignment?, theta?): Rect

Returns bounding box of the text

Rect

LogVisualHeader.getTextBoundingBox

▸ Protected getTextShapeHelper(x?, y?, text?, textStyle?, alignment?): Text

Return text shape helper instance

Text

text shape helper

LogVisualHeader.getTextShapeHelper

▸ getTextStyle(): TextStyle

Return a current text style

TextStyle

LogVisualHeader.getTextStyle

▸ getVisible(): boolean

Return visibility of the header

boolean

true if header itself and associated LogVisual is visible

LogVisualHeader.getVisible

▸ getVisual(): LogLithology

Gets visual to be used to render header

LogLithology

visual

LogVisualHeader.getVisual

▸ getWorldTransform(): Transformation

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

Transformation

LogVisualHeader.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

LogVisualHeader.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

LogVisualHeader.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

LogVisualHeader.hasEventListener

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

Hit test in device coordinates

Hits[]

▸ invalidate(bounds?, force?): LogLithologyHeader

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

LogLithologyHeader

this

LogVisualHeader.invalidate

▸ invalidateLayout(propagate?): LogLithologyHeader

Notify that layout is invalidated. Send event Events.LayoutInvalidated

LogLithologyHeader

this

LogVisualHeader.invalidateLayout

▸ Protected invalidateParent(bounds?, force?): LogLithologyHeader

Invalidate parent and notify all listeners. NOTE: Don't keep arguments of the event, because instance can be changed

Fires

Events.Invalidate

LogLithologyHeader

this

LogVisualHeader.invalidateParent

▸ isAutoBounds(): boolean

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

Deprecated

since 4.1, use .getLayoutStyle instead

boolean

LogVisualHeader.isAutoBounds

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

LogVisualHeader.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

LogVisualHeader.isEventPropagationEnabled

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

horizontal flip

LogVisualHeader.isHorizontalFlip

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

LogVisualHeader.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

LogVisualHeader.isSelectable

▸ isSilent(): boolean

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

boolean

LogVisualHeader.isSilent

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

Notify listeners of the Node

LogLithologyHeader

this

LogVisualHeader.notify

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

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.

LogLithologyHeader

this

LogVisualHeader.off

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

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.

LogLithologyHeader

this

LogVisualHeader.on

▸ Protected onParentChanged(node): LogLithologyHeader

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

LogLithologyHeader

this

LogVisualHeader.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

LogVisualHeader.onVisibilityChanged

▸ Protected onVisualChanged(): void

This method is called if visual is changed. Send event Events.VisualChanged

void

LogVisualHeader.onVisualChanged

▸ Protected onVisualChanging(): void

This method is called if visual is changing.

void

LogVisualHeader.onVisualChanging

▸ Protected onVisualStateChanged(type, source): void

void

LogVisualHeader.onVisualStateChanged

▸ Protected postRendering(context): void

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

void

LogVisualHeader.postRendering

▸ Protected preRendering(context): void

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

void

LogVisualHeader.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

LogVisualHeader.registerAnimationStyle

▸ removeCssClass(cssclass): LogLithologyHeader

Removes css class from node

LogLithologyHeader

LogVisualHeader.removeCssClass

▸ removeInvalidateHandler(handler): LogLithologyHeader

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

LogLithologyHeader

this

LogVisualHeader.removeInvalidateHandler

▸ render(inputContext): void

Renders node

void

LogVisualHeader.render

▸ renderAsync(context, callback): void

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

void

LogVisualHeader.renderAsync

▸ rotate(theta, x, y): LogLithologyHeader

Rotate bounds around a given coordinate

LogLithologyHeader

this

LogVisualHeader.rotate

▸ scale(xx, yy): LogLithologyHeader

Scale node

LogLithologyHeader

this

LogVisualHeader.scale

▸ setAnimationStyle(animationStyle): LogLithologyHeader

Sets animation style

LogLithologyHeader

LogVisualHeader.setAnimationStyle

▸ setAutoBounds(enable): LogLithologyHeader

Enable or disable auto bounds If auto bounds is enabled then it equals to parent model limits

Deprecated

since 4.1, use .setLayoutStyle instead

LogLithologyHeader

LogVisualHeader.setAutoBounds

▸ setBorderLineStyle(lineStyle, merge?): LogLithologyHeader

Sets border line style

LogLithologyHeader

this

LogVisualHeader.setBorderLineStyle

▸ setBounds(bounds): LogLithologyHeader

Sets bounds of the curve in the parent coordinates and set up auto bounds false

LogLithologyHeader

this

LogVisualHeader.setBounds

▸ setClipStyle(style): LogLithologyHeader

Sets a new clipping style

LogLithologyHeader

this

LogVisualHeader.setClipStyle

▸ setCss(style, merge?): LogLithologyHeader

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

LogLithologyHeader

this

LogVisualHeader.setCss

▸ setCssClass(name): LogLithologyHeader

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

LogLithologyHeader

this

LogVisualHeader.setCssClass

▸ setCssTransform(transform): LogLithologyHeader

Set CSS transformation

LogLithologyHeader

this

LogVisualHeader.setCssTransform

▸ setDesiredHeight(value, silent?): LogLithologyHeader

Sets desired height of the header as a layoutable object

LogLithologyHeader

this

LogVisualHeader.setDesiredHeight

▸ setDisplayMode(displayMode): LogLithologyHeader

Sets the displayed mode value

LogLithologyHeader

LogVisualHeader.setDisplayMode

▸ setDisplayString(displayString): LogLithologyHeader

Sets the displayed value

LogLithologyHeader

LogVisualHeader.setDisplayString

▸ setDisplayValueTextStyle(textStyle, merge?): LogLithologyHeader

Sets a current text style for displayed value

Deprecated

since 4.0. Use setTextStyle() instead

LogLithologyHeader

this

▸ setFillStyle(fillStyle, merge?): LogLithologyHeader

Sets fill style

LogLithologyHeader

LogVisualHeader.setFillStyle

▸ setFlexBoxOptions(flexBox): LogLithologyHeader

Set flexbox layout options

LogLithologyHeader

this

▸ setHeaderType(type): LogLithologyHeader

Sets Header Type

LogLithologyHeader

this

▸ setHighlightOptions(options): LogLithologyHeader

Set highlight options

LogLithologyHeader

LogVisualHeader.setHighlightOptions

▸ setHorizontalFlip(enable): LogLithologyHeader

Set horizontal flip of the representation

LogLithologyHeader

this

LogVisualHeader.setHorizontalFlip

▸ setId(id): LogLithologyHeader

Allows the user to associate any identifier

LogLithologyHeader

this

LogVisualHeader.setId

▸ setIsPointingUp(isPointingUp): LogLithologyHeader

Sets whether the text is always pointing up.

LogLithologyHeader

this

LogVisualHeader.setIsPointingUp

▸ setLayoutStyle(layoutStyle, merge?): LogLithologyHeader

Specify desired layout style

LogLithologyHeader

LogVisualHeader.setLayoutStyle

▸ setLineStyle(lineStyle, merge?): LogLithologyHeader

Sets a line style

LogLithologyHeader

this

LogVisualHeader.setLineStyle

▸ setLocalTransform(localTransform, force?): LogLithologyHeader

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