Class: TextElement

• new TextElement(options, ax, ay, width, height, textStyle, sizeIsInDeviceSpace, alignment)

• new TextElement(options?, ax?, ay?, width?, height?, textStyle?, sizeIsInDeviceSpace?, alignment?)

Text.constructor

▸ addCssClass(cssclass): TextElement

Adds new css class to node

TextElement

this

Text.addCssClass

▸ addInvalidateHandler(handler): TextElement

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

TextElement

this

Text.addInvalidateHandler

▸ Protected applyOpacity(context): TextElement

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

TextElement

this

Text.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

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

Text.checkCollision

▸ clone(): TextElement

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

TextElement

clone

Text.clone

▸ connectStyle(style, type, callback): TextElement

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

TextElement

this

Text.connectStyle

▸ Protected copyConstructor(src, deepCopy?): TextElement

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

TextElement

this

Text.copyConstructor

▸ disconnectStyle(style, type, callback): TextElement

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

TextElement

this

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

Text.dispose

▸ dropCache(clearCache?): TextElement

Drop cache

TextElement

this

▸ enableEventPropagation(enable): TextElement

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

TextElement

this

Text.enableEventPropagation

▸ execute(delegate): TextElement

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

TextElement

The result if any or this

Text.execute

▸ execute<T>(delegate): T

T

Text.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

Text.filter

▸ getAltText(): string

Return alt text

string

▸ getAnchor(tr?): Point

Gets the anchor

Point

Text.getAnchor

▸ getAnchorPoint(context): object

Update geometry

object

anchor point

▸ getAnchorType(): AnchorType

Returns the current anchor type.

AnchorType

current anchor type

Text.getAnchorType

▸ getAnchorX(): number

Return anchored x position

number

Text.getAnchorX

▸ getAnchorY(): number

Return anchored y position

number

Text.getAnchorY

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

Text.getAnimationStyle

▸ getAspectRatio(): number

Returns aspect ratio of the content of the shape Returns 1

number

Text.getAspectRatio

▸ getAutoSize(): boolean

Return auto size mode

boolean

Text.getAutoSize

▸ getBounds(): Rect

Return bound in the parent coordinates

Rect

Text.getBounds

▸ getClassName(): string

string

Text.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

Text.getClipStyle

▸ getCornerRadius(): number

return corner radius

number

radius

Text.getCornerRadius

▸ getCss(): CssStyle

Return CSS style

CssStyle

Text.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

Text.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

Text.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

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

Text.getDisplayableText

▸ getDomElement(): AbstractTextElement

Returns DOM element

AbstractTextElement

return DOM element

IElement.getDomElement

▸ getElementStyle(elementStyle?): any

Returns element style

any

return element style

IElement.getElementStyle

▸ getEllipsisOptions(): EllipsisOptions

EllipsisOptions

ellipsis options

Text.getEllipsisOptions

▸ getEllipsisString(): string

Get ellipsis text

string

Text.getEllipsisString

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

Text.getFillStyle

▸ getHeight(): number

Return height of the shape

number

Text.getHeight

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

Text.getId

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

Text.getInvalidateMethod

▸ getIsPointingUp(): boolean

Returns true if the shape is always pointing up

boolean

true if the shape is always pointing up

Text.getIsPointingUp

▸ getLayoutStyle(): LayoutStyle<string | number>

Return desired layout style

LayoutStyle<string | number>

Text.getLayoutStyle

▸ getLineStyle(): LineStyle

Return line style

LineStyle

lineStyle current line style

Text.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

Text.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

Text.getMarginsStyle

▸ getMaxSize(): Dimension

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

Dimension

max size

Text.getMaxSize

▸ getMinSize(): Dimension

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

Dimension

min size

Text.getMinSize

▸ getName(): string

Returns the node name

string

The node name

Text.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

Text.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

Text.getOpacityBlendMode

▸ getPadding(): number

return inner padding

Deprecated

since 4.1 use getPaddingStyle instead

number

padding

Text.getPadding

▸ getPaddingStyle(): SpaceStyle<string | number>

Return padding style

SpaceStyle<string | number>

padding

Text.getPaddingStyle

▸ getParent(): ElementContent

Return parent node

ElementContent

parent node

Text.getParent

▸ Protected getPreferredElementBounds(limits, cssLayout): Rect

Calculate layout bounds

Rect

preferred bounds

▸ getPreserveAspectRatio(): boolean

Returns true if aspect ratio is preserved

boolean

true if aspect ratio is preserved

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

Text.getPreserveReadingOrientation

▸ getPreserveRightAngle(): boolean

Returns true if right angles are preserved

boolean

true if right angles are preserved

Text.getPreserveRightAngle

▸ getProperties(context?): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties

Text.getProperties

▸ getProperty(name): any

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

any

Text.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

Text.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

Text.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

Text.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

Text.getRoot

▸ getRotationAngle(): number

Returns rotation angle (in radians)

number

rotationAngle rotation angle at anchor

Text.getRotationAngle

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

Text.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

Text.getSceneTransform

▸ getShowEllipsis(): boolean

Returns ellipsis flag

boolean

ellipsis flag

Text.getShowEllipsis

▸ getSize(): Dimension

Returns the size as a dimension object.

Dimension

size

Text.getSize

▸ getSizeIsInDeviceSpace(): boolean

Returns true if the shape size is set in device space

boolean

true if size is defined in device space

Text.getSizeIsInDeviceSpace

▸ getSizeMode(): SizeMode

Returns how the size is computed

SizeMode

size mode

Text.getSizeMode

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

Text.getTag

▸ getText(): string

Get this text's contents as a string.

string

text

Text.getText

▸ getTextStyle(): TextStyle

The style associated with this text.

TextStyle

text style

Text.getTextStyle

▸ getTextTransform(): string

Returns text transform type

string

Text.getTextTransform

▸ getUseMinMaxSize(): boolean

true if using the min max device space sizes

boolean

true if using the min max device space sizes

Text.getUseMinMaxSize

▸ getUserHeight(): number

Returns user defined height (if exists)

number

Text.getUserHeight

▸ getUserWidth(): number

Returns user defined width (if exists)

number

Text.getUserWidth

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

Text.getVisible

▸ getWidth(): number

Return width of the shape

number

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

Text.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

Text.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

Text.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

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

Text.hitTest

▸ invalidate(bounds?, force?): TextElement

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

TextElement

this

Text.invalidate

▸ invalidateParent(bounds?, force?): TextElement

Invalidate bounds

TextElement

this

Text.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Text.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

Text.isEventPropagationEnabled

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

Text.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

Text.isSelectable

▸ isSilent(): boolean

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

boolean

Text.isSilent

▸ isSimple(): boolean

Returns true if text element is simple

boolean

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

Notify listeners of the Node

TextElement

this

Text.notify

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

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.

TextElement

this

Text.off

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

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.

TextElement

this

Text.on

▸ Protected onDomElementChanged(eventType, sender, eventArgs): TextElement

Update element from domElement

TextElement

▸ Protected onParentChanged(node): TextElement

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

TextElement

this

Text.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

Text.onVisibilityChanged

▸ Protected postRendering(context): void

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

void

Text.postRendering

▸ Protected preRendering(context): void

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

void

Text.preRendering

▸ rebuildDomLayout(): TextElement

Rebuild DOM layout

TextElement

IElement.rebuildDomLayout

▸ registerAnimationStyle(root): void

Register animation style.

void

Text.registerAnimationStyle

▸ removeCssClass(cssclass): TextElement

Removes css class from node

TextElement

this

Text.removeCssClass

▸ removeInvalidateHandler(handler): TextElement

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

TextElement

this

Text.removeInvalidateHandler

▸ render(context): void

Renders node

void

Text.render

▸ renderAsync(context, callback): void

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

void

Text.renderAsync

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

Rotate bounds around a given coordinate or anchor point

TextElement

this

Text.rotate

▸ scale(xx, yy): TextElement

Scale node

TextElement

this

Text.scale

▸ setAltText(altText): TextElement

Set alt text

TextElement

▸ setAnchor(p): TextElement

Sets anchor point to given position

TextElement

this

Text.setAnchor

▸ setAnchor(x, y): TextElement

Sets anchor point to given position

TextElement

this

Text.setAnchor

▸ setAnchorType(alignment): TextElement

Sets the anchor type.

TextElement

this

Text.setAnchorType

▸ setAnchorX(ax): TextElement

Sets x anchor position

TextElement

this

Text.setAnchorX

▸ setAnchorY(ay): TextElement

Sets y anchor position

TextElement

this

Text.setAnchorY

▸ setAnimationStyle(animationStyle): TextElement

Sets animation style

TextElement

Text.setAnimationStyle

▸ setAutoSize(autoSize): TextElement

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

TextElement

this

Text.setAutoSize

▸ setBounds(bounds): TextElement

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.

TextElement

this

Text.setBounds

▸ setClipStyle(style): TextElement

Sets a new clipping style

TextElement

this

Text.setClipStyle

▸ setCornerRadius(radius): TextElement

Set border radius in device coordinates.

TextElement

this

Text.setCornerRadius

▸ setCss(style, merge?): TextElement

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

TextElement

this

Text.setCss

▸ setCssClass(name): TextElement

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

TextElement

this

Text.setCssClass

▸ setCssTransform(transform): TextElement

Set CSS transformation

TextElement

this

Text.setCssTransform

▸ setDomElement(domElement): TextElement

Set DOM element

TextElement

this

IElement.setDomElement

▸ setElementStyle(elementStyle, styleValue?): TextElement

Set element style

TextElement

this

IElement.setElementStyle

▸ setEllipsisOptions(options): TextElement

Sets text overflow ellipsis options

TextElement

this

Text.setEllipsisOptions

▸ setEllipsisString(ellipsisValue): TextElement

Sets ellipsis text to string under 15 characters

TextElement

Text.setEllipsisString

▸ setFillStyle(fillStyle, merge?): TextElement

Sets fill style

TextElement

this

Text.setFillStyle

▸ setHeight(height): TextElement

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

TextElement

this

Text.setHeight

▸ setId(id): TextElement

Allows the user to associate any identifier

TextElement

this

Text.setId

▸ setIsPointingUp(isPointingUp): TextElement

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

TextElement

this

Text.setIsPointingUp

▸ setLayoutStyle(layoutStyle, merge?): TextElement

Specify desired layout style

TextElement

Text.setLayoutStyle

▸ setLineStyle(lineStyle, merge?): TextElement

Sets line style