Class: AnchoredShape

• Protected new AnchoredShape(ax?, ay?, width?, height?, alignment?, sizeIsInDeviceSpace?, linestyle?, fillstyle?)

Shape.constructor

• Protected new AnchoredShape(options?)

Shape.constructor

▸ addCssClass(cssclass): AnchoredShape

Adds new css class to node

AnchoredShape

this

Shape.addCssClass

▸ addInvalidateHandler(handler): AnchoredShape

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

AnchoredShape

this

Shape.addInvalidateHandler

▸ Protected applyOpacity(context): AnchoredShape

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

AnchoredShape

this

Shape.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

Shape.applyResponsiveStyle

▸ checkCollision(context): boolean

Check if this node is within the area being rendered by the context

boolean

true if object is inside of renderable area

Shape.checkCollision

▸ clone(): Node

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

Node

clone

Shape.clone

▸ connectStyle(style, type, callback): AnchoredShape

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

AnchoredShape

this

Shape.connectStyle

▸ Protected copyConstructor(src, deepCopy?): AnchoredShape

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

AnchoredShape

this

Shape.copyConstructor

▸ disconnectStyle(style, type, callback): AnchoredShape

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

AnchoredShape

this

Shape.disconnectStyle

▸ 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

Shape.dispose

▸ enableEventPropagation(enable): AnchoredShape

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

AnchoredShape

this

Shape.enableEventPropagation

▸ execute(delegate): AnchoredShape

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

AnchoredShape

The result if any or this

Shape.execute

▸ execute<T>(delegate): T

T

Shape.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

Shape.filter

▸ getAnchor(tr?): Point

Gets the anchor

Point

▸ getAnchorType(): AnchorType

Returns the current anchor type.

AnchorType

current anchor type

▸ getAnchorX(): number

Return anchored x position

number

▸ getAnchorY(): number

Return anchored y position

number

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

Shape.getAnimationStyle

▸ getAspectRatio(): number

Returns aspect ratio of the content of the shape Returns 1

number

▸ getBounds(): Rect

Return bound in the parent coordinates

Rect

ILayoutable.getBounds

▸ getClassName(): string

string

Shape.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

Shape.getClipStyle

▸ getCss(): CssStyle

Return CSS style

CssStyle

Shape.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

Shape.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

Shape.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

Shape.getCssTransform

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

Shape.getFillStyle

▸ getHeight(): number

Return height of the shape

number

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

Shape.getId

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

Shape.getInvalidateMethod

▸ getIsPointingUp(): boolean

Returns true if the shape is always pointing up

boolean

true if the shape is always pointing up

▸ getLayoutStyle(): LayoutStyle<string | number>

Return desired layout style

LayoutStyle<string | number>

ILayoutable.getLayoutStyle

▸ getLineStyle(): LineStyle

Return line style

LineStyle

lineStyle current line style

Shape.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

Shape.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

Shape.getMarginsStyle

▸ getMaxSize(): Dimension

returns the maximum device space rendering dimension only works when setUseMinMaxSize is enabled.

Dimension

max size

▸ getMinSize(): Dimension

returns the minimum device space rendering dimension only works when setUseMinMaxSize is enabled.

Dimension

min size

▸ getName(): string

Returns the node name

string

The node name

Shape.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

Shape.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

Shape.getOpacityBlendMode

▸ getParent(): Node

Return parent node

Node

parent node

ILayoutable.getParent

Shape.getParent

▸ getPreserveAspectRatio(): boolean

Returns true if aspect ratio is preserved

boolean

true if aspect ratio is preserved

▸ getPreserveReadingOrientation(): boolean

Returns true if the shape is always in a readable orientation

boolean

true if the shape is always in a readable orientation

▸ getPreserveRightAngle(): boolean

Returns true if right angles are preserved

boolean

true if right angles are preserved

▸ getProperties(context?): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties object

Shape.getProperties

▸ getProperty(name): any

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

any

Shape.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

Shape.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

Shape.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

Shape.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

Shape.getRoot

▸ getRotationAngle(): number

Returns rotation angle (in radians)

number

rotationAngle rotation angle at anchor

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

Shape.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

Shape.getSceneTransform

▸ getSize(): Dimension

Returns the size as a dimension object.

Dimension

size

▸ getSizeIsInDeviceSpace(): boolean

Returns true if the shape size is set in device space

boolean

true if size is defined in device space

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

Shape.getTag

▸ getUseMinMaxSize(): boolean

true if using the min max device space sizes

boolean

true if using the min max device space sizes

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

Shape.getVisible

▸ getWidth(): number

Return width of the shape

number

▸ getWorldTransform(): Transformation

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

Transformation

transform the world transform.

Shape.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

Shape.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

Shape.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

Shape.hasEventListener

▸ invalidate(bounds?, force?): AnchoredShape

Invalidate area of the shape. This method invalidates parent by default. invalidated from parent to root node.

AnchoredShape

this

Shape.invalidate

▸ invalidateParent(bounds?, force?): AnchoredShape

Invalidate bounds

AnchoredShape

this

Shape.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Shape.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

Shape.isEventPropagationEnabled

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

Shape.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

Shape.isSelectable

▸ isSilent(): boolean

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

boolean

Shape.isSilent

▸ notify<E>(event, source, args?): AnchoredShape

Notify listeners of the Node

AnchoredShape

this

Shape.notify

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

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.

AnchoredShape

this

Shape.off

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

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.

AnchoredShape

this

Shape.on

▸ Protected onParentChanged(node): AnchoredShape

This method is called when parent changes. Do not call it directly.

AnchoredShape

this

Shape.onParentChanged

▸ Protected onVisibilityChanged(): void

This method is called if visibility is changed. Send event Events.VisibilityChanged

void

Shape.onVisibilityChanged

▸ Protected postRendering(context): void

To be called after rendering. Call this method if you override method render

void

Shape.postRendering

▸ Protected preRendering(context): void

Occurs before rendering this method sets clipping by default. Call this method if you override method render

void

Shape.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

Shape.registerAnimationStyle

▸ removeCssClass(cssclass): AnchoredShape

Removes css class from node

AnchoredShape

this

Shape.removeCssClass

▸ removeInvalidateHandler(handler): AnchoredShape

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

AnchoredShape

this

Shape.removeInvalidateHandler

▸ Abstract render(context): void

Renders node

void

Shape.render

▸ renderAsync(context, callback): void

Render node in asynchronous mode. Default implementation creates call method "render" inside

void

Shape.renderAsync

▸ rotate(theta, x?, y?): AnchoredShape

Rotate bounds around a given coordinate or anchor point

AnchoredShape

this

Shape.rotate

▸ scale(xx, yy): AnchoredShape

Scale node

AnchoredShape

this

Shape.scale

▸ setAnchor(p): AnchoredShape

Sets anchor point to given position

AnchoredShape

this

▸ setAnchor(x, y): AnchoredShape

Sets anchor point to given position

AnchoredShape

this

▸ setAnchorType(alignment): AnchoredShape

Sets the anchor type.

AnchoredShape

this

▸ setAnchorX(ax): AnchoredShape

Sets x anchor position

AnchoredShape

this

▸ setAnchorY(ay): AnchoredShape

Sets y anchor position

AnchoredShape

this

▸ setAnimationStyle(animationStyle): AnchoredShape

Sets animation style

AnchoredShape

Shape.setAnimationStyle

▸ setBounds(bounds): AnchoredShape

Sets bounds of the node in the parent coordinates. This method takes anchor position and width and height if size is not in device space. This method was added to support layout.

AnchoredShape

this

ILayoutable.setBounds

▸ setClipStyle(style): AnchoredShape

Sets a new clipping style

AnchoredShape

this

Shape.setClipStyle

▸ setCss(style, merge?): AnchoredShape

Sets CSS style. This style will be applied for all inserted elements

AnchoredShape

this

Shape.setCss

▸ setCssClass(name): AnchoredShape

Sets css class name of the node to be used to apply CSS style

AnchoredShape

this

Shape.setCssClass

▸ setCssTransform(transform): AnchoredShape

Set CSS transformation

AnchoredShape

this

Shape.setCssTransform

▸ setFillStyle(fillStyle, merge?): AnchoredShape

Sets fill style

AnchoredShape

this

Shape.setFillStyle

▸ setHeight(height): AnchoredShape

Sets height of the shape

AnchoredShape

this

▸ setId(id): AnchoredShape

Allows the user to associate any identifier

AnchoredShape

this

Shape.setId

▸ setIsPointingUp(isPointingUp): AnchoredShape

Sets whether the shape is always pointing up. Particularly useful for text.

AnchoredShape

this

▸ setLayoutStyle(layoutStyle, merge?): AnchoredShape

Specify desired layout style

AnchoredShape

▸ setLineStyle(lineStyle, merge?): AnchoredShape

Sets line style

AnchoredShape

this

Shape.setLineStyle

▸ setLocalTransform(localTransform, force?): AnchoredShape

Sets local transformation to be used to transform from local to parent coordinate

AnchoredShape

this

Shape.setLocalTransform

▸ setMarginsStyle(margins, merge?): AnchoredShape

Sets margins style

AnchoredShape

this

Shape.setMarginsStyle

▸ setMaxSize(maxSize): AnchoredShape

sets the maximum device space rendering dimension

AnchoredShape

▸ setMinSize(minSize): AnchoredShape

sets the minimum device space rendering dimension only works when setUseMinMaxSize is enabled.

AnchoredShape

this

▸ setName(name): AnchoredShape

Sets name of the node

AnchoredShape

this

Shape.setName

▸ setNotification(notify, force?): AnchoredShape

set notification state

AnchoredShape

this

Shape.setNotification

▸ setOpacity(opacity, blendMode?): AnchoredShape

Sets node opacity

AnchoredShape

this

Shape.setOpacity

▸ setPreserveAspectRatio(preserveAspectRatio): AnchoredShape

Sets whether aspect ratio is preserved

AnchoredShape

this

▸ setPreserveReadingOrientation(preserveReadingOrientation): AnchoredShape

Sets whether the shape is always in a readable orientation. Particularly useful for text. Prevents mirror effects

AnchoredShape

this

▸ setPreserveRightAngle(preserveRightAngle): AnchoredShape

Sets whether right angles are preserved

AnchoredShape

this

▸ setProperties(properties?): AnchoredShape

Sets all the properties pertaining to this object

AnchoredShape

Shape.setProperties

▸ setProperty(name, value): AnchoredShape

Sets dynamic property by name

AnchoredShape

this

Shape.setProperty

▸ setRenderingFilter(filter): AnchoredShape

Sets filter to be applied before rendering and picking

AnchoredShape

this

Shape.setRenderingFilter

▸ setResponsiveStyle(style): AnchoredShape

Sets responsive style.

AnchoredShape

this

Shape.setResponsiveStyle

▸ setRotationAngle(rotationAngle): AnchoredShape

Set rotation angle

AnchoredShape

this

▸ setScaleScrollStrategy(strategy?): AnchoredShape

Sets scale scroll strategy

AnchoredShape

this

Shape.setScaleScrollStrategy

▸ setSelectable(selectable): AnchoredShape

Allows to select node. If node is not selectable then child node is not selectable.

AnchoredShape

this

Shape.setSelectable

▸ setSilent(bool): AnchoredShape

Set silent mode

AnchoredShape

this

Shape.setSilent

▸ setSize(width, height?): AnchoredShape

Sets size of the shape, will accept a width and height number or a Dimension object.

AnchoredShape

this

▸ setSizeIsInDeviceSpace(sizeIsInDeviceSpace): AnchoredShape

Sets whether the shape size is set in device space.

AnchoredShape

this

▸ setTag(tag): AnchoredShape

Allows the user to associate any arbitrary object with the node.

AnchoredShape

this

Shape.setTag

▸ setUseMinMaxSize(useMinMaxSize): AnchoredShape

Sets whether to use the min max device space sizes

AnchoredShape

this

▸ setVisible(value): AnchoredShape

Sets visibility of the node. Send event Events.VisibilityChanged

AnchoredShape

this

Shape.setVisible

▸ setWidth(width): AnchoredShape

Sets width of the shape

AnchoredShape

this

▸ setZIndex(value): AnchoredShape

Sets z-index for node (set null for default)

AnchoredShape

this

Shape.setZIndex

▸ shear(shx, shy): AnchoredShape

Shear this node's bounds

AnchoredShape

this

Shape.shear

▸ toString(): string

Returns a string representation of this object (generally the classname)

string

A string representation

Shape.toString

▸ translate(tx, ty): AnchoredShape

Translate bounds

AnchoredShape

this

Shape.translate

▸ unregisterAnimationStyle(root): void

Unregister animation style.

void

Shape.unregisterAnimationStyle

▸ updateSceneTransformation(): AnchoredShape

Update scene transformation

AnchoredShape

this

Shape.updateSceneTransformation

▸ updateState(regions?, changes?): AnchoredShape

Update state. These methods reset node state and update state for children. this method is useful to refresh a scene graph

AnchoredShape

this

Shape.updateState

▸ Protected updateTimeStamp(): AnchoredShape

Update time stamp to indicate that Node or Children has been changed.

AnchoredShape

this

Shape.updateTimeStamp

▸ Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

void