## Index

### Enumerations

- BorderStyle
- FooterReferenceType
- FootnoteType
- HeaderReferenceType
- HorizontalPositionAlign
- HorizontalPositionRelativeFrom
- LevelSuffix
- PageBorderDisplay
- PageBorderOffsetFrom
- PageBorderZOrder
- PageNumberFormat
- PageOrientation
- PlacementPosition
- TextWrapStyle
- VMergeType
- VerticalPositionAlign
- VerticalPositionRelativeFrom
- WidthType
- WrapTextOption

### Classes

- AbstractNumbering
- AdjustmentValues
- Align
- Alignment
- AlignmentAttributes
- Anchor
- AnchorAttributes
- AppProperties
- AppPropertiesAttributes
- Attributes
- BaseUnderline
- BaseXmlComponent
- BasedOn
- Begin
- Bidirectional
- Blip
- BlipFill
- Body
- Bold
- BoldComplexScript
- Bookmark
- BookmarkEnd
- BookmarkEndAttributes
- BookmarkStart
- BookmarkStartAttributes
- Border
- Break
- Caps
- CenterTabStop
- CharacterStyle
- ChildNonVisualProperties
- Color
- Columns
- ColumnsAttributes
- Compiler
- ContentTypeAttributes
- ContentTypes
- ContinuationSeperator
- ContinuationSeperatorRun
- CoreProperties
- Created
- Creator
- DashDotDotHeavyUnderline
- DashDotHeavyUnderline
- DashLongHeavyUnderline
- DashLongUnderline
- DashUnderline
- DateComponent
- Default
- DefaultAttributes
- DefaultStylesFactory
- Description
- DocGridAttributes
- DocProperties
- DocPropertiesAttributes
- Document
- DocumentAttributes
- DocumentDefaults
- DocumentGrid
- DotDashUnderline
- DotDotDashUnderline
- DottedHeavyUnderline
- DottedUnderline
- DoubleStrike
- DoubleUnderline
- Drawing
- EffectExtent
- EffectExtentAttributes
- Emboss
- End
- Extent
- ExtentAttributes
- Extents
- ExtentsAttributes
- ExternalStylesFactory
- File
- FootNoteReferenceRunAttributes
- FootNotes
- Footer
- FooterAttributes
- FooterReference
- FooterReferenceAttributes
- FooterWrapper
- Footnote
- FootnoteAttributes
- FootnoteRef
- FootnoteRefRun
- FootnoteReference
- FootnoteReferenceRun
- FootnoteReferenceStyle
- FootnoteText
- FootnoteTextChar
- FootnotesAttributes
- Form
- Formatter
- Graphic
- GraphicData
- GraphicDataAttributes
- GraphicFrameLockAttributes
- GraphicFrameLocks
- GraphicFrameProperties
- GridCol
- GridSpan
- Header
- HeaderAttributes
- HeaderReference
- HeaderReferenceAttributes
- HeaderWrapper
- Heading1Style
- Heading2Style
- Heading3Style
- Heading4Style
- Heading5Style
- Heading6Style
- HeadingStyle
- HorizontalPosition
- Hyperlink
- HyperlinkAttributes
- HyperlinkStyle
- Image
- ImageParagraph
- ImportedRootElementAttributes
- ImportedXmlComponent
- Imprint
- Indent
- Inline
- InlineAttributes
- Italics
- ItalicsComplexScript
- KeepLines
- KeepNext
- Keywords
- LastModifiedBy
- LeftTabStop
- Level
- LevelBase
- LevelForOverride
- LevelOverride
- Link
- ListParagraph
- MaxRightTabStop
- Media
- Modified
- MultiLevelType
- Name
- Next
- NonVisualPicProperties
- NonVisualProperties
- NonVisualPropertiesAttributes
- Num
- NumberProperties
- Numbering
- Offset
- OffsetAttributes
- Override
- OverrideAttributes
- Packer
- Page
- PageBorders
- PageBreak
- PageBreakBefore
- PageMargin
- PageMarginAttributes
- PageNumberType
- PageNumberTypeAttributes
- PageSize
- PageSizeAttributes
- Paragraph
- ParagraphProperties
- ParagraphPropertiesDefaults
- ParagraphStyle
- Pic
- PicAttributes
- PicLocks
- PicLocksAttributes
- PictureRun
- PositionOffset
- PresetGeometry
- PresetGeometryAttributes
- QuickFormat
- Relationship
- RelationshipAttributes
- Relationships
- RelationshipsAttributes
- Revision
- RightTabStop
- RightToLeft
- RsId
- Run
- RunFonts
- RunProperties
- RunPropertiesDefaults
- SectionProperties
- SemiHidden
- Separate
- Seperator
- SeperatorRun
- Shadow
- ShapeProperties
- ShapePropertiesAttributes
- SimplePos
- SingleUnderline
- Size
- SizeComplexScript
- SmallCaps
- SourceRectangle
- Spacing
- Stretch
- Strike
- Style
- Styles
- SubScript
- Subject
- SuperScript
- Tab
- TabAttributes
- TabStop
- Table
- TableCell
- TableCellBorders
- TableCellMargin
- TableCellProperties
- TableCellShading
- TableCellWidth
- TableGrid
- TableProperties
- TableRow
- TableRowProperties
- Text
- TextRun
- ThematicBreak
- ThickUnderline
- Title
- TitleStyle
- UiPriority
- Underline
- UnhideWhenUsed
- VAlign
- VMerge
- VerticalAlign
- VerticalPosition
- WaveUnderline
- WavyDoubleUnderline
- WavyHeavyUnderline
- WordsUnderline
- WrapNone
- WrapSquare
- WrapTight
- WrapTopAndBottom
- XmlAttributeComponent
- XmlComponent

### Interfaces

- IAnchorAttributes
- IAppPropertiesAttributes
- IAttributesProperties
- IBookmarkEndAttributesProperties
- IBookmarkStartAttributesProperties
- IColumnsAttributes
- IContentTypeAttributes
- IDefaultAttributes
- IDistance
- IDocGridAttributesProperties
- IDocPropertiesAttributes
- IDocumentAttributesProperties
- IDrawingOptions
- IEffectExtentAttributes
- IExtentAttributes
- IExtentsAttributes
- IFloating
- IFootNoteReferenceRunAttributesProperties
- IFooterAttributesProperties
- IFooterOptions
- IFooterReferenceAttributes
- IFootnoteAttributesProperties
- IFootnotesAttributesProperties
- IGraphicDataAttributes
- IGraphicFrameLockAttributes
- IHeaderAttributesProperties
- IHeaderOptions
- IHeaderReferenceAttributes
- IHorizontalPositionOptions
- IHyperlinkAttributesProperties
- IIndentAttributesProperties
- IInlineAttributes
- IMediaData
- IMediaDataDimensions
- INonVisualPropertiesAttributes
- IOffsetAttributes
- IOverrideAttributes
- IPageBorderAttributes
- IPageBorderConfiguration
- IPageBordersOptions
- IPageMarginAttributes
- IPageNumberTypeAttributes
- IPageSizeAttributes
- IPicAttributes
- IPicLocksAttributes
- IPresetGeometryAttributes
- IPropertiesOptions
- IRelationshipAttributesProperties
- IRelationshipsAttributesProperties
- IShapePropertiesAttributes
- ISpacingProperties
- IStyleAttributes
- ITextWrapping
- IVerticalPositionOptions
- IXmlableObject

### Type aliases

- AlignmentOptions
- AttributeMap
- RelationshipType
- SectionPropertiesOptions
- TabValue
- TargetModeType

### Variables

- WORKAROUND2
- WORKAROUND3

### Functions

- convertToXmlComponent

### Object literals

- parseOptions

## Type aliases

### AlignmentOptions

AlignmentOptions: "start" | "end" | "center" | "both" | "distribute" | "left" | "right"

- Defined in file/paragraph/formatting/alignment.ts:4

### AttributeMap

AttributeMap: object

- Defined in file/xml-components/default-attributes.ts:4

#### Type declaration

### RelationshipType

RelationshipType: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/fontTable" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/webSettings" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/header" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" | "http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footnotes"

- Defined in file/relationships/relationship/relationship.ts:4

### SectionPropertiesOptions

SectionPropertiesOptions: IPageSizeAttributes & IPageMarginAttributes & IColumnsAttributes & IDocGridAttributesProperties & IHeaderOptions & IFooterOptions & IPageNumberTypeAttributes & IPageBordersOptions

- Defined in file/document/body/section-properties/section-properties.ts:16

### TabValue

TabValue: "left" | "right" | "center" | "bar" | "clear" | "decimal" | "end" | "num" | "start"

- Defined in file/paragraph/formatting/tab-stop.ts:11

### TargetModeType

TargetModeType: "External"

- Defined in file/relationships/relationship/relationship.ts:20

## Variables

### Const WORKAROUND2

WORKAROUND2: "" = ""

- Defined in file/media/data.ts:24

ignore

### Const WORKAROUND3

WORKAROUND3: "" = ""

- Defined in file/xml-components/xmlable-object.ts:9

ignore

## Functions

### convertToXmlComponent

- convertToXmlComponent(elementName: string, element: any): ImportedXmlComponent | ImportedXmlComponent[]

- - Defined in file/xml-components/imported-xml-component.ts:28

  Converts the given xml element (in json format) into XmlComponent. Note: If element is array, them it will return ImportedXmlComponent[]. Example for given: element = [ { w:t: "val 1"}, { w:t: "val 2"} ] will return [ ImportedXmlComponent { rootKey: "w:t", root: [ "val 1" ]}, ImportedXmlComponent { rootKey: "w:t", root: [ "val 2" ]} ]

  #### Parameters

  - ##### elementName: string

    name (rootKey) of the XmlComponent

  - ##### element: any

    the xml element in json presentation

  #### Returns ImportedXmlComponent | ImportedXmlComponent[]

## Object literals

### Const parseOptions

parseOptions: object

- Defined in file/xml-components/imported-xml-component.ts:6

### attrNodeName

attrNodeName: string = "_attr"

- Defined in file/xml-components/imported-xml-component.ts:9

### attributeNamePrefix

attributeNamePrefix: string = ""

- Defined in file/xml-components/imported-xml-component.ts:8

### ignoreAttributes

ignoreAttributes: boolean = false

- Defined in file/xml-components/imported-xml-component.ts:7

Generated using TypeDoc