Class: Svg

• new Svg(options)

• new Svg(options)

AbstractElement.constructor

• get attributes(): NamedItemMap

Node attributes

Name

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

NamedItemMap

AbstractElement.attributes

• get childNodes(): NodeList<Node>

The element holding the item.

Name

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

NodeList<Node>

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

AbstractElement.children

• get data(): string

Node data

Name

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

string

AbstractElement.data

• set data(data): void

Node data

Name

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

void

AbstractElement.data

• get firstChild(): Node

First child node

Name

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

Node

AbstractElement.firstChild

• get lastChild(): Node

Last child node

Name

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

Node

AbstractElement.lastChild

• get localName(): string

Node local name

Name

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

string

AbstractElement.localName

• get nextSibling(): Node

Next sibling node

Name

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

Node

AbstractElement.nextSibling

• get nodeName(): string

Node name

Name

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

string

AbstractElement.nodeName

• get nodeType(): NodeType

Node type

Name

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

NodeType

AbstractElement.nodeType

• get nodeValue(): string

Node value

Name

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

string

AbstractElement.nodeValue

• set nodeValue(value): void

Node value

Name

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

void

AbstractElement.nodeValue

• get ownerDocument(): Document

Node owner document

Name

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

Document

AbstractElement.ownerDocument

• get parentNode(): Node

Parent node

Name

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

Node

AbstractElement.parentNode

• get previousSibling(): Node

Previous sibling node

Name

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

Node

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

AbstractElement.rootNode

• get tagName(): string

Node tag name

Name

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

string

AbstractElement.tagName

▸ appendChild(newChild): Svg

Add child to the node

Svg

AbstractElement.appendChild

▸ clearAttributes(): Svg

Clear attributes

Svg

AbstractElement.clearAttributes

▸ clearNodes(): Svg

Remove all child nodes from this node

Svg

this

AbstractElement.clearNodes

▸ connectStyle(style, type, callback): Svg

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

Svg

this

AbstractElement.connectStyle

▸ disconnectStyle(style, type, callback): Svg

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

Svg

this

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

AbstractElement.dispose

▸ enumerateNodes(callback, target?): void

Enumerate children nodes

void

AbstractElement.enumerateNodes

▸ Protected flush(serializationContext?): Svg

Flush all changes before saving

Svg

AbstractElement.flush

▸ getAttribute(name): string

Return attribute value

string

AbstractElement.getAttribute

▸ getBackgroundStyle(): FillStyle

Return background style

FillStyle

background current background style

AbstractElement.getBackgroundStyle

▸ getBorderLineStyle(): LineStyle

Return border line style

LineStyle

AbstractElement.getBorderLineStyle

▸ getClassName(): string

string

AbstractElement.getClassName

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

AbstractElement.getCssClass

▸ getElementRegistry(): IElementsRegistry

Returns elements Registry

IElementsRegistry

AbstractElement.getElementRegistry

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

Return array of transformation instructions

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

array of transformations

AbstractElement.getElementTransform

▸ getFlip(): boolean

Return element content flip flag

boolean

element layout orientation

AbstractElement.getFlip

▸ getGuid(): string

Returns element GUID

string

AbstractElement.getGuid

▸ getId(): string

Returns element id

string

AbstractElement.getId

▸ getInnerCssStyle(): string

Return collected inner css style

string

inner css style

AbstractElement.getInnerCssStyle

▸ getLayoutStyle(): LayoutStyle<string | number>

Return layout style

LayoutStyle<string | number>

layout style

AbstractElement.getLayoutStyle

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

margins style

AbstractElement.getMarginsStyle

▸ getNodeIndex(): number

Return node index

number

AbstractElement.getNodeIndex

▸ getNodeValue(): string

Returns node value

string

AbstractElement.getNodeValue

▸ getOrientation(): Orientation

Return element layout orientation

Orientation

element layout orientation

AbstractElement.getOrientation

▸ getPaddingStyle(): SpaceStyle<string | number>

Return padding style

SpaceStyle<string | number>

padding style

AbstractElement.getPaddingStyle

▸ getPageBreak(): PageBreak

Returns element page break

PageBreak

page break

AbstractElement.getPageBreak

▸ getParent(): Node

Returns parent node

Node

parent

AbstractElement.getParent

▸ getProperties(): Options

Gets the element properties

Options

AbstractElement.getProperties

▸ getRootNode(): Node

Return root node

Node

node

AbstractElement.getRootNode

▸ getTagName(): string

Returns node tag name

string

AbstractElement.getTagName

▸ getTimeStamp(): number

Gets time stamp

number

timeStamp

AbstractElement.getTimeStamp

▸ getTransformOrigin(): string

Return transform origin

string

AbstractElement.getTransformOrigin

▸ getVisible(): boolean

Get element visible state

boolean

AbstractElement.getVisible

▸ hasAttribute(name): boolean

Check if attribute exists

boolean

AbstractElement.hasAttribute

▸ hasChildNodes(): boolean

Return true if node has children

boolean

AbstractElement.hasChildNodes

▸ hasEventListener(type, callback?): boolean

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

boolean

AbstractElement.hasEventListener

▸ indexOfNode(node): number

Returns index of node.

number

AbstractElement.indexOfNode

▸ insertAfter(newChild, refChild): Node

Insert child

Node

AbstractElement.insertAfter

▸ insertBefore(newChild, refChild): Node

Insert child

Node

AbstractElement.insertBefore

▸ Protected invalidate(): Svg

Svg

this

AbstractElement.invalidate

▸ Protected invalidateDocument(eventArgs): Svg

Invalidate root document

Svg

this

AbstractElement.invalidateDocument

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractElement.isDisposed

▸ isSilent(): boolean

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

boolean

AbstractElement.isSilent

▸ lock(): Svg

Lock node

Svg

AbstractElement.lock

▸ normalize(): Svg

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.

Svg

this

AbstractElement.normalize

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

Notify listeners

Svg

this

AbstractElement.notify

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

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.

Svg

this

AbstractElement.off

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

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.

Svg

this

AbstractElement.on

▸ Protected onParentChanged(): Svg

Svg

this

AbstractElement.onParentChanged

▸ Protected onResetCssProperties(silent?): Svg

Clean up cached properties

Svg

this

AbstractElement.onResetCssProperties

▸ removeAttribute(name): Svg

Remove attribute

Svg

AbstractElement.removeAttribute

▸ removeChild(child): Node

Remove child from node

Node

AbstractElement.removeChild

▸ replaceChild(newChild, oldChild): Svg

Replace child

Svg

AbstractElement.replaceChild

▸ Protected resetElementStyle(): Svg

Reset own styles

Svg

AbstractElement.resetElementStyle

▸ save(recursive?, serializationContext?): string

Serialize element to xml

string

AbstractElement.save

▸ setAttribute(name, value): Svg

Set attribute value

Svg

AbstractElement.setAttribute

▸ setAttributeNode(newAttr): Svg

Adds a new Attribute node to the specified element.

Svg

this

AbstractElement.setAttributeNode

▸ setBackgroundStyle(backgroundStyle, merge?): Svg

Set background style

Svg

this

AbstractElement.setBackgroundStyle

▸ setBorderLineStyle(borderStyle, merge?): Svg

Sets border line style Returns this

Svg

this

AbstractElement.setBorderLineStyle

▸ setCssClass(cssClass): Svg

Set css class

Svg

AbstractElement.setCssClass

▸ Protected setElementRegistry(registry): Svg

Set shadow element registry

Svg

AbstractElement.setElementRegistry

▸ setElementTransform(transformOrigin, transformation?): void

Set element transform

void

AbstractElement.setElementTransform

▸ setFlip(flip): Svg

Set element content flip orientation

Svg

AbstractElement.setFlip

▸ setGuid(guid): Svg

Set node GUID

Svg

AbstractElement.setGuid

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

Sets layout style

Svg

AbstractElement.setLayoutStyle

▸ setMarginsStyle(margins?, merge?): Svg

Sets margins style

Svg

AbstractElement.setMarginsStyle

▸ setNodeValue(nodeValue): Svg

Set node value

Svg

AbstractElement.setNodeValue

▸ setOrientation(orientation): Svg

Set element layout orientation

Svg

AbstractElement.setOrientation

▸ setPaddingStyle(padding?, merge?): Svg

Sets padding style

Svg

AbstractElement.setPaddingStyle

▸ setPageBreak(pageBreak): Svg

Set element page break

Svg

this

AbstractElement.setPageBreak

▸ setProperties(props): Svg

Sets the element properties

Svg

this

AbstractElement.setProperties

▸ setSilent(bool): Svg

Set silent mode

Svg

this

AbstractElement.setSilent

▸ setText(text): Svg

Set text value

Svg

this

AbstractElement.setText

▸ setVisible(visible): Svg

Set element visible state

Svg

AbstractElement.setVisible

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

Set XML content

Promise<NodeList<Node>>

promise

AbstractElement.setXmlContent

▸ unlock(): Svg

Unlock node

Svg

AbstractElement.unlock

▸ updateTimeStamp(): Svg

Update time stamp to indicate that style has been changed.

Svg

this

AbstractElement.updateTimeStamp

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

Find root of the node with specified type

InstanceType<T>

AbstractElement.findParentNode

▸ Static findParentNode(node, classType): Node

Find root of the node with specified type

Node

AbstractElement.findParentNode

▸ Static getClassName(): string

string

AbstractElement.getClassName