Class: SchematicsWidget

• [new SchematicsWidget(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.schematics.widgets-2.schematicswidget.schematicswidget.md#new schematicswidget(options))

• new SchematicsWidget(options?)

AnnotatedWidget.constructor

▸ addAxis(axis, location, connectedObject?): Object

add new axis and connect with object

Object

AnnotatedWidget.addAxis

▸ addBaseLayer(baseLayer): SchematicsWidget

Add baseLayer to container

SchematicsWidget

this

AnnotatedWidget.addBaseLayer

▸ addChild(node): SchematicsWidget

Add a child node

SchematicsWidget

this

AnnotatedWidget.addChild

▸ addCssClass(cssclass): SchematicsWidget

Adds new css class to node

SchematicsWidget

this

AnnotatedWidget.addCssClass

▸ addInvalidateHandler(handler): SchematicsWidget

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

SchematicsWidget

this

AnnotatedWidget.addInvalidateHandler

▸ addLegend(options): LegendPanel

Creates legend, scrollable panel and interactive tools for the options provided. If legend already exists, does nothing.

Example

widget.addLegend({
// use known types to create legend items automatically (from charts)
// use custom string item for user setup
'alignment': AnchorType.LeftTop,
'offset': new Point(60, 40)
});

LegendPanel

AnnotatedWidget.addLegend

▸ Protected addLegendInternal(options): LegendPanel

LegendPanel

AnnotatedWidget.addLegendInternal

▸ addOverlay(overlay): SchematicsWidget

Add overlay to container

SchematicsWidget

this

AnnotatedWidget.addOverlay

▸ addTitle(location, options): void

Add title to annotation

void

AnnotatedWidget.addTitle

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

Adjust position of node to specified area

SchematicsWidget

this

AnnotatedWidget.adjustPosition

▸ Protected applyOpacity(context): SchematicsWidget

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

SchematicsWidget

this

AnnotatedWidget.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

AnnotatedWidget.applyResponsiveStyle

▸ beginExport(): SchematicsWidget

Prepares object before exporting and saving state

SchematicsWidget

AnnotatedWidget.beginExport

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

Changes the z-order of the baseLayer.

SchematicsWidget

this

AnnotatedWidget.changeBaseLayerOrder

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

changes the z-order of the nodes being rendered.

SchematicsWidget

this

AnnotatedWidget.changeChildOrder

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

Changes the z-order of the overlay.

SchematicsWidget

this

AnnotatedWidget.changeOverlayOrder

▸ checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

boolean

true if node is collided

AnnotatedWidget.checkCollision

▸ clearBaseLayers(disposeBaseLayers?): SchematicsWidget

Remove all child baseLayers from group

SchematicsWidget

this

AnnotatedWidget.clearBaseLayers

▸ clearCache(): SchematicsWidget

Clear cache

SchematicsWidget

this

AnnotatedWidget.clearCache

▸ clearChildren(disposeChildren?): SchematicsWidget

Remove all child nodes from this composite group

SchematicsWidget

this

AnnotatedWidget.clearChildren

▸ clearOverlays(disposeOverlays?): SchematicsWidget

Remove all child overlays from group

SchematicsWidget

this

AnnotatedWidget.clearOverlays

▸ clone(): Group<Node&gt;

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

Group<Node&gt;

clone

AnnotatedWidget.clone

▸ connect(object, model, orientation?, autoSize?): SchematicsWidget

Synchronizes object with a model

SchematicsWidget

this

AnnotatedWidget.connect

▸ connectStyle(style, type, callback): SchematicsWidget

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

SchematicsWidget

this

AnnotatedWidget.connectStyle

▸ connectTool(tool): SchematicsWidget

Connect a new tool with a toolname to the widget

SchematicsWidget

this

AnnotatedWidget.connectTool

▸ Protected copyConstructor(src, deepCopy?): SchematicsWidget

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

SchematicsWidget

this

AnnotatedWidget.copyConstructor

▸ disconnect(object): SchematicsWidget

Disconnect an object from its source model

SchematicsWidget

this

AnnotatedWidget.disconnect

▸ disconnectStyle(style, type, callback): SchematicsWidget

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

SchematicsWidget

this

AnnotatedWidget.disconnectStyle

▸ disconnectTool(tool): SchematicsWidget

Disconnect the tool from the widget

SchematicsWidget

this

AnnotatedWidget.disconnectTool

▸ dispose(): void

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

void

AnnotatedWidget.dispose

▸ Protected drawBorder(localContext, bounds?): SchematicsWidget

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

SchematicsWidget

this

AnnotatedWidget.drawBorder

▸ enableClipping(doClip): SchematicsWidget

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

SchematicsWidget

this

AnnotatedWidget.enableClipping

▸ enableEventPropagation(enable): SchematicsWidget

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

SchematicsWidget

this

AnnotatedWidget.enableEventPropagation

▸ enablePickingChildren(enable): SchematicsWidget

Enables or disables picking children

SchematicsWidget

this

AnnotatedWidget.enablePickingChildren

▸ endExport(): void

Restores object's state after exporting

void

AnnotatedWidget.endExport

▸ enumerateNodes(callback, target?): void

Executes a provided function once for each child node

void

AnnotatedWidget.enumerateNodes

▸ execute(delegate): SchematicsWidget

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

SchematicsWidget

The result if any or this

AnnotatedWidget.execute

▸ execute<T&gt;(delegate): T

T

AnnotatedWidget.execute

▸ exportToPdf(options?): Promise<IWritable&gt;

Export a part of the container to PDF <p>This method sets automatically export scale and limits based on input parameters and current model scale and limits</p>

Promise<IWritable&gt;

promise with output stream

AnnotatedWidget.exportToPdf

▸ Protected filter(context): boolean

Filter node

boolean

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

AnnotatedWidget.filter

▸ fitToBounds(): SchematicsWidget

fit bounds to model limits

Fires

Events.ModelVisibleLimitsChanged

SchematicsWidget

this

AnnotatedWidget.fitToBounds

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

AnnotatedWidget.getAnimationStyle

▸ getAnnotation(location): Group<Node&gt;

return the node at the specific annotation

Group<Node&gt;

AnnotatedWidget.getAnnotation

▸ getAnnotationSize(): Required<AnnotationSize&gt;

Return sizes of all annotations or the exact one

Required<AnnotationSize&gt;

contains size of all annotations

AnnotatedWidget.getAnnotationSize

▸ getAnnotationSize(loc): string | number

string | number

AnnotatedWidget.getAnnotationSize

▸ 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

AnnotatedWidget.getAutoModelLimitsMode

▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy

Get Model Limits Logics Strategy

ModelLimitsStrategy

strategy

AnnotatedWidget.getAutoModelLimitsStrategy

▸ getBaseLayer(index): Node

Return baseLayer at specified index

Node

track

AnnotatedWidget.getBaseLayer

▸ getBaseLayers<S&gt;(predicate, modify?): Iterator<Node&gt;

Return iterator by baseLayers nodes

Iterator<Node&gt;

AnnotatedWidget.getBaseLayers

▸ getBaseLayers(filter?, modify?): Iterator<Node&gt;

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

An iterator for child overlays.

AnnotatedWidget.getBaseLayers

▸ getBaseLayersCount(): number

Returns amount of baseLayers

number

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

AnnotatedWidget.getBounds

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache

AnnotatedWidget.getCache

▸ getCenterModelLimits(): Rect

Gets WellBoreNode's model limits

Rect

ISchematicsWidget.getCenterModelLimits

AnnotatedWidget.getCenterModelLimits

▸ getChild(i): Node

Return node by index

Node

AnnotatedWidget.getChild

▸ getChildren<S&gt;(predicate, modify?): Iterator<S&gt;

Return iterator by child nodes

Iterator<S&gt;

AnnotatedWidget.getChildren

▸ getChildren(filter?, modify?): Iterator<Node&gt;

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

An iterator for child nodes.

AnnotatedWidget.getChildren

▸ getChildrenCount(): number

Return number of child nodes

number

AnnotatedWidget.getChildrenCount

▸ getClassName(): string

string

ISchematicsWidget.getClassName

AnnotatedWidget.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

AnnotatedWidget.getClipStyle

▸ getContentOrientation(): Orientation

Return content orientation

Orientation

content orientation

AnnotatedWidget.getContentOrientation

▸ getContentsArea(transformation?): Rect

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

Rect

AnnotatedWidget.getContentsArea

▸ getContentsTransform(): Transformation

<code>getContentsTransform()</code> retrieves the world transformation of the node.

Transformation

transformation from model coordinates to bounds of the group

AnnotatedWidget.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

AnnotatedWidget.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

AnnotatedWidget.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

AnnotatedWidget.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

AnnotatedWidget.getCssTransform

▸ getData(): WellBoreData

Gets WellBoreData data instance

WellBoreData

AnnotatedWidget.getData

▸ getDesiredHeight(): string | number

Returns desired height of the group as a layoutable object This method is a helper method to get access to getLayoutStyle()

string | number

desired height ("undefined" by default)

AnnotatedWidget.getDesiredHeight

▸ getDesiredWidth(): string | number

Returns desired width of the group as a layoutable object. This method is a helper method to get access to getLayoutStyle()

string | number

desired width ("undefined" by default)

AnnotatedWidget.getDesiredWidth

▸ getDeviceLimits(): Rect

Return device limits

Rect

AnnotatedWidget.getDeviceLimits

▸ getDevicePoint(modelPoint, devicePoint?): Point

Gets device coordinates at given model ones

Point

▸ getExportElement(options?): CompositeDocumentElement

Returns exportable element

CompositeDocumentElement

return exportable element

AnnotatedWidget.getExportElement

▸ getExportLimits(): Rect

Return export limits

Rect

AnnotatedWidget.getExportLimits

▸ getExportScale(): Object

Gets export scale. By default scale is not set and equal to screen scale

Object

scale

AnnotatedWidget.getExportScale

▸ Protected getExportState(): Record<string, any&gt;

Returns export state

Record<string, any&gt;

export state

AnnotatedWidget.getExportState

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

AnnotatedWidget.getFillStyle

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

AnnotatedWidget.getId

▸ getInfiniteMode(): boolean

Return infinity mode flag

boolean

flag

AnnotatedWidget.getInfiniteMode

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

Gets invalidate method

AttributeCallback<EventDispatcher&gt;

method to invalidate this object

AnnotatedWidget.getInvalidateMethod

▸ getLabelingStrategy(): LabelingStrategy

Gets labeling strategy

LabelingStrategy

ISchematicsWidget.getLabelingStrategy

▸ getLayout(): Layout

Returns layout associated with the group

Layout

layout

AnnotatedWidget.getLayout

▸ getLayoutStyle(): LayoutStyle<string | number&gt;

return desired layout style

LayoutStyle<string | number&gt;

AnnotatedWidget.getLayoutStyle

▸ getLegendLayer(): Group<Node&gt;

Returns layer to keep legend on top of widget

Group<Node&gt;

AnnotatedWidget.getLegendLayer

▸ getLineStyle(): LineStyle

Return border style

LineStyle

AnnotatedWidget.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

AnnotatedWidget.getLocalTransform

▸ getManipulatorLayer(): CompositeNode<Node&gt;

return manipulator layer

CompositeNode<Node&gt;

AnnotatedWidget.getManipulatorLayer

▸ getMarginsStyle(): SpaceStyle<string | number&gt;

Return margins style

SpaceStyle<string | number&gt;

AnnotatedWidget.getMarginsStyle

▸ getModel(): Group<Node&gt;

get model node

Group<Node&gt;

AnnotatedWidget.getModel

▸ getModelLimits(): Rect

Gets model limits, the limits of this groups inside space

Rect

the current model limits

AnnotatedWidget.getModelLimits

▸ getModelPoint(devicePoint, modelPoint?): Point

Gets model coordinates (where y-ordinate is true MD-value) at given device ones

Point

▸ getName(): string

Returns the node name

string

The node name

AnnotatedWidget.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

AnnotatedWidget.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

AnnotatedWidget.getOpacityBlendMode

▸ getOptions(): any

Gets widget options (see "setOptions" API for the options format)

any

widget options

ISchematicsWidget.getOptions

▸ getOverlay(index): Node

Return overlay at specified index

Node

track

AnnotatedWidget.getOverlay

▸ getOverlayAt(index): Node

Return overlay at specified index

Deprecated

since 4.2 use getOverlay instead

Node

track

AnnotatedWidget.getOverlayAt

▸ getOverlayLayer(): Layer<Node&gt;

Returns manipulator overlay to draw shapes that should move with the model

Layer<Node&gt;

AnnotatedWidget.getOverlayLayer

▸ getOverlays<S&gt;(predicate, modify?): Iterator<Node&gt;

Return iterator by overlays nodes

Iterator<Node&gt;

AnnotatedWidget.getOverlays

▸ getOverlays(filter?, modify?): Iterator<Node&gt;

Returns an iterator for child overlays. 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&gt;

An iterator for child overlays.

AnnotatedWidget.getOverlays

▸ getOverlaysCount(): number

Returns amount of overlays

number

AnnotatedWidget.getOverlaysCount

▸ getPaddingStyle(): SpaceStyle<string | number&gt;

Return padding style

SpaceStyle<string | number&gt;

padding

AnnotatedWidget.getPaddingStyle

▸ getParent(): Node

Return parent node

Node

parent node

AnnotatedWidget.getParent

▸ getPreferredSize(): Rect

Return preferred size to layout children

Rect

AnnotatedWidget.getPreferredSize

▸ getProperties(context?): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties object

AnnotatedWidget.getProperties

▸ getProperty(name): any

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

any

AnnotatedWidget.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AnnotatedWidget.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

AnnotatedWidget.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

AnnotatedWidget.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

AnnotatedWidget.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets ScaleScrollStrategy ("undefined" by default)

Delegate

ScaleScrollStrategy (see "setScaleScrollStrategy" description for more info)

AnnotatedWidget.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

AnnotatedWidget.getSceneTransform

▸ getSelectedComponentNodes(): ComponentNode[]

Gets selected component nodes

ComponentNode[]

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

AnnotatedWidget.getTag

▸ getTool(): CompositeTool

Returns root tool associated to this widget