Class ImportedXmlComponent

Represents imported xml component from xml file.

Hierarchy (View Summary)

XmlComponent
- ImportedXmlComponent

Index

Constructors

Methods

addChildElement prepForXml push fromXmlString

Constructors

constructor

new ImportedXmlComponent(rootKey: string, _attr?: any): ImportedXmlComponent
Creates an ImportedXmlComponent.
Parameters
- rootKey: string
  the root element name
- Optional_attr: any
  optional attributes for the root element
Returns ImportedXmlComponent
Overrides XmlComponent.constructor
- Defined in file/xml-components/imported-xml-component.ts:61

Methods

addChildElement

addChildElement(child: string | XmlComponent): XmlComponent
Parameters
- child: string | XmlComponent
Returns XmlComponent
Deprecated
Do not use this method. It is only used internally by the library. It will be removed in a future version.
Inherited from XmlComponent.addChildElement
- Defined in file/xml-components/xml-component.ts:67

prepForXml

prepForXml(context: IContext): undefined | IXmlableObject
Parameters
- context: IContext
Returns undefined | IXmlableObject
Inherited from XmlComponent.prepForXml
- Defined in file/xml-components/xml-component.ts:39

push

push(xmlComponent: string | XmlComponent): void
Parameters
- xmlComponent: string | XmlComponent
Returns void
- Defined in file/xml-components/imported-xml-component.ts:68

`Static`fromXmlString

fromXmlString(importedContent: string): ImportedXmlComponent
Converts the xml string to a XmlComponent tree.
Parameters
- importedContent: string
  xml content of the imported component
Returns ImportedXmlComponent
- Defined in file/xml-components/imported-xml-component.ts:50