Class: Text

• new Text(options?)

AnchoredShape.constructor

• new Text(text?, ax?, ay?, width?, height?, textStyle?, sizeIsInDeviceSpace?, alignment?)

AnchoredShape.constructor

▸ addCssClass(cssclass): Text

Adds new css class to node

Text

this

AnchoredShape.addCssClass

▸ addInvalidateHandler(handler): Text

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

Text

this

AnchoredShape.addInvalidateHandler

▸ Protected applyOpacity(context): Text

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

Text

this

AnchoredShape.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

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

AnchoredShape.checkCollision

▸ clone(): Text

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

Text

clone

AnchoredShape.clone

▸ connectStyle(style, type, callback): Text

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

Text

this

AnchoredShape.connectStyle

▸ Protected copyConstructor(src, deepCopy?): Text

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

Text

this

AnchoredShape.copyConstructor

▸ disconnectStyle(style, type, callback): Text

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

Text

this

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

AnchoredShape.dispose

▸ enableEventPropagation(enable): Text

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

Text

this

AnchoredShape.enableEventPropagation

▸ execute(delegate): Text

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

Text

The result if any or this

AnchoredShape.execute

▸ execute<T>(delegate): T

T

AnchoredShape.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

AnchoredShape.filter

▸ getAnchor(tr?): Point

Gets the anchor

Point

AnchoredShape.getAnchor

▸ getAnchorType(): AnchorType

Returns the current anchor type.

AnchorType

current anchor type

AnchoredShape.getAnchorType

▸ getAnchorX(): number

Return anchored x position

number

AnchoredShape.getAnchorX

▸ getAnchorY(): number

Return anchored y position

number

AnchoredShape.getAnchorY

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

AnchoredShape.getAnimationStyle

▸ getAspectRatio(): number

Returns aspect ratio of the content of the shape Returns 1

number

AnchoredShape.getAspectRatio

▸ getAutoSize(): boolean

Return auto size mode

boolean

▸ getBounds(): Rect

Return bound in the parent coordinates

Rect

AnchoredShape.getBounds

▸ getClassName(): string

string

AnchoredShape.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

AnchoredShape.getClipStyle

▸ getCornerRadius(): number

return corner radius

number

radius

▸ getCss(): CssStyle

Return CSS style

CssStyle

AnchoredShape.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

AnchoredShape.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

AnchoredShape.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

AnchoredShape.getCssTransform

▸ getDisplayableText(): string

Returns the text string that will be rendered depending on textStyle's wrapping value.

string

the text string that will be rendered

▸ getEllipsisOptions(): EllipsisOptions

EllipsisOptions

ellipsis options

▸ getEllipsisString(): string

Get ellipsis text

string

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

AnchoredShape.getFillStyle

▸ getHeight(): number

Return height of the shape

number

AnchoredShape.getHeight

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

AnchoredShape.getId

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

AnchoredShape.getInvalidateMethod

▸ getIsPointingUp(): boolean

Returns true if the shape is always pointing up

boolean

true if the shape is always pointing up

AnchoredShape.getIsPointingUp

▸ getLayoutStyle(): LayoutStyle<string | number>

Return desired layout style

LayoutStyle<string | number>

AnchoredShape.getLayoutStyle

▸ getLineStyle(): LineStyle

Return line style

LineStyle

lineStyle current line style

AnchoredShape.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

AnchoredShape.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

AnchoredShape.getMarginsStyle

▸ getMaxSize(): Dimension

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

Dimension

max size

AnchoredShape.getMaxSize

▸ getMinSize(): Dimension

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

Dimension

min size

AnchoredShape.getMinSize

▸ getName(): string

Returns the node name

string

The node name

AnchoredShape.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

AnchoredShape.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

AnchoredShape.getOpacityBlendMode

▸ getPadding(): number

return inner padding

Deprecated

since 4.1 use getPaddingStyle instead

number

padding

▸ getPaddingStyle(): SpaceStyle<string | number>

Return padding style

SpaceStyle<string | number>

padding

▸ getParent(): Node

Return parent node

Node

parent node

AnchoredShape.getParent

▸ getPreserveAspectRatio(): boolean

Returns true if aspect ratio is preserved

boolean

true if aspect ratio is preserved

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

AnchoredShape.getPreserveReadingOrientation

▸ getPreserveRightAngle(): boolean

Returns true if right angles are preserved

boolean

true if right angles are preserved

AnchoredShape.getPreserveRightAngle

▸ getProperties(context?): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties

AnchoredShape.getProperties

▸ getProperty(name): any

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

any

AnchoredShape.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AnchoredShape.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

AnchoredShape.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

AnchoredShape.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

AnchoredShape.getRoot

▸ getRotationAngle(): number

Returns rotation angle (in radians)

number

rotationAngle rotation angle at anchor

AnchoredShape.getRotationAngle

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

AnchoredShape.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

AnchoredShape.getSceneTransform

▸ getShowEllipsis(): boolean

Returns ellipsis flag

boolean

ellipsis flag

▸ getSize(): Dimension

Returns the size as a dimension object.

Dimension

size

AnchoredShape.getSize

▸ getSizeIsInDeviceSpace(): boolean

Returns true if the shape size is set in device space

boolean

true if size is defined in device space

AnchoredShape.getSizeIsInDeviceSpace

▸ getSizeMode(): SizeMode

Returns how the size is computed

SizeMode

size mode

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

AnchoredShape.getTag

▸ getText(): string

Get this text's contents as a string.

string

text

▸ getTextStyle(): TextStyle

The style associated with this text.

TextStyle

text style

▸ getTextTransform(): string

Returns text transform type

string

▸ getUseMinMaxSize(): boolean

true if using the min max device space sizes

boolean

true if using the min max device space sizes

AnchoredShape.getUseMinMaxSize

▸ getUserHeight(): number

Returns user defined height (if exists)

number

▸ getUserWidth(): number

Returns user defined width (if exists)

number

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

AnchoredShape.getVisible

▸ getWidth(): number

Return width of the shape

number

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

AnchoredShape.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

AnchoredShape.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

AnchoredShape.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

AnchoredShape.hasEventListener

▸ hitTest(area, radius?): Hits

Hit test in the device coordinate. This method checks if any point is intersects <html>node inside text

Hits

properties

▸ invalidate(bounds?, force?): Text

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

Text

this

AnchoredShape.invalidate

▸ invalidateParent(bounds?, force?): Text

Invalidate bounds

Text

this

AnchoredShape.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AnchoredShape.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

AnchoredShape.isEventPropagationEnabled

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

AnchoredShape.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

AnchoredShape.isSelectable

▸ isSilent(): boolean

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

boolean

AnchoredShape.isSilent

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

Notify listeners of the Node

Text

this

AnchoredShape.notify

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

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.

Text

this

AnchoredShape.off

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

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.

Text

this

AnchoredShape.on

▸ Protected onParentChanged(node): Text

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

Text

this

AnchoredShape.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

AnchoredShape.onVisibilityChanged

▸ Protected postRendering(context): void

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

void

AnchoredShape.postRendering

▸ Protected preRendering(context): void

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

void

AnchoredShape.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

AnchoredShape.registerAnimationStyle

▸ removeCssClass(cssclass): Text

Removes css class from node

Text

this

AnchoredShape.removeCssClass

▸ removeInvalidateHandler(handler): Text

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

Text

this

AnchoredShape.removeInvalidateHandler

▸ render(context): void

Renders node

void

AnchoredShape.render

▸ renderAsync(context, callback): void

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

void

AnchoredShape.renderAsync

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

Rotate bounds around a given coordinate or anchor point

Text

this

AnchoredShape.rotate

▸ scale(xx, yy): Text

Scale node

Text

this

AnchoredShape.scale

▸ setAnchor(p): Text

Sets anchor point to given position

Text

this

AnchoredShape.setAnchor

▸ setAnchor(x, y): Text

Sets anchor point to given position

Text

this

AnchoredShape.setAnchor

▸ setAnchorType(alignment): Text

Sets the anchor type.

Text

this

AnchoredShape.setAnchorType

▸ setAnchorX(ax): Text

Sets x anchor position

Text

this

AnchoredShape.setAnchorX

▸ setAnchorY(ay): Text

Sets y anchor position

Text

this

AnchoredShape.setAnchorY

▸ setAnimationStyle(animationStyle): Text

Sets animation style

Text

AnchoredShape.setAnimationStyle

▸ setAutoSize(autoSize): Text

Automatically fit shape bounds to text size, default is true Set it to false if you have more than one paragraph inside with different alignment

Text

this

▸ setBounds(bounds): Text

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.

Text

this

AnchoredShape.setBounds

▸ setClipStyle(style): Text

Sets a new clipping style

Text

this

AnchoredShape.setClipStyle

▸ setCornerRadius(radius): Text

Set border radius in device coordinates.

Text

this

▸ setCss(style, merge?): Text

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

Text

this

AnchoredShape.setCss

▸ setCssClass(name): Text

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

Text

this

AnchoredShape.setCssClass

▸ setCssTransform(transform): Text

Set CSS transformation

Text

this

AnchoredShape.setCssTransform

▸ setEllipsisOptions(options): Text

Sets text overflow ellipsis options

Text

this

▸ setEllipsisString(ellipsisValue): Text

Sets ellipsis text to string under 15 characters

Text

▸ setFillStyle(fillStyle, merge?): Text

Sets fill style

Text

this

AnchoredShape.setFillStyle

▸ setHeight(height): Text

Set text height. If height set to zero, text will get its height from font.

Text

this

AnchoredShape.setHeight

▸ setId(id): Text

Allows the user to associate any identifier

Text

this

AnchoredShape.setId

▸ setIsPointingUp(isPointingUp): Text

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

Text

this

AnchoredShape.setIsPointingUp

▸ setLayoutStyle(layoutStyle, merge?): Text

Specify desired layout style

Text

AnchoredShape.setLayoutStyle

▸ setLineStyle(lineStyle, merge?): Text

Sets line style

Text

this

AnchoredShape.setLineStyle

▸ setLocalTransform(localTransform, force?): Text

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

Text

this

AnchoredShape.setLocalTransform

▸ setMarginsStyle(margins, merge?): Text

Sets margins style

Text

this

AnchoredShape.setMarginsStyle

▸ setMaxSize(maxSize): Text

sets the maximum device space rendering dimension

Text

AnchoredShape.setMaxSize

▸ setMinSize(minSize): Text

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

Text

this

AnchoredShape.setMinSize

▸ setName(name): Text

Sets name of the node

Text

this

AnchoredShape.setName

▸ setNotification(notify, force?): Text

set notification state

Text

this

AnchoredShape.setNotification

▸ setOpacity(opacity, blendMode?): Text

Sets node opacity

Text

this

AnchoredShape.setOpacity

▸ setPadding(padding): Text

Set inner padding in device coordinates.

Deprecated

since 4.1 use setPaddingStyle instead

Text

this

▸ setPaddingStyle(paddingStyle, merge?): Text

Sets padding style

Text

this

▸ setPreserveAspectRatio(preserveAspectRatio): Text

Sets whether aspect ratio is preserved

Text

this

AnchoredShape.setPreserveAspectRatio

▸ setPreserveReadingOrientation(preserveReadingOrientation): Text

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

Text

this

AnchoredShape.setPreserveReadingOrientation

▸ setPreserveRightAngle(preserveRightAngle): Text

Sets whether right angles are preserved

Text

this