Class: TadPole

• new TadPole(options)

• new TadPole(options?)

Creates tadpole

SymbolShape.constructor

▸ acceptMetaInfo(info): boolean

Check data from source, true if source contains info for symbol

boolean

IExtendedDataSymbol.acceptMetaInfo

▸ addCssClass(cssclass): TadPole

Adds new css class to node

TadPole

this

SymbolShape.addCssClass

▸ addInvalidateHandler(handler): TadPole

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

TadPole

this

SymbolShape.addInvalidateHandler

▸ Protected applyOpacity(context): TadPole

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

TadPole

this

SymbolShape.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

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

SymbolShape.checkCollision

▸ clone(): SymbolShape

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

SymbolShape

clone

SymbolShape.clone

▸ connectStyle(style, type, callback): TadPole

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

TadPole

this

SymbolShape.connectStyle

▸ Protected copyConstructor(src, deepCopy?): TadPole

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

TadPole

this

SymbolShape.copyConstructor

▸ disconnectStyle(style, type, callback): TadPole

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

TadPole

this

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

SymbolShape.dispose

▸ draw(context): TadPole

Draw

TadPole

this

SymbolShape.draw

▸ enableEventPropagation(enable): TadPole

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

TadPole

this

SymbolShape.enableEventPropagation

▸ enumerateNodes(callback, target?): void

Enumerate children nodes

void

SymbolShape.enumerateNodes

▸ execute(delegate): TadPole

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

TadPole

The result if any or this

SymbolShape.execute

▸ execute<T>(delegate): T

T

SymbolShape.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

SymbolShape.filter

▸ getAnchor(tr?): Point

Gets the anchor

Point

SymbolShape.getAnchor

▸ getAnchorType(): AnchorType

Returns the current anchor type.

AnchorType

current anchor type

SymbolShape.getAnchorType

▸ getAnchorX(): number

Return anchored x position

number

SymbolShape.getAnchorX

▸ getAnchorY(): number

Return anchored y position

number

SymbolShape.getAnchorY

▸ getAngle(): number

Return rotation angle in radians

number

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

SymbolShape.getAnimationStyle

▸ getAspectRatio(): number

Returns aspect ratio of the content of the shape Returns 1

number

SymbolShape.getAspectRatio

▸ getBounds(): Rect

Return bound in the parent coordinates

Rect

SymbolShape.getBounds

▸ getClassName(): string

string

SymbolShape.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

SymbolShape.getClipStyle

▸ getCss(): CssStyle

Return CSS style

CssStyle

SymbolShape.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

SymbolShape.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

SymbolShape.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

SymbolShape.getCssTransform

▸ getDefaultAngle(): number

Return default rotation angle to be used if angle or leg angle is not defined or NaN in radians

number

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

SymbolShape.getFillStyle

▸ getHeight(): number

Return height of the shape

number

SymbolShape.getHeight

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

SymbolShape.getId

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

SymbolShape.getInvalidateMethod

▸ getIsPointingUp(): boolean

Returns true if the shape is always pointing up

boolean

true if the shape is always pointing up

SymbolShape.getIsPointingUp

▸ getLayoutStyle(): LayoutStyle<string | number>

Return desired layout style

LayoutStyle<string | number>

SymbolShape.getLayoutStyle

▸ getLegs(): Leg[]

Get Legs

Leg[]

legs

▸ getLineStyle(): LineStyle

Return line style

LineStyle

lineStyle current line style

SymbolShape.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

SymbolShape.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

SymbolShape.getMarginsStyle

▸ getMaxSize(): Dimension

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

Dimension

max size

SymbolShape.getMaxSize

▸ getMetaInfo(): MetaInfoOut

Returns data from symbol

MetaInfoOut

IExtendedDataSymbol.getMetaInfo

▸ getMinSize(): Dimension

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

Dimension

min size

SymbolShape.getMinSize

▸ getName(): string

Returns the node name

string

The node name

SymbolShape.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

SymbolShape.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

SymbolShape.getOpacityBlendMode

▸ getPainter(): EventDispatcher & IPainter | PainterFunction

Get painter function

EventDispatcher & IPainter | PainterFunction

SymbolShape.getPainter

▸ getParent(): Node

Return parent node

Node

parent node

SymbolShape.getParent

▸ getPreserveAspectRatio(): boolean

Returns true if aspect ratio is preserved

boolean

true if aspect ratio is preserved

SymbolShape.getPreserveAspectRatio

▸ getPreserveReadingOrientation(): boolean

Returns true if the shape is always in a readable orientation

boolean

true if the shape is always in a readable orientation

SymbolShape.getPreserveReadingOrientation

▸ getPreserveRightAngle(): boolean

Returns true if right angles are preserved

boolean

true if right angles are preserved

SymbolShape.getPreserveRightAngle

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties

SymbolShape.getProperties

▸ getProperty(name): any

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

any

SymbolShape.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

SymbolShape.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

SymbolShape.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

SymbolShape.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

SymbolShape.getRoot

▸ getRotationAngle(): number

Returns rotation angle (in radians)

number

rotationAngle rotation angle at anchor

SymbolShape.getRotationAngle

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

SymbolShape.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

SymbolShape.getSceneTransform

▸ getSize(): Dimension

Returns the size as a dimension object.

Dimension

size

SymbolShape.getSize

▸ getSizeIsInDeviceSpace(): boolean

Returns true if the shape size is set in device space

boolean

true if size is defined in device space

SymbolShape.getSizeIsInDeviceSpace

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

SymbolShape.getTag

▸ getUseMinMaxSize(): boolean

true if using the min max device space sizes

boolean

true if using the min max device space sizes

SymbolShape.getUseMinMaxSize

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

SymbolShape.getVisible

▸ getWidth(): number

Return width of the shape

number

SymbolShape.getWidth

▸ getWorldTransform(): Transformation

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

Transformation

transform the world transform.

SymbolShape.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

SymbolShape.getZIndex

▸ hasCache(): boolean

Get cache flag

boolean

SymbolShape.hasCache

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

SymbolShape.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

SymbolShape.hasEventListener

▸ invalidate(bounds?, force?): TadPole

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

TadPole

this

SymbolShape.invalidate

▸ invalidateParent(bounds?, force?): TadPole

Invalidate bounds

TadPole

this

SymbolShape.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

SymbolShape.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

SymbolShape.isEventPropagationEnabled

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

SymbolShape.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

SymbolShape.isSelectable

▸ isSilent(): boolean

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

boolean

SymbolShape.isSilent

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

Notify listeners of the Node

TadPole

this

SymbolShape.notify

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

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.

TadPole

this

SymbolShape.off

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

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.

TadPole

this

SymbolShape.on

▸ Protected onParentChanged(node): TadPole

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

TadPole

this

SymbolShape.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

SymbolShape.onVisibilityChanged

▸ Protected postRendering(context): void

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

void

SymbolShape.postRendering

▸ Protected preRendering(context): void

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

void

SymbolShape.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

SymbolShape.registerAnimationStyle

▸ removeCssClass(cssclass): TadPole

Removes css class from node

TadPole

this

SymbolShape.removeCssClass

▸ removeInvalidateHandler(handler): TadPole

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

TadPole

this

SymbolShape.removeInvalidateHandler

▸ render(context): void

Renders node

void

SymbolShape.render

▸ renderAsync(context, callback): void

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

void

SymbolShape.renderAsync

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

Rotate bounds around a given coordinate or anchor point

TadPole

this

SymbolShape.rotate

▸ scale(xx, yy): TadPole

Scale node

TadPole

this

SymbolShape.scale

▸ setAnchor(p): TadPole

Sets anchor point to given position

TadPole

this

SymbolShape.setAnchor

▸ setAnchor(x, y): TadPole

Sets anchor point to given position

TadPole

this

SymbolShape.setAnchor

▸ setAnchorType(alignment): TadPole

Sets the anchor type.

TadPole

this

SymbolShape.setAnchorType

▸ setAnchorX(ax): TadPole

Sets x anchor position

TadPole

this

SymbolShape.setAnchorX

▸ setAnchorY(ay): TadPole

Sets y anchor position

TadPole

this

SymbolShape.setAnchorY

▸ setAngle(angle): TadPole

Specify rotations angle in radians

TadPole

this

▸ setAnimationStyle(animationStyle): TadPole

Sets animation style

TadPole

SymbolShape.setAnimationStyle

▸ setBounds(bounds): TadPole

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.

TadPole

this

SymbolShape.setBounds

▸ setCache(useCache): TadPole

Set cache flag

TadPole

this

SymbolShape.setCache

▸ setClipStyle(style): TadPole

Sets a new clipping style

TadPole

this

SymbolShape.setClipStyle

▸ setCss(style, merge?): TadPole

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

TadPole

this

SymbolShape.setCss

▸ setCssClass(name): TadPole

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

TadPole

this

SymbolShape.setCssClass

▸ setCssTransform(transform): TadPole

Set CSS transformation

TadPole

this

SymbolShape.setCssTransform

▸ setDefaultAngle(angle): TadPole

Specify default rotation angle to be used if angle or leg angle is not defined or NaN

TadPole

this

▸ setFillStyle(fillStyle, merge?): TadPole

Sets fill style

TadPole

this

SymbolShape.setFillStyle

▸ setHeight(height): TadPole

Sets height of the shape

TadPole

this

SymbolShape.setHeight

▸ setId(id): TadPole

Allows the user to associate any identifier

TadPole

this

SymbolShape.setId

▸ setIsPointingUp(isPointingUp): TadPole

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

TadPole

this

SymbolShape.setIsPointingUp

▸ setLayoutStyle(layoutStyle, merge?): TadPole

Specify desired layout style

TadPole

SymbolShape.setLayoutStyle

▸ setLegs(legs): TadPole

Set Legs

TadPole

this

▸ setLineStyle(lineStyle, merge?): TadPole

Sets line style

TadPole

this

SymbolShape.setLineStyle

▸ setLocalTransform(localTransform, force?): TadPole

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

TadPole

this

SymbolShape.setLocalTransform

▸ setMarginsStyle(margins, merge?): TadPole

Sets margins style

TadPole

this

SymbolShape.setMarginsStyle

▸ setMaxSize(maxSize): TadPole

sets the maximum device space rendering dimension

TadPole

SymbolShape.setMaxSize

▸ setMetaInfo(info): TadPole

Sets meta info

TadPole

this

IExtendedDataSymbol.setMetaInfo

▸ setMinSize(minSize): TadPole

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

TadPole

this

SymbolShape.setMinSize

▸ setName(name): TadPole

Sets name of the node

TadPole

this

SymbolShape.setName

▸ setNotification(notify, force?): TadPole

set notification state

TadPole

this

SymbolShape.setNotification

▸ setOpacity(opacity, blendMode?): TadPole

Sets node opacity

TadPole

this

SymbolShape.setOpacity

▸ setPainter(painter): TadPole

Sets painter function for this symbol.

TadPole

this

SymbolShape.setPainter

▸ setPreserveAspectRatio(preserveAspectRatio): TadPole

Sets whether aspect ratio is preserved

TadPole

this

SymbolShape.setPreserveAspectRatio

▸ setPreserveReadingOrientation(preserveReadingOrientation): TadPole

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

TadPole

this

SymbolShape.setPreserveReadingOrientation

▸ setPreserveRightAngle(preserveRightAngle): TadPole

Sets whether right angles are preserved

TadPole

this

SymbolShape.setPreserveRightAngle

▸ setProperties(properties?): TadPole

Sets all the properties pertaining to this object

TadPole

this

SymbolShape.setProperties

▸ setProperty(name, value): TadPole

Sets dynamic property by name

TadPole

this

SymbolShape.setProperty

▸ setRenderingFilter(filter): TadPole

Sets filter to be applied before rendering and picking

TadPole

this

SymbolShape.setRenderingFilter

▸ setResponsiveStyle(style): TadPole

Sets responsive style.