Class: SeismicWidget

• new SeismicWidget(options)

• new SeismicWidget(options?)

Create seismic widget

SeismicViewWidget.constructor

▸ addBaseLayer(baseLayer): SeismicWidget

Add baseLayer to container

SeismicWidget

this

SeismicViewWidget.addBaseLayer

▸ addChild(node): SeismicWidget

Add a child node

SeismicWidget

this

SeismicViewWidget.addChild

▸ addCssClass(cssclass): SeismicWidget

Adds new css class to node

SeismicWidget

this

SeismicViewWidget.addCssClass

▸ addHeaderChart(headerName, options?): SeismicWidget

Add header chart

SeismicWidget

this

▸ addInvalidateHandler(handler): SeismicWidget

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

SeismicWidget

this

SeismicViewWidget.addInvalidateHandler

▸ addOverlay(overlay): SeismicWidget

Add overlay to container

SeismicWidget

this

SeismicViewWidget.addOverlay

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

Adjust position of node to specified area

SeismicWidget

this

SeismicViewWidget.adjustPosition

▸ Protected applyOpacity(context): SeismicWidget

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

SeismicWidget

this

SeismicViewWidget.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

SeismicViewWidget.applyResponsiveStyle

▸ beginExport(options?): SeismicWidget

Used to prepare object before exporting

SeismicWidget

this

SeismicViewWidget.beginExport

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

Changes the z-order of the baseLayer.

SeismicWidget

this

SeismicViewWidget.changeBaseLayerOrder

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

changes the z-order of the nodes being rendered.

SeismicWidget

this

SeismicViewWidget.changeChildOrder

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

Changes the z-order of the overlay.

SeismicWidget

this

SeismicViewWidget.changeOverlayOrder

▸ checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

boolean

true if node is collided

SeismicViewWidget.checkCollision

▸ clearBaseLayers(disposeBaseLayers?): SeismicWidget

Remove all child baseLayers from group

SeismicWidget

this

SeismicViewWidget.clearBaseLayers

▸ clearCache(): SeismicWidget

Clear cache

SeismicWidget

this

SeismicViewWidget.clearCache

▸ clearChildren(disposeChildren?): SeismicWidget

Remove all child nodes from this composite group

SeismicWidget

this

SeismicViewWidget.clearChildren

▸ clearOverlays(disposeOverlays?): SeismicWidget

Remove all child overlays from group

SeismicWidget

this

SeismicViewWidget.clearOverlays

▸ clone(): Group<Node>

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

Group<Node>

clone

SeismicViewWidget.clone

▸ connectStyle(style, type, callback): SeismicWidget

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

SeismicWidget

this

SeismicViewWidget.connectStyle

▸ connectTool(tool): SeismicWidget

Connect a new tool with a toolname to the widget

SeismicWidget

this

SeismicViewWidget.connectTool

▸ Protected copyConstructor(src, deepCopy?): SeismicWidget

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

SeismicWidget

this

SeismicViewWidget.copyConstructor

▸ disconnectStyle(style, type, callback): SeismicWidget

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

SeismicWidget

this

SeismicViewWidget.disconnectStyle

▸ disconnectTool(tool): SeismicWidget

Disconnect the tool from the widget

SeismicWidget

this

SeismicViewWidget.disconnectTool

▸ 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

SeismicViewWidget.dispose

▸ Protected drawBorder(localContext, bounds?): SeismicWidget

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

SeismicWidget

this

SeismicViewWidget.drawBorder

▸ enableClipping(doClip): SeismicWidget

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

SeismicWidget

this

SeismicViewWidget.enableClipping

▸ enableEventPropagation(enable): SeismicWidget

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

SeismicWidget

this

SeismicViewWidget.enableEventPropagation

▸ enablePickingChildren(enable): SeismicWidget

Enables or disables picking children

SeismicWidget

this

SeismicViewWidget.enablePickingChildren

▸ endExport(options?): SeismicWidget

Used to restore object's state after exporting

SeismicWidget

this

SeismicViewWidget.endExport

▸ enumerateNodes(callback, target?): void

Executes a provided function once for each child node

void

SeismicViewWidget.enumerateNodes

▸ execute(delegate): SeismicWidget

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

SeismicWidget

The result if any or this

SeismicViewWidget.execute

▸ execute<T>(delegate): T

T

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

SeismicViewWidget.exportToPdf

▸ Protected filter(context): boolean

Filter node

boolean

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

SeismicViewWidget.filter

▸ fitToBounds(silent?): SeismicWidget

Fit content to bounds

SeismicWidget

this

SeismicViewWidget.fitToBounds

▸ fitToHeight(silent?): SeismicWidget

Fit content to height

SeismicWidget

this

SeismicViewWidget.fitToHeight

▸ fitToWidth(silent?): SeismicWidget

Fit content to width

SeismicWidget

this

SeismicViewWidget.fitToWidth

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

SeismicViewWidget.getAnimationStyle

▸ getAnnotation(location): Group<Node>

Return the node at the specific annotation

Group<Node>

SeismicViewWidget.getAnnotation

▸ 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

SeismicViewWidget.getAutoModelLimitsMode

▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy

Get Model Limits Logics Strategy

ModelLimitsStrategy

strategy

SeismicViewWidget.getAutoModelLimitsStrategy

▸ getAuxiliaryChart(): TraceHeaderChartWidget

Returns Auxiliary chart widget

TraceHeaderChartWidget

▸ getBaseLayer(index): Node

Return baseLayer at specified index

Node

track

SeismicViewWidget.getBaseLayer

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

Return iterator by baseLayers nodes

Iterator<Node>

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

SeismicViewWidget.getBaseLayers

▸ getBaseLayersCount(): number

Returns amount of baseLayers

number

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

SeismicViewWidget.getBounds

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache

SeismicViewWidget.getCache

▸ getChild(i): Node

Return node by index

Node

SeismicViewWidget.getChild

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

Return iterator by child nodes

Iterator<S>

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