docx

Index

References

File

Classes

Interfaces

Type Aliases

Variables

References

File

Renames and re-exports Document

Type Aliases

AttributeMap

AttributeMap<T>: { [ P in keyof T]: string }

Type Parameters

IFrameOptions

IFrameOptions: IXYFrameOptions | IAlignmentFrameOptions

MathComponent

ParagraphChild

Variables

Const EMPTY_OBJECT

EMPTY_OBJECT: {} = ...

Type declaration

Const sectionMarginDefaults

sectionMarginDefaults: { BOTTOM: string; FOOTER: number; GUTTER: number; HEADER: number; LEFT: string; RIGHT: string; TOP: string } = ...

Type declaration

BOTTOM: string
FOOTER: number
GUTTER: number
HEADER: number
LEFT: string
RIGHT: string
TOP: string

Const sectionPageSizeDefaults

sectionPageSizeDefaults: { HEIGHT: number; ORIENTATION: PageOrientation; WIDTH: number } = ...

Type declaration

HEIGHT: number
ORIENTATION: PageOrientation
WIDTH: number

Functions

convertInchesToTwip

convertInchesToTwip(inches: number): number

- Defined in src/convenience-functions.ts:10
Parameters
- inches: number
Returns number

convertMillimetersToTwip

convertMillimetersToTwip(millimeters: number): number

- Defined in src/convenience-functions.ts:6
Parameters
- millimeters: number
Returns number

convertToXmlComponent

convertToXmlComponent(element: Element): ImportedXmlComponent | string | undefined

- Defined in src/file/xml-components/imported-xml-component.ts:11
Converts the given xml element (in json format) into XmlComponent.

Parameters
- element: Element
  
  the xml element in json presentation
Returns ImportedXmlComponent | string | undefined

dateTimeValue

dateTimeValue(val: Date): string

- Defined in src/file/values.ts:224
Parameters
- val: Date
Returns string

decimalNumber

decimalNumber(val: number): number

- Defined in src/file/values.ts:10
Parameters
- val: number
Returns number

eighthPointMeasureValue

eighthPointMeasureValue(val: number): number

- Defined in src/file/values.ts:198
Parameters
- val: number
Returns number

hexColorValue

hexColorValue(val: string): string

- Defined in src/file/values.ts:119
Parameters
- val: string
Returns string

hpsMeasureValue

hpsMeasureValue(val: string | number): string | number

- Defined in src/file/values.ts:139
Parameters
- val: string | number
Returns string | number

longHexNumber

longHexNumber(val: string): string

- Defined in src/file/values.ts:46
Parameters
- val: string
Returns string

measurementOrPercentValue

measurementOrPercentValue(val: string | number): number | string

- Defined in src/file/values.ts:185
Parameters
- val: string | number
Returns number | string

percentageValue

percentageValue(val: string): string

- Defined in src/file/values.ts:162
Parameters
- val: string
Returns string

pointMeasureValue

pointMeasureValue(val: number): number

- Defined in src/file/values.ts:203
Parameters
- val: number
Returns number

positiveUniversalMeasureValue

positiveUniversalMeasureValue(val: string): string

- Defined in src/file/values.ts:97
Parameters
- val: string
Returns string

shortHexNumber

shortHexNumber(val: string): string

- Defined in src/file/values.ts:55
Parameters
- val: string
Returns string

signedHpsMeasureValue

signedHpsMeasureValue(val: string | number): string | number

- Defined in src/file/values.ts:146
Parameters
- val: string | number
Returns string | number

signedTwipsMeasureValue

signedTwipsMeasureValue(val: string | number): string | number

- Defined in src/file/values.ts:132
Parameters
- val: string | number
Returns string | number

twipsMeasureValue

twipsMeasureValue(val: string | number): string | number

- Defined in src/file/values.ts:153
Parameters
- val: string | number
Returns string | number

uCharHexNumber

uCharHexNumber(val: string): string

- Defined in src/file/values.ts:64
Parameters
- val: string
Returns string

uniqueId

uniqueId(): string

- Defined in src/convenience-functions.ts:18
Returns string

uniqueNumericId

uniqueNumericId(): number

- Defined in src/convenience-functions.ts:14
Returns number

universalMeasureValue

universalMeasureValue(val: string): string

- Defined in src/file/values.ts:79
Parameters
- val: string
Returns string

unsignedDecimalNumber

unsignedDecimalNumber(val: number): number

- Defined in src/file/values.ts:20
Parameters
- val: number
Returns number

Index

References

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

References

File

Type Aliases

AttributeMap

Type Parameters

T

IFrameOptions

MathComponent

ParagraphChild

Variables

Const EMPTY_OBJECT

Type declaration

Const sectionMarginDefaults

Type declaration

BOTTOM: string

FOOTER: number

GUTTER: number

HEADER: number

LEFT: string

RIGHT: string

TOP: string

Const sectionPageSizeDefaults

Type declaration

HEIGHT: number

ORIENTATION: PageOrientation

WIDTH: number

Functions

convertInchesToTwip

Parameters

inches: number

Returns number

convertMillimetersToTwip

Parameters

millimeters: number

Returns number

convertToXmlComponent

Parameters

element: Element

Returns ImportedXmlComponent | string | undefined

dateTimeValue

Parameters

val: Date

Returns string

decimalNumber

Parameters

val: number

Returns number

eighthPointMeasureValue

Parameters

val: number

Returns number

hexColorValue

Parameters

val: string

Returns string

hpsMeasureValue

Parameters

val: string | number

Returns string | number

longHexNumber

Parameters

val: string

Returns string

measurementOrPercentValue

Parameters

val: string | number

Returns number | string

percentageValue

Parameters

val: string

Returns string

pointMeasureValue