Class: SvgDiagramVisual

• new SvgDiagramVisual(options)

• new SvgDiagramVisual(options?)

DiagramVisual.constructor

▸ addBaseLayer(baseLayer): SvgDiagramVisual

Add baseLayer to container

SvgDiagramVisual

this

DiagramVisual.addBaseLayer

▸ addChild(node): SvgDiagramVisual

Add a child node

SvgDiagramVisual

this

DiagramVisual.addChild

▸ addCssClass(cssclass): SvgDiagramVisual

Adds new css class to node

SvgDiagramVisual

this

DiagramVisual.addCssClass

▸ addInvalidateHandler(handler): SvgDiagramVisual

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

SvgDiagramVisual

this

DiagramVisual.addInvalidateHandler

▸ addOverlay(overlay): SvgDiagramVisual

Add overlay to container

SvgDiagramVisual

this

DiagramVisual.addOverlay

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

Adjust position of node to specified area

SvgDiagramVisual

this

DiagramVisual.adjustPosition

▸ Protected applyOpacity(context): SvgDiagramVisual

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

SvgDiagramVisual

this

DiagramVisual.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

DiagramVisual.applyResponsiveStyle

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

Changes the z-order of the baseLayer.

SvgDiagramVisual

this

DiagramVisual.changeBaseLayerOrder

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

changes the z-order of the nodes being rendered.

SvgDiagramVisual

this

DiagramVisual.changeChildOrder

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

Changes the z-order of the overlay.

SvgDiagramVisual

this

DiagramVisual.changeOverlayOrder

▸ checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

boolean

true if node is collided

DiagramVisual.checkCollision

▸ clearBaseLayers(disposeBaseLayers?): SvgDiagramVisual

Remove all child baseLayers from group

SvgDiagramVisual

this

DiagramVisual.clearBaseLayers

▸ clearCache(): SvgDiagramVisual

Clear cache

SvgDiagramVisual

this

DiagramVisual.clearCache

▸ clearChildren(disposeChildren?): SvgDiagramVisual

Remove all child nodes from this composite group

SvgDiagramVisual

this

DiagramVisual.clearChildren

▸ clearOverlays(disposeOverlays?): SvgDiagramVisual

Remove all child overlays from group

SvgDiagramVisual

this

DiagramVisual.clearOverlays

▸ clone(): Group<Node>

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

Group<Node>

clone

DiagramVisual.clone

▸ connectStyle(style, type, callback): SvgDiagramVisual

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

SvgDiagramVisual

this

DiagramVisual.connectStyle

▸ copyConstructor(src): SvgDiagramVisual

Creates a copy from the given source

SvgDiagramVisual

DiagramVisual.copyConstructor

▸ disconnectStyle(style, type, callback): SvgDiagramVisual

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

SvgDiagramVisual

this

DiagramVisual.disconnectStyle

▸ dispose(): void

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

void

DiagramVisual.dispose

▸ Protected drawBorder(localContext, bounds?): SvgDiagramVisual

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

SvgDiagramVisual

this

DiagramVisual.drawBorder

▸ enableClipping(doClip): SvgDiagramVisual

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

SvgDiagramVisual

this

DiagramVisual.enableClipping

▸ enableEventPropagation(enable): SvgDiagramVisual

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

SvgDiagramVisual

this

DiagramVisual.enableEventPropagation

▸ enablePickingChildren(enable): SvgDiagramVisual

Enables or disables picking children

SvgDiagramVisual

this

DiagramVisual.enablePickingChildren

▸ enumerateNodes(callback, target?): void

Executes a provided function once for each child node

void

DiagramVisual.enumerateNodes

▸ execute(delegate): SvgDiagramVisual

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

SvgDiagramVisual

The result if any or this

DiagramVisual.execute

▸ execute<T>(delegate): T

T

DiagramVisual.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

DiagramVisual.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

DiagramVisual.getAnimationStyle

▸ 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

DiagramVisual.getAutoModelLimitsMode

▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy

Get Model Limits Logics Strategy

ModelLimitsStrategy

strategy

DiagramVisual.getAutoModelLimitsStrategy

▸ getBaseLayer(index): Node

Return baseLayer at specified index

Node

track

DiagramVisual.getBaseLayer

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

Return iterator by baseLayers nodes

Iterator<Node>

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

DiagramVisual.getBaseLayers

▸ getBaseLayersCount(): number

Returns amount of baseLayers

number

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

DiagramVisual.getBounds

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache

DiagramVisual.getCache

▸ getCategory(): string

Gets component category

string

string instance representing component category

DiagramVisual.getCategory

▸ getChild(i): Node

Return node by index

Node

DiagramVisual.getChild

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

Return iterator by child nodes

Iterator<S>

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

DiagramVisual.getChildren

▸ getChildrenCount(): number

Return number of child nodes

number

DiagramVisual.getChildrenCount

▸ getClassName(): string

string

DiagramVisual.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

DiagramVisual.getClipStyle

▸ getContentOrientation(): Orientation

Return content orientation

Orientation

content orientation

DiagramVisual.getContentOrientation

▸ getContentsArea(transformation?): Rect

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

Rect

DiagramVisual.getContentsArea

▸ getContentsTransform(): Transformation

getContentsTransform() retrieves the world transformation of the node.

Transformation

transformation from model coordinates to bounds of the group

DiagramVisual.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

DiagramVisual.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

DiagramVisual.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

DiagramVisual.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

DiagramVisual.getCssTransform

▸ getDefaultIconSize(): Dimension

Gets the default icon size for UI representation

Deprecated

since 2022 (v3.4)

Dimension

DiagramVisual.getDefaultIconSize

▸ getDefaultSize(): Dimension

Gets default size of the visual

Dimension

DiagramVisual.getDefaultSize

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

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

DiagramVisual.getDesiredWidth

▸ getDeviceLimits(): Rect

Return device limits

Rect

DiagramVisual.getDeviceLimits

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

DiagramVisual.getFillStyle

▸ getGeometry(): Group<Node>

Gets geometry for the current link visual

Group<Node>

DiagramVisual.getGeometry

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

DiagramVisual.getId

▸ getInfiniteMode(): boolean

Return infinity mode flag

boolean

flag

DiagramVisual.getInfiniteMode

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

DiagramVisual.getInvalidateMethod

▸ getIsLinkPointsRelative(): boolean

Gets a flag indicating if the link points are defined in relative (proportional) values

boolean

▸ getLayout(): Layout

Returns layout associated with the group

Layout

layout

DiagramVisual.getLayout

▸ getLayoutStyle(): LayoutStyle<string | number>

return desired layout style

LayoutStyle<string | number>

DiagramVisual.getLayoutStyle

▸ getLineStyle(): LineStyle

Return border style

LineStyle

DiagramVisual.getLineStyle

▸ getLinkPoints(): Point[]

Returns an array of link points. This array may be calculated dynamically if points are defined in relative mode

Point[]

an array of linking points

DiagramVisual.getLinkPoints

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

DiagramVisual.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

DiagramVisual.getMarginsStyle

▸ getModelLimits(): Rect

Gets model limits, the limits of this groups inside space

Rect

the current model limits

DiagramVisual.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

DiagramVisual.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

DiagramVisual.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

DiagramVisual.getOpacityBlendMode

▸ getOutline(): GraphicsPath

Gets outline (path) for the Visual

GraphicsPath

DiagramVisual.getOutline

▸ getOverlay(index): Node

Return overlay at specified index

Node

track

DiagramVisual.getOverlay

▸ getOverlayAt(index): Node

Return overlay at specified index

Deprecated

since 4.2 use getOverlay instead

Node

track

DiagramVisual.getOverlayAt

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

Return iterator by overlays nodes

Iterator<Node>

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

DiagramVisual.getOverlays

▸ getOverlaysCount(): number

Returns amount of overlays

number

DiagramVisual.getOverlaysCount

▸ getPaddingStyle(): SpaceStyle<string | number>

Return padding style

SpaceStyle<string | number>

padding

DiagramVisual.getPaddingStyle

▸ getParent(): Node

Return parent node

Node

parent node

DiagramVisual.getParent

▸ getPreferredSize(): Rect

Return preferred size to layout children

Rect

DiagramVisual.getPreferredSize

▸ getProperties(): OptionsOut

Gets properties

OptionsOut

properties

DiagramVisual.getProperties

▸ getProperty(name): any

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

any

DiagramVisual.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

DiagramVisual.getPropertyKeys

▸ getPrototypeId(): string

Returns component class, string value

string

string instance representing component class

DiagramVisual.getPrototypeId

▸ getPrototypeName(): string

Gets component name

string

string instance representing component name

DiagramVisual.getPrototypeName

▸ getRelativeLinkPoints(): Point[]

Get a collection of relative points, if defined. Values assumed as percentages: 0 - 0%, 1 - 100%

Point[]

an array of relative points

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

DiagramVisual.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

DiagramVisual.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

DiagramVisual.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

DiagramVisual.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

DiagramVisual.getSceneTransform

▸ getSearchKeywords(): string[]

Gets an array of keywords for better search

string[]

an array of search keywords

DiagramVisual.getSearchKeywords

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

DiagramVisual.getTag

▸ getText(): Object

Gets previously set text to the visual

Object

[props] object containing text and its style

DiagramVisual.getText

▸ getUrl(): string

Gets url for icon

string

DiagramVisual.getUrl

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

DiagramVisual.getVisible

▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect

Return visible device limits

Rect

DiagramVisual.getVisibleDeviceLimits

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

DiagramVisual.getVisibleModelLimits

▸ getWorldTransform(): Transformation

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

Transformation

DiagramVisual.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

DiagramVisual.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

DiagramVisual.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

DiagramVisual.hasEventListener

▸ indexOfBaseLayer(baseLayer): number

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

number

DiagramVisual.indexOfBaseLayer

▸ indexOfChild(node): number

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

number

DiagramVisual.indexOfChild

▸ indexOfOverlay(overlay): number

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

number

DiagramVisual.indexOfOverlay

▸ insertBaseLayer(index, baseLayer): SvgDiagramVisual

Insert child baseLayer at specified index

SvgDiagramVisual

this

DiagramVisual.insertBaseLayer

▸ insertChild(index, node): SvgDiagramVisual

Insert child node at specified index

SvgDiagramVisual

this

DiagramVisual.insertChild

▸ insertOverlay(index, overlay): SvgDiagramVisual

Insert child overlay at specified index

SvgDiagramVisual

this

DiagramVisual.insertOverlay

▸ invalidate(bounds?, force?): SvgDiagramVisual

Invalidate node

SvgDiagramVisual

this

DiagramVisual.invalidate

▸ invalidateLayout(propagate?): SvgDiagramVisual

Notify that layout is invalidated. Send event Events.LayoutInvalidated

SvgDiagramVisual

this

DiagramVisual.invalidateLayout

▸ invalidateParent(bounds?, force?): SvgDiagramVisual

Invalidate parent area

SvgDiagramVisual

this

DiagramVisual.invalidateParent

▸ isClippingEnabled(): boolean

Returns if clipping is enabled or not for this node.

boolean

DiagramVisual.isClippingEnabled

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

DiagramVisual.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

DiagramVisual.isEventPropagationEnabled

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

flip

DiagramVisual.isHorizontalFlip

▸ isLayoutInvalidated(): boolean

Return true if layout is invalid

boolean

DiagramVisual.isLayoutInvalidated

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

DiagramVisual.isNotificationEnabled

▸ isPickingChildrenEnabled(): boolean

Returns if picking children is enabled or not for this node.

boolean

pickingChildren

DiagramVisual.isPickingChildrenEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

DiagramVisual.isSelectable

▸ isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

boolean

DiagramVisual.isSilent

▸ isVerticalFlip(): boolean

Return true if the representation is flipped vertically

boolean

flip

DiagramVisual.isVerticalFlip

▸ moveTo(area, vAlign?, hAlign?): SvgDiagramVisual

MoveTo position of node to specified area

SvgDiagramVisual

this

DiagramVisual.moveTo

▸ notify<E>(type, source, args?): SvgDiagramVisual

Notify listeners of the Node

SvgDiagramVisual

this

DiagramVisual.notify

▸ Protected notifyRoot(event, source, args?): Node

Notify an even to root node

Node

this

DiagramVisual.notifyRoot

▸ off<E>(type?, callback?): SvgDiagramVisual

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.

SvgDiagramVisual

this

DiagramVisual.off

▸ on<E>(type, callback): SvgDiagramVisual

Attach listener on event that will be called whenever the specified event is delivered to the target

If the callback function is already in the list of event listeners for this target, the function is not added a second time.

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.

SvgDiagramVisual

this

DiagramVisual.on

▸ Protected onBoundsChanged(bounds): SvgDiagramVisual

Occurs when bounds has been changed

SvgDiagramVisual

this