Class: AbstractElement

• new AbstractElement(options)

• new AbstractElement(options)

Element.constructor

• get attributes(): NamedItemMap

Node attributes

Name

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

NamedItemMap

Element.attributes

• get childNodes(): NodeList<Node>

The element holding the item.

Name

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

NodeList<Node>

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

Element.children

• get data(): string

Node data

Name

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

string

Element.data

• set data(data): void

Node data

Name

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

void

Element.data

• get firstChild(): Node

First child node

Name

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

Node

Element.firstChild

• get lastChild(): Node

Last child node

Name

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

Node

Element.lastChild

• get localName(): string

Node local name

Name

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

string

Element.localName

• get nextSibling(): Node

Next sibling node

Name

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

Node

Element.nextSibling

• get nodeName(): string

Node name

Name

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

string

Element.nodeName

• get nodeType(): NodeType

Node type

Name

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

NodeType

Element.nodeType

• get nodeValue(): string

Node value

Name

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

string

Element.nodeValue

• set nodeValue(value): void

Node value

Name

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

void

Element.nodeValue

• get ownerDocument(): Document

Node owner document

Name

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

Document

Element.ownerDocument

• get parentNode(): Node

Parent node

Name

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

Node

Element.parentNode

• get previousSibling(): Node

Previous sibling node

Name

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

Node

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

Element.rootNode

• get tagName(): string

Node tag name

Name

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

string

Element.tagName

▸ appendChild(newChild): AbstractElement

Add child to the node

AbstractElement

Element.appendChild

▸ clearAttributes(): AbstractElement

Clear attributes

AbstractElement

Element.clearAttributes

▸ clearNodes(): AbstractElement

Remove all child nodes from this node

AbstractElement

this

Element.clearNodes

▸ connectStyle(style, type, callback): AbstractElement

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

AbstractElement

this

Element.connectStyle

▸ disconnectStyle(style, type, callback): AbstractElement

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

AbstractElement

this

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

Element.dispose

▸ enumerateNodes(callback, target?): void

Enumerate children nodes

void

Element.enumerateNodes

▸ Protected flush(serializationContext?): AbstractElement

Flush all changes before saving

AbstractElement

Element.flush

▸ getAttribute(name): string

Return attribute value

string

Element.getAttribute

▸ getBackgroundStyle(): FillStyle

Return background style

FillStyle

background current background style

▸ getBorderLineStyle(): LineStyle

Return border line style

LineStyle

▸ getClassName(): string

string

Element.getClassName

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

Element.getCssClass

▸ getElementRegistry(): IElementsRegistry

Returns elements Registry

IElementsRegistry

Element.getElementRegistry

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

Return array of transformation instructions

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

array of transformations

▸ getFlip(): boolean

Return element content flip flag

boolean

element layout orientation

▸ getGuid(): string

Returns element GUID

string

Element.getGuid

▸ getId(): string

Returns element id

string

Element.getId

▸ getInnerCssStyle(): string

Return collected inner css style

string

inner css style

Element.getInnerCssStyle

▸ getLayoutStyle(): LayoutStyle<string | number>

Return layout style

LayoutStyle<string | number>

layout style

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

margins style

▸ getNodeIndex(): number

Return node index

number

Element.getNodeIndex

▸ getNodeValue(): string

Returns node value

string

Element.getNodeValue

▸ getOrientation(): Orientation

Return element layout orientation

Orientation

element layout orientation

▸ getPaddingStyle(): SpaceStyle<string | number>

Return padding style

SpaceStyle<string | number>

padding style

▸ getPageBreak(): PageBreak

Returns element page break

PageBreak

page break

▸ getParent(): Node

Returns parent node

Node

parent

Element.getParent

▸ getProperties(): Options

Gets the element properties

Options

Element.getProperties

▸ getRootNode(): Node

Return root node

Node

node

Element.getRootNode

▸ getTagName(): string

Returns node tag name

string

Element.getTagName

▸ getTimeStamp(): number

Gets time stamp

number

timeStamp

Element.getTimeStamp

▸ getTransformOrigin(): string

Return transform origin

string

▸ getVisible(): boolean

Get element visible state

boolean

▸ hasAttribute(name): boolean

Check if attribute exists

boolean

Element.hasAttribute

▸ hasChildNodes(): boolean

Return true if node has children

boolean

Element.hasChildNodes

▸ hasEventListener(type, callback?): boolean

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

boolean

Element.hasEventListener

▸ indexOfNode(node): number

Returns index of node.

number

Element.indexOfNode

▸ insertAfter(newChild, refChild): Node

Insert child

Node

Element.insertAfter

▸ insertBefore(newChild, refChild): Node

Insert child

Node

Element.insertBefore

▸ Protected invalidate(): AbstractElement

AbstractElement

this

Element.invalidate

▸ Protected invalidateDocument(eventArgs): AbstractElement

Invalidate root document

AbstractElement

this

Element.invalidateDocument

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Element.isDisposed

▸ isSilent(): boolean

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

boolean

Element.isSilent

▸ lock(): AbstractElement

Lock node

AbstractElement

Element.lock

▸ normalize(): AbstractElement

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.

AbstractElement

this

Element.normalize

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

Notify listeners

AbstractElement

this

Element.notify

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

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.

AbstractElement

this

Element.off

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

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.

AbstractElement

this

Element.on

▸ Protected onParentChanged(): AbstractElement

AbstractElement

this

Element.onParentChanged

▸ Protected onResetCssProperties(silent?): AbstractElement

Clean up cached properties

AbstractElement

this

Element.onResetCssProperties

▸ removeAttribute(name): AbstractElement

Remove attribute

AbstractElement

Element.removeAttribute

▸ removeChild(child): Node

Remove child from node

Node

Element.removeChild

▸ replaceChild(newChild, oldChild): AbstractElement

Replace child

AbstractElement

Element.replaceChild

▸ Protected resetElementStyle(): AbstractElement

Reset own styles

AbstractElement

Element.resetElementStyle

▸ save(recursive?, serializationContext?): string

Serialize element to xml

string

Element.save

▸ setAttribute(name, value): AbstractElement

Set attribute value

AbstractElement

Element.setAttribute

▸ setAttributeNode(newAttr): AbstractElement

Adds a new Attribute node to the specified element.

AbstractElement

this

Element.setAttributeNode

▸ setBackgroundStyle(backgroundStyle, merge?): AbstractElement

Set background style

AbstractElement

this

▸ setBorderLineStyle(borderStyle, merge?): AbstractElement

Sets border line style Returns this

AbstractElement

this

▸ setCssClass(cssClass): AbstractElement

Set css class

AbstractElement

Element.setCssClass

▸ Protected setElementRegistry(registry): AbstractElement

Set shadow element registry

AbstractElement

Element.setElementRegistry

▸ setElementTransform(transformOrigin, transformation?): void

Set element transform

void

▸ setFlip(flip): AbstractElement

Set element content flip orientation

AbstractElement

▸ setGuid(guid): AbstractElement

Set node GUID

AbstractElement

Element.setGuid

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

Sets layout style

AbstractElement

▸ setMarginsStyle(margins?, merge?): AbstractElement

Sets margins style

AbstractElement

▸ setNodeValue(nodeValue): AbstractElement

Set node value

AbstractElement

Element.setNodeValue

▸ setOrientation(orientation): AbstractElement

Set element layout orientation

AbstractElement

▸ setPaddingStyle(padding?, merge?): AbstractElement

Sets padding style

AbstractElement

▸ setPageBreak(pageBreak): AbstractElement

Set element page break

AbstractElement

this

▸ setProperties(props): AbstractElement

Sets the element properties

AbstractElement

this

Element.setProperties

▸ setSilent(bool): AbstractElement

Set silent mode

AbstractElement

this

Element.setSilent

▸ setText(text): AbstractElement

Set text value

AbstractElement

this

Element.setText

▸ setVisible(visible): AbstractElement

Set element visible state

AbstractElement

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

Set XML content

Promise<NodeList<Node>>

promise

Element.setXmlContent

▸ unlock(): AbstractElement

Unlock node

AbstractElement

Element.unlock

▸ updateTimeStamp(): AbstractElement

Update time stamp to indicate that style has been changed.

AbstractElement

this

Element.updateTimeStamp

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

Find root of the node with specified type

InstanceType<T>

Element.findParentNode

▸ Static findParentNode(node, classType): Node

Find root of the node with specified type

Node

Element.findParentNode

▸ Static getClassName(): string

string

Element.getClassName