Class: Text

• new Text(options)

• new Text(options)

AbstractTextElement.constructor

• get attributes(): NamedItemMap

Node attributes

Name

module:geotoolkit/report/dom/Node~Node#attributes

NamedItemMap

AbstractTextElement.attributes

• get childNodes(): NodeList<Node>

The element holding the item.

Name

module:geotoolkit/report/dom/Node~Node#childNodes

NodeList<Node>

AbstractTextElement.childNodes

• get children(): NodeList<Element>

The children property returns a collection of an element's child elements, as an NodeList object.

Name

module:geotoolkit/report/dom/Element~Element#children

NodeList<Element>

AbstractTextElement.children

• get data(): string

Node data

Name

module:geotoolkit/report/dom/Node~Node#data

string

AbstractTextElement.data

• set data(data): void

Node data

Name

module:geotoolkit/report/dom/Node~Node#data

void

AbstractTextElement.data

• get firstChild(): Node

First child node

Name

module:geotoolkit/report/dom/Node~Node#firstChild

Node

AbstractTextElement.firstChild

• get lastChild(): Node

Last child node

Name

module:geotoolkit/report/dom/Node~Node#lastChild

Node

AbstractTextElement.lastChild

• get localName(): string

Node local name

Name

module:geotoolkit/report/dom/Node~Node#localName

string

AbstractTextElement.localName

• get nextSibling(): Node

Next sibling node

Name

module:geotoolkit/report/dom/Node~Node#nextSibling

Node

AbstractTextElement.nextSibling

• get nodeName(): string

Node name

Name

module:geotoolkit/report/dom/Node~Node#nodeName

string

AbstractTextElement.nodeName

• get nodeType(): NodeType

Node type

Name

module:geotoolkit/report/dom/Node~Node#nodeType

NodeType

AbstractTextElement.nodeType

• get nodeValue(): string

Node value

Name

module:geotoolkit/report/dom/Node~Node#nodeValue

string

AbstractTextElement.nodeValue

• set nodeValue(value): void

Node value

Name

module:geotoolkit/report/dom/Node~Node#nodeValue

void

AbstractTextElement.nodeValue

• get ownerDocument(): Document

Node owner document

Name

module:geotoolkit/report/dom/Node~Node#ownerDocument

Document

AbstractTextElement.ownerDocument

• get parentNode(): Node

Parent node

Name

module:geotoolkit/report/dom/Node~Node#parentNode

Node

AbstractTextElement.parentNode

• get previousSibling(): Node

Previous sibling node

Name

module:geotoolkit/report/dom/Node~Node#previousSibling

Node

AbstractTextElement.previousSibling

• get rootNode(): Node

Return root node

Deprecated

since 2022 (3.4) use Node#getRootNode instead

Name

module:geotoolkit/report/dom/Node~Node#rootNode

Node

AbstractTextElement.rootNode

• get tagName(): string

Node tag name

Name

module:geotoolkit/report/dom/Node~Node#tagName

string

AbstractTextElement.tagName

▸ appendChild(newChild): Text

Add child to the node

Text

AbstractTextElement.appendChild

▸ clearAttributes(): Text

Clear attributes

Text

AbstractTextElement.clearAttributes

▸ clearNodes(): Text

Remove all child nodes from this node

Text

this

AbstractTextElement.clearNodes

▸ 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

AbstractTextElement.connectStyle

▸ disconnectStyle(style, type, callback): Text

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

Text

this

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

AbstractTextElement.dispose

▸ enumerateNodes(callback, target?): void

Enumerate children nodes

void

AbstractTextElement.enumerateNodes

▸ Protected flush(serializationContext?): Text

Flush all changes before saving

Text

AbstractTextElement.flush

▸ getAlignment(): AnchorType

Return text alignment type

AnchorType

▸ getAttribute(name): string

Return attribute value

string

AbstractTextElement.getAttribute

▸ getBackgroundStyle(): FillStyle

Return background style

FillStyle

background current background style

AbstractTextElement.getBackgroundStyle

▸ getBorderLineStyle(): LineStyle

Return border line style

LineStyle

AbstractTextElement.getBorderLineStyle

▸ getClassName(): string

string

AbstractTextElement.getClassName

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

AbstractTextElement.getCssClass

▸ getElementRegistry(): IElementsRegistry

Returns elements Registry

IElementsRegistry

AbstractTextElement.getElementRegistry

▸ getElementTransform(): { name: string ; parameters: string[] }[]

Return array of transformation instructions

{ name: string ; parameters: string[] }[]

array of transformations

AbstractTextElement.getElementTransform

▸ getFlip(): boolean

Return element content flip flag

boolean

element layout orientation

AbstractTextElement.getFlip

▸ getGuid(): string

Returns element GUID

string

AbstractTextElement.getGuid

▸ getId(): string

Returns element id

string

AbstractTextElement.getId

▸ getInnerCssStyle(): string

Return collected inner css style

string

inner css style

AbstractTextElement.getInnerCssStyle

▸ getLayoutStyle(): LayoutStyle<string | number>

Return layout style

LayoutStyle<string | number>

layout style

AbstractTextElement.getLayoutStyle

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

margins style

AbstractTextElement.getMarginsStyle

▸ getNodeIndex(): number

Return node index

number

AbstractTextElement.getNodeIndex

▸ getNodeValue(): string

Returns node value

string

AbstractTextElement.getNodeValue

▸ getOrientation(): Orientation

Return element layout orientation

Orientation

element layout orientation

AbstractTextElement.getOrientation

▸ getPaddingStyle(): SpaceStyle<string | number>

Return padding style

SpaceStyle<string | number>

padding style

AbstractTextElement.getPaddingStyle

▸ getPageBreak(): PageBreak

Returns element page break

PageBreak

page break

AbstractTextElement.getPageBreak

▸ getParent(): Node

Returns parent node

Node

parent

AbstractTextElement.getParent

▸ getProperties(): OptionsOut

Gets element properties

OptionsOut

props

AbstractTextElement.getProperties

▸ getRootNode(): Node

Return root node

Node

node

AbstractTextElement.getRootNode

▸ getTagName(): string

Returns node tag name

string

AbstractTextElement.getTagName

▸ getText(): string

Return text value

string

text value

▸ getTextStyle(): TextStyle

Return text style

TextStyle

text style

AbstractTextElement.getTextStyle

▸ getTimeStamp(): number

Gets time stamp

number

timeStamp

AbstractTextElement.getTimeStamp

▸ getTransformOrigin(): string

Return transform origin

string

AbstractTextElement.getTransformOrigin

▸ getVisible(): boolean

Get element visible state

boolean

AbstractTextElement.getVisible

▸ hasAttribute(name): boolean

Check if attribute exists

boolean

AbstractTextElement.hasAttribute

▸ hasChildNodes(): boolean

Return true if node has children

boolean

AbstractTextElement.hasChildNodes

▸ hasEventListener(type, callback?): boolean

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

boolean

AbstractTextElement.hasEventListener

▸ indexOfNode(node): number

Returns index of node.

number

AbstractTextElement.indexOfNode

▸ insertAfter(newChild, refChild): Node

Insert child

Node

AbstractTextElement.insertAfter

▸ insertBefore(newChild, refChild): Node

Insert child

Node

AbstractTextElement.insertBefore

▸ Protected invalidate(): Text

Text

this

AbstractTextElement.invalidate

▸ Protected invalidateDocument(eventArgs): Text

Invalidate root document

Text

this

AbstractTextElement.invalidateDocument

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractTextElement.isDisposed

▸ isSilent(): boolean

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

boolean

AbstractTextElement.isSilent

▸ lock(): Text

Lock node

Text

AbstractTextElement.lock

▸ normalize(): Text

Puts the specified node and all of its subtree into a "normalized" form. In a normalized sub-tree, no text nodes in the sub-tree are empty and there are no adjacent text nodes.

Text

this

AbstractTextElement.normalize

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

Notify listeners

Text

this

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

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

AbstractTextElement.on

▸ Protected onParentChanged(): Text

Text

this

AbstractTextElement.onParentChanged

▸ Protected onResetCssProperties(silent): Text

Clean up cached properties

Text

this

AbstractTextElement.onResetCssProperties

▸ removeAttribute(name): Text

Remove attribute

Text

AbstractTextElement.removeAttribute

▸ removeChild(child): Node

Remove child from node

Node

AbstractTextElement.removeChild

▸ replaceChild(newChild, oldChild): Text

Replace child

Text

AbstractTextElement.replaceChild

▸ Protected resetElementStyle(): Text

Reset own styles

Text

AbstractTextElement.resetElementStyle

▸ save(recursive?, serializationContext?): string

Serialize element to xml

string

AbstractTextElement.save

▸ setAlignment(alignment): Text

Sets the text alignment type.

Text

this

▸ setAttribute(name, value): Text

Set attribute value

Text

AbstractTextElement.setAttribute

▸ setAttributeNode(newAttr): Text

Adds a new Attribute node to the specified element.

Text

this

AbstractTextElement.setAttributeNode

▸ setBackgroundStyle(backgroundStyle, merge?): Text

Set background style

Text

this

AbstractTextElement.setBackgroundStyle

▸ setBorderLineStyle(borderStyle, merge?): Text

Sets border line style Returns this

Text

this

AbstractTextElement.setBorderLineStyle

▸ setCssClass(cssClass): Text

Set css class

Text

AbstractTextElement.setCssClass

▸ Protected setElementRegistry(registry): Text

Set shadow element registry

Text

AbstractTextElement.setElementRegistry

▸ setElementTransform(transformOrigin, transformation?): void

Set element transform

void

AbstractTextElement.setElementTransform

▸ setFlip(flip): Text

Set element content flip orientation

Text

AbstractTextElement.setFlip

▸ setGuid(guid): Text

Set node GUID

Text

AbstractTextElement.setGuid

▸ setLayoutStyle(layout?, merge?, silent?): Text

Sets layout style

Text

AbstractTextElement.setLayoutStyle

▸ setMarginsStyle(margins?, merge?): Text

Sets margins style

Text

AbstractTextElement.setMarginsStyle

▸ setNodeValue(nodeValue): Text

Set node value

Text

AbstractTextElement.setNodeValue

▸ setOrientation(orientation): Text

Set element layout orientation

Text

AbstractTextElement.setOrientation

▸ setPaddingStyle(padding?, merge?): Text

Sets padding style

Text

AbstractTextElement.setPaddingStyle

▸ setPageBreak(pageBreak): Text

Set element page break

Text

this

AbstractTextElement.setPageBreak

▸ setProperties(props): Text

Sets the element properties

Text

this

AbstractTextElement.setProperties

▸ setSilent(bool): Text

Set silent mode

Text

this

AbstractTextElement.setSilent

▸ setText(text): Text

Set text value

Text

this

AbstractTextElement.setText

▸ setTextStyle(textStyle, merge?): Text

Sets text style

Text

AbstractTextElement.setTextStyle

▸ setVisible(visible): Text

Set element visible state

Text

AbstractTextElement.setVisible

▸ setXmlContent(xmlValue): Promise<NodeList<Node>>

Set XML content

Promise<NodeList<Node>>

promise

AbstractTextElement.setXmlContent

▸ unlock(): Text

Unlock node

Text

AbstractTextElement.unlock

▸ updateTimeStamp(): Text

Update time stamp to indicate that style has been changed.

Text

this

AbstractTextElement.updateTimeStamp

▸ Static findParentNode<T>(node, classType): InstanceType<T>

Find root of the node with specified type

InstanceType<T>

AbstractTextElement.findParentNode

▸ Static findParentNode(node, classType): Node

Find root of the node with specified type

Node

AbstractTextElement.findParentNode

▸ Static getClassName(): string

string

AbstractTextElement.getClassName