Class: LogBarVisual

• [new LogBarVisual(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.welllog.logbarvisual.logbarvisual.md#new logbarvisual(options))

• new LogBarVisual(options?)

Constructor

LogPointSet.constructor

▸ addCssClass(cssclass): LogBarVisual

Adds new css class to node

LogBarVisual

this

LogPointSet.addCssClass

▸ addInvalidateHandler(handler): LogBarVisual

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

LogBarVisual

this

LogPointSet.addInvalidateHandler

▸ Protected applyOpacity(context): LogBarVisual

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

LogBarVisual

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

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

LogBarVisual

clone

LogPointSet.clone

▸ connectStyle(style, type, callback): LogBarVisual

Connects style.<br> <br> This convenience method subscribes a listener to given style for the specified type.<br> And automatically un-subscribes listener if node is disposed to prevent memory leaks

LogBarVisual

this

LogPointSet.connectStyle

▸ Protected copyConstructor(src, deepCopy?): LogBarVisual

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

LogBarVisual

this

LogPointSet.copyConstructor

▸ disconnectStyle(style, type, callback): LogBarVisual

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

LogBarVisual

this

LogPointSet.disconnectStyle

▸ dispose(): void

Disposes this node, once disposes a node should not be used anymore.<br> Clear all listeners, and disconnect styles to avoid memory leaks.<br> Also aggressively 'cleanup' this node by setting some of its members to null.

void

LogPointSet.dispose

▸ enableEventPropagation(enable): LogBarVisual

Enable event propagation from the node hierarchy from bottom to top <p> 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. </p>

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

LogBarVisual

this

LogPointSet.enableEventPropagation

▸ execute(delegate): LogBarVisual

Executes delegate and return the result. It allows us to keep all initialization calls in one place, <br> 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");
});

LogBarVisual

The result if any or this

LogPointSet.execute

▸ execute<T&gt;(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

▸ getAutoUpdate(): boolean

Gets the auto update flag

boolean

autoUpdate Flag that determines whether to automatically update from data.

▸ getBarSpacing(): number

Gets the amount of space between adjacent bars.

number

barSpacing The amount of space between adjacent bars.

▸ getBarWidth(): number | number[]

Gets the width of each bar.

number | number[]

▸ 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

Returns meaning data limits

Rect

LogPointSet.getDataLimits

▸ getDataSource(): LogAbstractData

Returns WellLog Data

LogAbstractData

▸ getDescription(): string

Gets the description

string

The description

LogPointSet.getDescription

▸ getEnableAutoLimits(): boolean

Gets the flag which indicates whether auto value limits are enabled.

boolean

enableAutoLimits The autoLimits flag.

▸ getFillStyle(): FillStyle

Gets the fill style

FillStyle

fillStyle The fill style

▸ getGradientFillStyle(): LogGradientStyle

Returns log gradient style

LogGradientStyle

log gradient style

▸ getHeader(name): LogVisualHeader<Node&gt;

Return the header registered by the name

LogVisualHeader<Node&gt;

header

LogPointSet.getHeader

▸ getHeaders(): Record<string, LogVisualHeader<Node&gt;&gt;

Return an object that contains all headers registered with the visual

Record<string, LogVisualHeader<Node&gt;&gt;

headers

LogPointSet.getHeaders

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

LogPointSet.getId

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher&gt;

Gets invalidate method

AttributeCallback<EventDispatcher&gt;

method to invalidate this object

LogPointSet.getInvalidateMethod

▸ getLimits(): Range

Gets the value limits

Range

limits The manual limits.

▸ 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&gt;

Return margins style

SpaceStyle<string | number&gt;

LogPointSet.getMarginsStyle

▸ 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

▸ getModelLimits(): Rect

Returns model limits

Rect

model limits

LogPointSet.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

LogPointSet.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

LogPointSet.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

LogPointSet.getOpacityBlendMode

▸ getParent(): Node

Return parent node

Node

parent node

LogPointSet.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

The object properties

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

▸ getReferenceBar(): LogBarVisual

Returns reference bar

LogBarVisual

reference bar

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

LogPointSet.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

LogPointSet.getResponsiveStyle

▸ getReverse(): boolean

Gets reverse mode state

boolean

state of the reverse mode

▸ getRoot(): Node

Returns root node. <br> 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(): string

Returns current scale type.

string

▸ getScaledData(): AbstractScaledData

Gets the visual's scaled data

AbstractScaledData

(the implementation returns null).

LogPointSet.getScaledData

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

LogPointSet.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

LogPointSet.getTag

▸ getTrack(): ITrack

Returns parent track if LogTrack

ITrack

LogPointSet.getTrack

▸ getUnit(): AbstractUnit

Gets the depth unit

AbstractUnit

The type of unit for bar width and bar spacing.

▸ getValueDataLimits(): Range

Returns original data value limits

Range

▸ 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

▸ 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

▸ invalidate(bounds?, force?): LogBarVisual

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

LogBarVisual

this

LogPointSet.invalidate

▸ invalidateParent(bounds?, force?): LogBarVisual

Invalidate bounds

LogBarVisual

this

LogPointSet.invalidateParent

▸ isAutoBounds(): boolean

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

boolean

LogPointSet.isAutoBounds

▸ 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

▸ 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

▸ notify<E&gt;(type, source, args?): LogBarVisual

Notify listeners of the Node

LogBarVisual

this

LogPointSet.notify

▸ off<E&gt;(type?, callback?): LogBarVisual

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.

LogBarVisual

this

LogPointSet.off

▸ on<E&gt;(type, callback): LogBarVisual

Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> 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. </p>

LogBarVisual

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

calls when microPosition has been changed

LogBarVisual

this

LogPointSet.onMicroPositionChanged

▸ Protected onParentChanged(node): LogBarVisual

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

LogBarVisual

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

Removes css class from node

LogBarVisual

this

LogPointSet.removeCssClass

▸ removeInvalidateHandler(handler): LogBarVisual

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

LogBarVisual

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

▸ rotate(theta, x, y): LogBarVisual

Rotate bounds around a given coordinate

LogBarVisual

this

LogPointSet.rotate

▸ scale(xx, yy): LogBarVisual

Scale node

LogBarVisual

this

LogPointSet.scale

▸ setAnimationStyle(animationStyle): LogBarVisual

Sets animation style

LogBarVisual

LogPointSet.setAnimationStyle

▸ setAutoBounds(enable): LogBarVisual

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

LogBarVisual

this

LogPointSet.setAutoBounds

▸ setAutoUpdate(autoUpdate): LogBarVisual

Sets the auto update flag

LogBarVisual

this

▸ setBarSpacing(barSpacing): LogBarVisual

Sets the amount of space between adjacent bars.

LogBarVisual

this

▸ setBarWidth(barWidth): LogBarVisual

Sets the width of each bar

LogBarVisual

this

▸ setBaseName(name): LogBarVisual

Sets base name of the visual

LogBarVisual

this

LogPointSet.setBaseName

▸ setBounds(bounds): LogBarVisual

Sets bounds of the point set in the parent coordinates false

LogBarVisual

this

LogPointSet.setBounds

▸ setClipStyle(style): LogBarVisual

Sets a new clipping style

LogBarVisual

this

LogPointSet.setClipStyle

▸ setCss(style, merge?): LogBarVisual

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

LogBarVisual

this

LogPointSet.setCss

▸ setCssClass(name): LogBarVisual

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

LogBarVisual

this

LogPointSet.setCssClass

▸ setCssTransform(transform): LogBarVisual

Set CSS transformation

LogBarVisual

this

LogPointSet.setCssTransform

▸ setData(data, autoUpdate?): LogBarVisual

Sets data source to be displayed.

LogBarVisual

this

▸ setDescription(description): LogBarVisual

Sets the description

LogBarVisual

this

LogPointSet.setDescription

▸ setEnableAutoLimits(enableAutoLimits): LogBarVisual

Sets the flag which indicates whether auto value limits are enabled.

LogBarVisual

this

▸ setFillStyle(fillStyle, merge?): LogBarVisual

Sets fill style

LogBarVisual

this

▸ setGradientFillStyle(gradientLineStyle): LogBarVisual

Set log gradient style

LogBarVisual

this

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

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

Throws

if header name is null

LogBarVisual

this

LogPointSet.setHeader

▸ setId(id): LogBarVisual

Allows the user to associate any identifier

LogBarVisual

this

LogPointSet.setId

▸ setLimits(limits): LogBarVisual

Sets the manual value limits

LogBarVisual

this

▸ setLineStyle(lineStyle, merge?): LogBarVisual

Sets line style

LogBarVisual

this

LogPointSet.setLineStyle

▸ setLocalTransform(localTransform, force?): LogBarVisual

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

LogBarVisual

this

LogPointSet.setLocalTransform

▸ setMarginsStyle(margins, merge?): LogBarVisual

Sets margins style

LogBarVisual

this

LogPointSet.setMarginsStyle

▸ setMicroPosition(left, right): LogBarVisual

Sets micro position (0 - 1). It allows application code to display the visual in a subarea of the track.<br> 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);

LogBarVisual

this

LogPointSet.setMicroPosition

▸ setName(name): LogBarVisual

Sets name of the node

LogBarVisual

this

LogPointSet.setName

▸ setNotification(notify, force?): LogBarVisual

set notification state

LogBarVisual

this

LogPointSet.setNotification

▸ setOpacity(opacity, blendMode?): LogBarVisual

Sets node opacity

LogBarVisual

this

LogPointSet.setOpacity

▸ setParent(parent): LogBarVisual

Sets parent node. Don't call this method directly. It is internal method.

LogBarVisual

this

LogPointSet.setParent

▸ setProperties(properties?): LogBarVisual

Sets all the properties pertaining to this object

LogBarVisual

this

LogPointSet.setProperties

▸ setProperty(name, value): LogBarVisual

Sets dynamic property by name

LogBarVisual

this

LogPointSet.setProperty

▸ setReferenceBar(referenceBar): LogBarVisual

Set reference bar

LogBarVisual

this

▸ setRenderingFilter(filter): LogBarVisual

Sets filter to be applied before rendering and picking

LogBarVisual

this

LogPointSet.setRenderingFilter

▸ setResponsiveStyle(style): LogBarVisual

Sets responsive style.

LogBarVisual

this

LogPointSet.setResponsiveStyle

▸ setReverse(reverse): LogBarVisual

Sets reverse mode state

LogBarVisual

this

▸ setScaleScrollStrategy(strategy?): LogBarVisual

Sets scale scroll strategy

LogBarVisual

this

LogPointSet.setScaleScrollStrategy

▸ setScaleType(type): LogBarVisual

Sets scale type. This applies function to data values.

LogBarVisual

this

▸ setSelectable(selectable): LogBarVisual

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

LogBarVisual

this

LogPointSet.setSelectable

▸ setSilent(bool): LogBarVisual

Set silent mode

LogBarVisual

this

LogPointSet.setSilent

▸ setTag(tag): LogBarVisual

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

LogBarVisual

this

LogPointSet.setTag

▸ setUnit(unit): LogBarVisual

Sets the depth unit

LogBarVisual

this

▸ setVisible(value): LogBarVisual

Sets visibility of the node. Send event Events.VisibilityChanged