Class: ShapeElement

• new ShapeElement(options)

• Protected new ShapeElement(options?)

Element.constructor

▸ addBaseLayer(baseLayer): ShapeElement

Add baseLayer to container

ShapeElement

this

Element.addBaseLayer

▸ addChild(node): ShapeElement

Add a child node

ShapeElement

this

Element.addChild

▸ addCssClass(cssclass): ShapeElement

Adds new css class to node

ShapeElement

this

Element.addCssClass

▸ addInvalidateHandler(handler): ShapeElement

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

ShapeElement

this

Element.addInvalidateHandler

▸ addOverlay(overlay): ShapeElement

Add overlay to container

ShapeElement

this

Element.addOverlay

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

Adjust position of node to specified area

ShapeElement

this

Element.adjustPosition

▸ Protected applyOpacity(context): ShapeElement

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

ShapeElement

this

Element.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

Element.applyResponsiveStyle

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

Changes the z-order of the baseLayer.

ShapeElement

this

Element.changeBaseLayerOrder

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

changes the z-order of the nodes being rendered.

ShapeElement

this

Element.changeChildOrder

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

Changes the z-order of the overlay.

ShapeElement

this

Element.changeOverlayOrder

▸ checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

boolean

true if node is collided

Element.checkCollision

▸ clearBaseLayers(disposeBaseLayers?): ShapeElement

Remove all child baseLayers from group

ShapeElement

this

Element.clearBaseLayers

▸ clearCache(): ShapeElement

Clear cache

ShapeElement

this

Element.clearCache

▸ clearChildren(disposeChildren?): ShapeElement

Remove all child nodes from this composite group

ShapeElement

this

Element.clearChildren

▸ clearOverlays(disposeOverlays?): ShapeElement

Remove all child overlays from group

ShapeElement

this

Element.clearOverlays

▸ clone(): Element

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

Element

clone

Element.clone

▸ connectStyle(style, type, callback): ShapeElement

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

ShapeElement

this

Element.connectStyle

▸ Protected copyConstructor(src, deepCopy?): ShapeElement

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

ShapeElement

this

Element.copyConstructor

▸ disconnectStyle(style, type, callback): ShapeElement

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

ShapeElement

this

Element.disconnectStyle

▸ dispose(): void

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

void

Element.dispose

▸ Protected drawBorder(localContext, bounds?): ShapeElement

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

ShapeElement

this

Element.drawBorder

▸ dropCache(): ShapeElement

Rebuild layout

ShapeElement

Element.dropCache

▸ enableClipping(doClip): ShapeElement

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

ShapeElement

this

Element.enableClipping

▸ enableEventPropagation(enable): ShapeElement

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

ShapeElement

this

Element.enableEventPropagation

▸ enablePickingChildren(enable): ShapeElement

Enables or disables picking children

ShapeElement

this

Element.enablePickingChildren

▸ enumerateNodes(callback, target?): void

Executes a provided function once for each child node

void

Element.enumerateNodes

▸ execute(delegate): ShapeElement

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

ShapeElement

The result if any or this

Element.execute

▸ execute<T>(delegate): T

T

Element.execute

▸ exportToImage(showWireBorder?): Image

Export element to image (without rotation)

Image

image

Element.exportToImage

▸ Protected filter(context): boolean

Filter node

boolean

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

Element.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

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

Element.getAutoModelLimitsMode

▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy

Get Model Limits Logics Strategy

ModelLimitsStrategy

strategy

Element.getAutoModelLimitsStrategy

▸ getBaseLayer(index): Node

Return baseLayer at specified index

Node

track

Element.getBaseLayer

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

Return iterator by baseLayers nodes

Iterator<Node>

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

Element.getBaseLayers

▸ getBaseLayersCount(): number

Returns amount of baseLayers

number

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

Element.getBounds

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache

Element.getCache

▸ getChild(i): Node

Return node by index

Node

Element.getChild

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

Return iterator by child nodes

Iterator<S>

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

Element.getChildren

▸ getChildrenCount(): number

Return number of child nodes

number

Element.getChildrenCount

▸ getClassName(): string

string

Element.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

Element.getClipStyle

▸ getContentElement(): ElementContent

Return inner content element

ElementContent

Element.getContentElement

▸ getContentOrientation(): Orientation

Return content orientation

Orientation

content orientation

Element.getContentOrientation

▸ getContentsArea(transformation?): Rect

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

Rect

Element.getContentsArea

▸ getContentsTransform(): Transformation

getContentsTransform() retrieves the world transformation of the node.

Transformation

transformation from model coordinates to bounds of the group

Element.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

Element.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

Element.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

Element.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

Element.getCssTransform

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

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

Element.getDesiredWidth

▸ getDeviceLimits(): Rect

Return device limits

Rect

Element.getDeviceLimits

▸ getDomElement(): AbstractElement

Returns DOM element

AbstractElement

return DOM element

Element.getDomElement

▸ getElementStyle(): ElementStyle

Returns element style

ElementStyle

return element style

Element.getElementStyle

▸ getElementStyle(elementStyle): any

any

Element.getElementStyle

▸ getElementTransformations(bounds?): Transformation[]

Return array of transformations

Transformation[]

array of transformations

Element.getElementTransformations

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

Element.getFillStyle

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

Element.getId

▸ getInfiniteMode(): boolean

Return infinity mode flag

boolean

flag

Element.getInfiniteMode

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

Element.getInvalidateMethod

▸ getLayout(): Layout

Returns layout associated with the group

Layout

layout

Element.getLayout

▸ getLayoutStyle(): LayoutStyle<string | number>

return desired layout style

LayoutStyle<string | number>

Element.getLayoutStyle

▸ getLineStyle(): LineStyle

Return border style

LineStyle

Element.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

Element.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

Element.getMarginsStyle

▸ getModelLimits(): Rect

Gets model limits, the limits of this groups inside space

Rect

the current model limits

Element.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

Element.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

Element.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

Element.getOpacityBlendMode

▸ getOverlay(index): Node

Return overlay at specified index

Node

track

Element.getOverlay

▸ getOverlayAt(index): Node

Return overlay at specified index

Deprecated

since 4.2 use getOverlay instead

Node

track

Element.getOverlayAt

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

Return iterator by overlays nodes

Iterator<Node>

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

Element.getOverlays

▸ getOverlaysCount(): number

Returns amount of overlays

number

Element.getOverlaysCount

▸ getPaddingStyle(): SpaceStyle<string | number>

Return padding style

SpaceStyle<string | number>

padding

Element.getPaddingStyle

▸ getParent(): ElementContent

Return parent node

ElementContent

parent node

Element.getParent

▸ getPreferredElementBounds(limits, cssLayout): Rect

Calculate layout bounds

Rect

preferred bounds

Element.getPreferredElementBounds

▸ getPreferredSize(): Rect

Return preferred size to layout children

Rect

Element.getPreferredSize

▸ getProperties(context?): OptionsOut<Node>

Gets all the properties pertaining to this object

OptionsOut<Node>

properties object

Element.getProperties

▸ getProperty(name): any

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

any

Element.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

Element.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

Element.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

Element.getResponsiveStyle

▸ getRoot(): CompositeNode<Node>

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

CompositeNode<Node>

the root node

Element.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

Element.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

Element.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

Element.getTag

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

Element.getVisible

▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect

Return visible device limits

Rect

Element.getVisibleDeviceLimits

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

Element.getVisibleModelLimits

▸ getWireMode(): boolean

Returns Wire mode

boolean

return wire mode

Element.getWireMode

▸ getWorldTransform(): Transformation

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

Transformation

Element.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

Element.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

Element.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

Element.hasEventListener

▸ indexOfBaseLayer(baseLayer): number

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

number

Element.indexOfBaseLayer

▸ indexOfChild(node): number

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

number

Element.indexOfChild

▸ indexOfOverlay(overlay): number

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

number

Element.indexOfOverlay

▸ insertBaseLayer(index, baseLayer): ShapeElement

Insert child baseLayer at specified index

ShapeElement

this

Element.insertBaseLayer

▸ insertChild(index, node): ShapeElement

Insert child node at specified index

ShapeElement

this

Element.insertChild

▸ insertOverlay(index, overlay): ShapeElement

Insert child overlay at specified index

ShapeElement

this

Element.insertOverlay

▸ invalidate(bounds?, force?): ShapeElement

Invalidate node

ShapeElement

this

Element.invalidate

▸ invalidateLayout(propagate?): ShapeElement

Notify that layout is invalidated. Send event Events.LayoutInvalidated

ShapeElement

this

Element.invalidateLayout

▸ invalidateParent(bounds?, force?): ShapeElement

Invalidate parent area

ShapeElement

this

Element.invalidateParent

▸ isClippingEnabled(): boolean

Returns if clipping is enabled or not for this node.

boolean

Element.isClippingEnabled

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Element.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

Element.isEventPropagationEnabled

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

flip

Element.isHorizontalFlip

▸ isLayoutInvalidated(): boolean

Return true if layout is invalid

boolean

Element.isLayoutInvalidated

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

Element.isNotificationEnabled

▸ isPickingChildrenEnabled(): boolean

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

boolean

pickingChildren

Element.isPickingChildrenEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

Element.isSelectable

▸ isSilent(): boolean

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

boolean

Element.isSilent

▸ isVerticalFlip(): boolean

Return true if the representation is flipped vertically

boolean

flip

Element.isVerticalFlip

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

MoveTo position of node to specified area

ShapeElement

this

Element.moveTo

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

Notify listeners of the Node

ShapeElement

this

Element.notify

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

Notify an even to root node

Node

this

Element.notifyRoot

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

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.

ShapeElement

this

Element.off

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

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.

ShapeElement

this

Element.on

▸ Protected onBoundsChanged(bounds): ShapeElement

Occurs when bounds has been changed

ShapeElement

this

Element.onBoundsChanged

▸ Protected onChildAdded(child): void

This method is called it child or children are added

void

Element.onChildAdded

▸ Protected onChildRemoved(child): void

This method is called it child or children are removed

void

Element.onChildRemoved