Class: SeismicViewWidget

• new SeismicViewWidget(options)

• new SeismicViewWidget(options?)

Creates widget

BaseWidget.constructor

▸ addBaseLayer(baseLayer): SeismicViewWidget

Add baseLayer to container

SeismicViewWidget

this

BaseWidget.addBaseLayer

▸ addChild(node): SeismicViewWidget

Add a child node

SeismicViewWidget

this

BaseWidget.addChild

▸ addCssClass(cssclass): SeismicViewWidget

Adds new css class to node

SeismicViewWidget

this

BaseWidget.addCssClass

▸ addInvalidateHandler(handler): SeismicViewWidget

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

SeismicViewWidget

this

BaseWidget.addInvalidateHandler

▸ addOverlay(overlay): SeismicViewWidget

Add overlay to container

SeismicViewWidget

this

BaseWidget.addOverlay

▸ adjustPosition(area?, vAlign?, hAlign?): SeismicViewWidget

Adjust position of node to specified area

SeismicViewWidget

this

BaseWidget.adjustPosition

▸ Protected applyOpacity(context): SeismicViewWidget

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

SeismicViewWidget

this

BaseWidget.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

BaseWidget.applyResponsiveStyle

▸ beginExport(options?): SeismicViewWidget

Used to prepare object before exporting

SeismicViewWidget

this

IExportable.beginExport

▸ changeBaseLayerOrder(overlay, order, anchor?): SeismicViewWidget

Changes the z-order of the baseLayer.

SeismicViewWidget

this

BaseWidget.changeBaseLayerOrder

▸ changeChildOrder(node, order, anchor?): SeismicViewWidget

changes the z-order of the nodes being rendered.

SeismicViewWidget

this

BaseWidget.changeChildOrder

▸ changeOverlayOrder(overlay, order, anchor?): SeismicViewWidget

Changes the z-order of the overlay.

SeismicViewWidget

this

BaseWidget.changeOverlayOrder

▸ checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

boolean

true if node is collided

BaseWidget.checkCollision

▸ clearBaseLayers(disposeBaseLayers?): SeismicViewWidget

Remove all child baseLayers from group

SeismicViewWidget

this

BaseWidget.clearBaseLayers

▸ clearCache(): SeismicViewWidget

Clear cache

SeismicViewWidget

this

BaseWidget.clearCache

▸ clearChildren(disposeChildren?): SeismicViewWidget

Remove all child nodes from this composite group

SeismicViewWidget

this

BaseWidget.clearChildren

▸ clearOverlays(disposeOverlays?): SeismicViewWidget

Remove all child overlays from group

SeismicViewWidget

this

BaseWidget.clearOverlays

▸ clone(): Group<Node>

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

Group<Node>

clone

BaseWidget.clone

▸ connectStyle(style, type, callback): SeismicViewWidget

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

SeismicViewWidget

this

BaseWidget.connectStyle

▸ connectTool(tool): SeismicViewWidget

Connect a new tool with a toolname to the widget

SeismicViewWidget

this

BaseWidget.connectTool

▸ Protected copyConstructor(src, deepCopy?): SeismicViewWidget

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

SeismicViewWidget

this

BaseWidget.copyConstructor

▸ disconnectStyle(style, type, callback): SeismicViewWidget

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

SeismicViewWidget

this

BaseWidget.disconnectStyle

▸ disconnectTool(tool): SeismicViewWidget

Disconnect the tool from the widget

SeismicViewWidget

this

BaseWidget.disconnectTool

▸ dispose(disposePipeline?): 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

BaseWidget.dispose

▸ Protected drawBorder(localContext, bounds?): SeismicViewWidget

Draws a rectangle at the bounding box (in parent coordinates)

SeismicViewWidget

this

BaseWidget.drawBorder

▸ enableClipping(doClip): SeismicViewWidget

Enables or disables clipping of this node. If enabled, shapes will not be rendered outside of its bounds.

SeismicViewWidget

this

BaseWidget.enableClipping

▸ enableEventPropagation(enable): SeismicViewWidget

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

SeismicViewWidget

this

BaseWidget.enableEventPropagation

▸ enablePickingChildren(enable): SeismicViewWidget

Enables or disables picking children

SeismicViewWidget

this

BaseWidget.enablePickingChildren

▸ endExport(options?): SeismicViewWidget

Used to restore object's state after exporting

SeismicViewWidget

this

IExportable.endExport

▸ enumerateNodes(callback, target?): void

Executes a provided function once for each child node

void

BaseWidget.enumerateNodes

▸ execute(delegate): SeismicViewWidget

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

SeismicViewWidget

The result if any or this

BaseWidget.execute

▸ execute<T>(delegate): T

T

BaseWidget.execute

▸ exportToPdf(options?): Promise<IWritable>

Exports the widget content as a PDF file, user has option to select the scale of track in pdf.

Promise<IWritable>

promise with output stream

▸ Protected filter(context): boolean

Filter node

boolean

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

BaseWidget.filter

▸ fitToBounds(silent?): SeismicViewWidget

Fit content to bounds

SeismicViewWidget

this

▸ fitToHeight(silent?): SeismicViewWidget

Fit content to height

SeismicViewWidget

this

▸ fitToWidth(silent?): SeismicViewWidget

Fit content to width

SeismicViewWidget

this

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

BaseWidget.getAnimationStyle

▸ getAnnotation(location): Group<Node>

Return the node at the specific annotation

Group<Node>

▸ getAutoModelLimitsMode(): boolean

Get Model Limits Logics to use when no Model Limits have been set set to true: will use parents width and height, starting at 0 set to false: will use parents bounds

boolean

mode

BaseWidget.getAutoModelLimitsMode

▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy

Get Model Limits Logics Strategy

ModelLimitsStrategy

strategy

BaseWidget.getAutoModelLimitsStrategy

▸ getBaseLayer(index): Node

Return baseLayer at specified index

Node

track

BaseWidget.getBaseLayer

▸ getBaseLayers<S>(predicate, modify?): Iterator<Node>

Return iterator by baseLayers nodes

Iterator<Node>

BaseWidget.getBaseLayers

▸ getBaseLayers(filter?, modify?): Iterator<Node>

Returns an iterator for child baseLayers. The iterator does not support adding or deleting items from overlays by default. If it is necessary to modify a collection of overlays, pass true as the last parameter.

Example

// Gets a writable iterator
const it = node.getOverlays(null, true);

Iterator<Node>

An iterator for child overlays.

BaseWidget.getBaseLayers

▸ getBaseLayersCount(): number

Returns amount of baseLayers

number

BaseWidget.getBaseLayersCount

▸ getBounds(): Rect

Get the bounds in the parents model space. If bounds are not set, then parent model limits are used.

Rect

current bounds

BaseWidget.getBounds

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache

BaseWidget.getCache

▸ getChild(i): Node

Return node by index

Node

BaseWidget.getChild

▸ getChildren<S>(predicate, modify?): Iterator<S>

Return iterator by child nodes

Iterator<S>

BaseWidget.getChildren

▸ getChildren(filter?, modify?): Iterator<Node>

Returns an iterator for child nodes. The iterator does not support adding or deleting items from children by default. If it is necessary to modify a collection of children, pass true as the last parameter.

Example

// Gets a writable iterator
const it = node.getChildren(null, true);

Iterator<Node>

An iterator for child nodes.

BaseWidget.getChildren

▸ getChildrenCount(): number

Return number of child nodes

number

BaseWidget.getChildrenCount

▸ getClassName(): string

string

IExportable.getClassName

BaseWidget.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

BaseWidget.getClipStyle

▸ getCollectPerformanceInformation(): boolean

Gets collect performance information mode enabled

boolean

true if collection performance information mode enabled

▸ getColorBarPipeline(): SeismicPipeline

Return pipeline to be used for colorbar

SeismicPipeline

Seismic Pipeline

▸ getContentOrientation(): Orientation

Return content orientation

Orientation

content orientation

BaseWidget.getContentOrientation

▸ getContentsArea(transformation?): Rect

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

Rect

BaseWidget.getContentsArea

▸ getContentsTransform(): Transformation

getContentsTransform() retrieves the world transformation of the node.

Transformation

transformation from model coordinates to bounds of the group

BaseWidget.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

BaseWidget.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

BaseWidget.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]