XmlWriter

Show usages

Default implementation of IXmlWriter.

Inheritance Hierarchy

XmlWriter

Implemented Interfaces

IXmlWriter

Remarks

This writer does not support random access on the output document.

Type Details

yfiles module: view-graphml
yfiles-umd modules: view-graphml, view
Legacy UMD name: yfiles.graphml.XmlWriter

Constructors

XmlWriter

()

Create a new instance with enabled indent.

Properties

indent

: boolean

This property controls whether the output should be properly indented.

namespaceManager

: IXmlNamespaceManager

Gets the namespace manager associated with this writer.

Implements

IXmlWriter

Methods

closeCurrentElement

(addEndTag: boolean)

Closes the current element.

Parameters

options - Object
A map of options to pass to the method.

addEndTag - boolean: Specifies whether to add an end tag or to write a self-closing element.

createNamespaceManager

() : IXmlNamespaceManager

Factory method that creates the namespace manager for this instance.

Returns

↪IXmlNamespaceManager: A new manager instance.

flushDocument

()

Closes the document.

Remarks

This is typically used to actually flush the document to an output stream

Implements

IXmlWriter

getXmlString

() : string

Gets a text representation of all content that has been written so far.

Implements

IXmlWriter

writeAttribute

(localName: string, value: string) : IXmlWriter

Write an XML attribute with the given parameters.

Remarks

The attribute is not bound to a XML namespace.

Parameters

options - Object
A map of options to pass to the method.

localName - string: The name of the attribute.
value - string: The value of the attribute.

Returns

↪IXmlWriter: The writer instance writer for writer chaining.

Defined in

IXmlWriter

writeAttributeNS

(prefix: string, localName: string, ns: string, value: string) : IXmlWriter

Writes a XML attribute node.

Remarks

The attribute is attached to the closest open XML element that has been started with writeStartElement or writeStartElement. Note that namespace declarations should not be written directly as attributes. Instead the namespaceManager should be used.

Parameters

options - Object
A map of options to pass to the method.

prefix - string: The namespace prefix of the attribute
localName - string: The local name of the attribute
ns - string: The namespace URI of this attribute
value - string: The value of this attribute

Returns

↪IXmlWriter: The writer instance for further chaining

Implements

IXmlWriter

writeCData

(content: string) : IXmlWriter

Writes a CDATA section.

Parameters

options - Object
A map of options to pass to the method.

content - string: The content of the CDATA section

Returns

↪IXmlWriter: The writer instance for further chaining

Implements

IXmlWriter

writeComment

(comment: string) : IXmlWriter

Writes a XML comment node

Parameters

options - Object
A map of options to pass to the method.

comment - string: The content of the comment

Returns

↪IXmlWriter: The writer instance for further chaining

Implements

IXmlWriter

writeDocumentFragment

(fragment: Document) : IXmlWriter

Writes a document fragment

Returns

↪IXmlWriter: The writer instance for further chaining

Implements

IXmlWriter

writeEndDocument

()

Closes the output.

Remarks

Attempts to write after this method has been called will have undefined results.

Implements

IXmlWriter

writeEndElement

() : IXmlWriter

Closes a XML element previously opened with writeStartElement or writeStartElement.

Returns

↪IXmlWriter: The writer instance for further chaining

Implements

IXmlWriter

writeGraphMLXmlAttribute

(attribute: GraphMLXmlAttribute) : IXmlWriter

Write an XML attribute from the given attribute struct.

Parameters

options - Object
A map of options to pass to the method.

attribute - GraphMLXmlAttribute: Encapsulates the current attribute values.

Returns

↪IXmlWriter: The writer instance writer for writer chaining.

Defined in

IXmlWriter

writeProcessingInstruction

(target: string, data: string) : IXmlWriter

Writes a xml processing instruction.

Parameters

options - Object
A map of options to pass to the method.

target - string: The target of the PI
data - string: The data of the PI

Returns

↪IXmlWriter: The writer instance for further chaining

Implements

IXmlWriter

writeStartDocument

() : IXmlWriter

Begins the output process

Returns

↪IXmlWriter: The writer instance for further chaining

Implements

IXmlWriter

writeStartElement

(prefix: string, localName: string, ns: string) : IXmlWriter

Begins a new XML element with given parameters

Remarks

All subsequent output is attached to this element until writeEndElement has been called or a new element has been started.

Parameters

options - Object
A map of options to pass to the method.

prefix - string: The namespace prefix to use for this element
localName - string: The local name of this element
ns - string: The namespace of this element

Returns

↪IXmlWriter: The writer instance for further chaining

Implements

IXmlWriter

writeStartElement

(localName: string, ns: string) : IXmlWriter

Begin a new XML element with given parameters

Remarks

All subsequent output is attached to this element until writeEndElement has been called or a new element has been started.

This acts like writeStartElement, but uses the default prefix for the namespace

Parameters

options - Object
A map of options to pass to the method.

localName - string: The local name of this element
ns - string: The namespace of this element

Returns

↪IXmlWriter: The writer instance for further chaining

Implements

IXmlWriter

writeString

(s: string) : IXmlWriter

Writes a text node.

Remarks

The string value of s will be correctly escaped

Parameters

options - Object
A map of options to pass to the method.

s - string: The string that gets written as XML text

Returns

↪IXmlWriter: The writer instance for further chaining

Implements

IXmlWriter