Class: CompositeSchematicsWidget

• new CompositeSchematicsWidget(options)

• new CompositeSchematicsWidget(options?)

AnnotatedWidget.constructor

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

add new axis and connect with object

Object

AnnotatedWidget.addAxis

▸ addBaseLayer(baseLayer): CompositeSchematicsWidget

Add baseLayer to container

CompositeSchematicsWidget

this

AnnotatedWidget.addBaseLayer

▸ addChild(node): CompositeSchematicsWidget

Add a child node

CompositeSchematicsWidget

this

AnnotatedWidget.addChild

▸ addCssClass(cssclass): CompositeSchematicsWidget

Adds new css class to node

CompositeSchematicsWidget

this

AnnotatedWidget.addCssClass

▸ addInvalidateHandler(handler): CompositeSchematicsWidget

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

CompositeSchematicsWidget

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 addLegendInteral(options): LegendPanel

LegendPanel

AnnotatedWidget.addLegendInteral

▸ addOverlay(overlay): CompositeSchematicsWidget

Add overlay to container

CompositeSchematicsWidget

this

AnnotatedWidget.addOverlay

▸ addTitle(location, options): void

Add title to annotation

void

AnnotatedWidget.addTitle

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

Adjust position of node to specified area

CompositeSchematicsWidget

this

AnnotatedWidget.adjustPosition

▸ Protected applyOpacity(context): CompositeSchematicsWidget

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

CompositeSchematicsWidget

this

AnnotatedWidget.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

AnnotatedWidget.applyResponsiveStyle

▸ beginExport(): CompositeSchematicsWidget

Prepares object before exporting and saving state

CompositeSchematicsWidget

AnnotatedWidget.beginExport

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

Changes the z-order of the baseLayer.

CompositeSchematicsWidget

this

AnnotatedWidget.changeBaseLayerOrder

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

changes the z-order of the nodes being rendered.

CompositeSchematicsWidget

this

AnnotatedWidget.changeChildOrder

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

Changes the z-order of the overlay.

CompositeSchematicsWidget

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?): CompositeSchematicsWidget

Remove all child baseLayers from group

CompositeSchematicsWidget

this

AnnotatedWidget.clearBaseLayers

▸ clearCache(): CompositeSchematicsWidget

Clear cache

CompositeSchematicsWidget

this

AnnotatedWidget.clearCache

▸ clearChildren(disposeChildren?): CompositeSchematicsWidget

Remove all child nodes from this composite group

CompositeSchematicsWidget

this

AnnotatedWidget.clearChildren

▸ clearOverlays(disposeOverlays?): CompositeSchematicsWidget

Remove all child overlays from group

CompositeSchematicsWidget

this

AnnotatedWidget.clearOverlays

▸ clone(): Group<Node>

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

Group<Node>

clone

AnnotatedWidget.clone

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

Synchronizes object with a model

CompositeSchematicsWidget

this

AnnotatedWidget.connect

▸ connectStyle(style, type, callback): CompositeSchematicsWidget

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

CompositeSchematicsWidget

this

AnnotatedWidget.connectStyle

▸ connectTool(tool): CompositeSchematicsWidget

Connect a new tool with a toolname to the widget

CompositeSchematicsWidget

this

AnnotatedWidget.connectTool

▸ Protected copyConstructor(src, deepCopy?): CompositeSchematicsWidget

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

CompositeSchematicsWidget

this

AnnotatedWidget.copyConstructor

▸ disconnect(object): CompositeSchematicsWidget

Disconnect an object from its source model

CompositeSchematicsWidget

this

AnnotatedWidget.disconnect

▸ disconnectStyle(style, type, callback): CompositeSchematicsWidget

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

CompositeSchematicsWidget

this

AnnotatedWidget.disconnectStyle

▸ disconnectTool(tool): CompositeSchematicsWidget

Disconnect the tool from the widget

CompositeSchematicsWidget

this

AnnotatedWidget.disconnectTool

▸ dispose(): void

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

void

AnnotatedWidget.dispose

▸ Protected drawBorder(localContext, bounds?): CompositeSchematicsWidget

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

CompositeSchematicsWidget

this

AnnotatedWidget.drawBorder

▸ enableClipping(doClip): CompositeSchematicsWidget

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

CompositeSchematicsWidget

this

AnnotatedWidget.enableClipping

▸ enableEventPropagation(enable): CompositeSchematicsWidget

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

CompositeSchematicsWidget

this

AnnotatedWidget.enableEventPropagation

▸ enablePickingChildren(enable): CompositeSchematicsWidget

Enables or disables picking children

CompositeSchematicsWidget

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

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

CompositeSchematicsWidget

The result if any or this

AnnotatedWidget.execute

▸ execute<T>(delegate): T

T

AnnotatedWidget.execute

▸ exportToPdf(options?): Promise<any>

Exports current representation to PDF

See

• SchematicsWidget.exportToPdf for details
• DeviatedSchematicsWidget~exportToPdf for details

Promise<any>

AnnotatedWidget.exportToPdf

▸ Protected filter(context): boolean

Filter node

boolean

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

AnnotatedWidget.filter

▸ fitToBounds(): CompositeSchematicsWidget

fit bounds to model limits

CompositeSchematicsWidget

this

AnnotatedWidget.fitToBounds

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

AnnotatedWidget.getAnimationStyle

▸ getAnnotation(location): Group<Node>

return the node at the specific annotation

Group<Node>

AnnotatedWidget.getAnnotation

▸ getAnnotationSize(): Required<AnnotationSize>

Return sizes of all annotations or the exact one

Required<AnnotationSize>

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>(predicate, modify?): Iterator<Node>

Return iterator by baseLayers nodes

Iterator<Node>

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

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

Return model limits

Rect

annotated model limits

AnnotatedWidget.getCenterModelLimits

▸ getChild(i): Node

Return node by index

Node

AnnotatedWidget.getChild

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

Return iterator by child nodes

Iterator<S>

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

AnnotatedWidget.getChildren

▸ getChildrenCount(): number

Return number of child nodes

number

AnnotatedWidget.getChildrenCount

▸ getClassName(): string

string

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

getContentsTransform() 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(): Object

Gets data

Object

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

▸ Protected getDisplays(): Iterator<any>

Iterator<any>

▸ 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>

Returns export state

Record<string, any>

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>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

AnnotatedWidget.getInvalidateMethod

▸ getLayout(): Layout

Returns layout associated with the group

Layout

layout

AnnotatedWidget.getLayout

▸ getLayoutStyle(): LayoutStyle<string | number>

return desired layout style

LayoutStyle<string | number>

AnnotatedWidget.getLayoutStyle

▸ getLegendLayer(): Group<Node>

Returns layer to keep legend on top of widget

Group<Node>

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>

return manipulator layer

CompositeNode<Node>

AnnotatedWidget.getManipulatorLayer

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

AnnotatedWidget.getMarginsStyle

▸ getModel(): Group<Node>

Gets current model node

Group<Node>

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.
If conversion fails then returned point contains NaN values as its x- and y- ordinates.

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

Gets widget options

See

CompositeSchematicsWidget.setOptions for details

object

widget options

▸ 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>

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

Layer<Node>

AnnotatedWidget.getOverlayLayer

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

Return iterator by overlays nodes

Iterator<Node>

AnnotatedWidget.getOverlays

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

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>

An iterator for child overlays.

AnnotatedWidget.getOverlays

▸ getOverlaysCount(): number

Returns amount of overlays

number

AnnotatedWidget.getOverlaysCount

▸ getPaddingStyle(): SpaceStyle<string | number>

Return padding style

SpaceStyle<string | number>

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?): any

Gets all the properties pertaining to this object

any

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

▸ 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

CompositeTool

AnnotatedWidget.getTool

▸ getToolByName<T>(toolName): Tools[T]

Returns the tool matching the given name.
This function also accepts tool 'path' instead of absolute name.
For example:
getToolByName("compositeTool.panningTools.trackPanning.TrackPanning")
Would return the same tool as
getToolByName("TrackPanning")
As long as there is only one tool named "TrackPanning" in this composite
See listToolsNames()

Tools[T]

AnnotatedWidget.getToolByName

▸ getToolByType(toolType): AbstractTool

Returns the tool matching the given type. or null if nothing is matching the tool type
For example:
getToolByType(geotoolkit.controls.tools.Selection)
Would return the same tool as
getToolByName("pick")

AbstractTool

AnnotatedWidget.getToolByType

▸ getToolsOptions(): ToolsOptionsOut

Gets Tools Options

ToolsOptionsOut

JSON which defines tools options

AnnotatedWidget.getToolsOptions

▸ getViewMode(): ViewMode

Gets well bore view mode

ViewMode

viewMode

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

AnnotatedWidget.getVisible

▸ getVisibleCenterModelLimits(ignoreModelLimits?): Rect

Returns visible model limits of the center model

Rect

AnnotatedWidget.getVisibleCenterModelLimits

▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect

Return visible device limits

Rect

AnnotatedWidget.getVisibleDeviceLimits

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

AnnotatedWidget.getVisibleModelLimits

▸ getWorldTransform(): Transformation

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

Transformation

AnnotatedWidget.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

AnnotatedWidget.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

AnnotatedWidget.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

AnnotatedWidget.hasEventListener

▸ indexOfBaseLayer(baseLayer): number

Return index of overlay ( index of the specified child or -1 if baseLayer is not found)

number

AnnotatedWidget.indexOfBaseLayer

▸ indexOfChild(node): number

Return index of child ( index of the specified child or -1 if node is not found)

number

AnnotatedWidget.indexOfChild

▸ indexOfOverlay(overlay): number

Return index of overlay ( index of the specified child or -1 if overlay is not found)

number

AnnotatedWidget.indexOfOverlay

▸ Protected initializeFloatingAnnotationTool(): FloatingAnnotationTool

FloatingAnnotationTool

AnnotatedWidget.initializeFloatingAnnotationTool

▸ initializeLayout(settings): Group<Node>

Group<Node>

AnnotatedWidget.initializeLayout

▸ Protected initializeTools(options?): CompositeSchematicsWidget

function call in the constructor to initialize tools in the widget
This widget contains by default :

• CrossHair tool
  
• RubberBand tool
  
• Panning tool
  
• HorizontalScroll
  
• VerticalScroll
  

CompositeSchematicsWidget

this

AnnotatedWidget.initializeTools

▸ insertAxis(axisIndex, axis, location, connectedObject?): Object

Insert new axis and connect with object

Object

AnnotatedWidget.insertAxis