Class: Document

• new Document(options)

• new Document(options?)

Element.constructor

• get adoptedStyleSheets(): CssStyleSheet[]

Returns clone array of a live collection which contains application specific CssStyleSheets Note: .adoptedStyleSheets can accept standard window.CssStyleSheet objects as well, but keep in mind that those kind of objects will be converted, and you will not be able to use it after also, all Carnac specific styles will be lost, or converted, if standard CssStyleSheet can not recognise it for example {border: 1px [pattern] color;}

Name

module:geotoolkit/report/dom/Document~Document#adoptedStyleSheets

Example

import {CssStyleSheet} from '@int/geotoolkit/report/dom/css/CssStyleSheet';
const sheet = new CssStyleSheet();
sheet.replaceSync('a { color: red; }');
// Combine existing sheets with our new one:
document.adoptedStyleSheets = [...document.adoptedStyleSheets, sheet];

CssStyleSheet[]

• set adoptedStyleSheets(styleSheets): void

Returns clone array of a live collection which contains application specific CssStyleSheets Note: .adoptedStyleSheets can accept standard window.CssStyleSheet objects as well, but keep in mind that those kind of objects will be converted, and you will not be able to use it after also, all Carnac specific styles will be lost, or converted, if standard CssStyleSheet can not recognise it for example {border: 1px [pattern] color;}

Name

module:geotoolkit/report/dom/Document~Document#adoptedStyleSheets

Example

import {CssStyleSheet} from '@int/geotoolkit/report/dom/css/CssStyleSheet';
const sheet = new CssStyleSheet();
sheet.replaceSync('a { color: red; }');
// Combine existing sheets with our new one:
document.adoptedStyleSheets = [...document.adoptedStyleSheets, sheet];

void

• get attributes(): NamedItemMap

Node attributes

Name

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

NamedItemMap

Element.attributes

• get body(): Body

DOM Document body element

Name

module:geotoolkit/report/dom/Document~Document#body

Body

• 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 documentElement(): Document

DOM Document root element

Name

module:geotoolkit/report/dom/Document~Document#documentElement

Document

• get firstChild(): Node

First child node

Name

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

Node

Element.firstChild

• get head(): Element

DOM Document root element

Name

module:geotoolkit/report/dom/Document~Document#head

Element

• 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 styleSheets(): Proxy<StyleSheetList>

Returns a live style sheet list which maintains an up-to-date list of the css rule objects that comprise the stylesheet.

Name

module:geotoolkit/report/dom/Document~Document#styleSheets

Proxy<StyleSheetList>

• get tagName(): string

Node tag name

Name

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

string

Element.tagName

▸ appendChild(newChild): Document

Add child to the node

Document

Element.appendChild

▸ clearAttributes(): Document

Clear attributes

Document

Element.clearAttributes

▸ clearNodes(): Document

Remove all child nodes from this node

Document

this

Element.clearNodes

▸ connectStyle(style, type, callback): Document

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

Document

this

Element.connectStyle

▸ createAttribute(options): Attribute

Create new Attribute

Attribute

▸ createElement(options, elementRegistry?): Element | Node

Create new element with specified tag name

Element | Node

▸ disconnectStyle(style, type, callback): Document

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

Document

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?): Document

Flush all changes before saving

Document

Element.flush

▸ getAttribute(name): string

Return attribute value

string

Element.getAttribute

▸ 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

▸ getDocumentElement(): Document

Return DOM root element

Document

▸ getElementRegistry(): IElementsRegistry

Returns elements Registry

IElementsRegistry

Element.getElementRegistry

▸ 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

▸ getNodeIndex(): number

Return node index

number

Element.getNodeIndex

▸ getNodeValue(): string

Returns node value

string

Element.getNodeValue

▸ getParent(): Node

Returns parent node

Node

parent

Element.getParent

▸ getProperties(): Options

Gets the element properties

Options

props

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

▸ 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(): Document

Document

this

Element.invalidate

▸ Protected invalidateDocument(eventArgs): Document

Invalidate root document

Document

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(): Document

Lock document

Document

Element.lock

▸ normalize(): Document

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.

Document

this

Element.normalize

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

Notify listeners

Document

this

Element.notify

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

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.

Document

this

Element.off

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

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.

Document

this

Element.on

▸ Protected onParentChanged(): Document

Document

this

Element.onParentChanged

▸ Protected onResetCssProperties(silent?): Document

Clean up cached properties

Document

this

Element.onResetCssProperties

▸ removeAttribute(name): Document

Remove attribute

Document

Element.removeAttribute

▸ removeChild(child): Node

Remove child from node

Node

Element.removeChild

▸ replaceChild(newChild, oldChild): Document

Replace child

Document

Element.replaceChild

▸ Protected resetElementStyle(): Document

Reset own styles

Document

Element.resetElementStyle

▸ save(recursive?, serializationContext?): string

Serialize element to xml

string

Element.save

▸ setAttribute(name, value): Document

Set attribute value

Document

Element.setAttribute

▸ setAttributeNode(newAttr): Document

Adds a new Attribute node to the specified element.

Document

this

Element.setAttributeNode

▸ setCssClass(cssClass): Document

Set css class

Document

Element.setCssClass

▸ Protected setElementRegistry(registry): Document

Set shadow element registry

Document

Element.setElementRegistry

▸ setGuid(guid): Document

Set node GUID

Document

Element.setGuid

▸ setNodeValue(nodeValue): Document

Set node value

Document

Element.setNodeValue

▸ setProperties(properties?): Document

Sets all the properties pertaining to this object

Document

this

Element.setProperties

▸ setSilent(bool): Document

Set silent mode

Document

this

Element.setSilent

▸ setText(text): Document

Set text value

Document

this

Element.setText

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

Set XML content

Promise<NodeList<Node>>

promise

Element.setXmlContent

▸ unlock(): Document

Unlock document

Document

Element.unlock

▸ updateTimeStamp(): Document

Update time stamp to indicate that style has been changed.

Document

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