Preparing search index...
The search index is not available
docx
docx
patchDocument
Function patchDocument
patch
Document
(
data
,
options
)
:
Promise
<
Buffer
>
Parameters
data
:
InputDataType
options
:
PatchDocumentOptions
Returns
Promise
<
Buffer
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
docx
File
Alignment
Type
Border
Style
Document
Grid
Type
Drop
Cap
Type
Emphasis
Mark
Type
Frame
Anchor
Type
Frame
Wrap
Header
Footer
Reference
Type
Header
Footer
Type
Heading
Level
Height
Rule
Horizontal
Position
Align
Horizontal
Position
Relative
From
Hyperlink
Type
Leader
Type
Level
Format
Level
Suffix
Line
Number
Restart
Format
Line
Rule
Type
Number
Format
Overlap
Type
Page
Border
Display
Page
Border
Offset
From
Page
BorderZOrder
Page
Number
Page
Number
Separator
Page
Orientation
Page
Text
Direction
Type
Patch
Type
Positional
Tab
Alignment
Positional
Tab
Leader
Positional
Tab
Relative
To
Prettify
Type
Relative
Horizontal
Position
Relative
Vertical
Position
Section
Type
Shading
Type
Space
Type
Tab
Stop
Position
Tab
Stop
Type
Table
Anchor
Type
Table
Layout
Type
Text
Direction
Text
Effect
Text
Wrapping
Side
Text
Wrapping
Type
Underline
Type
Vertical
Align
Vertical
Merge
Type
Vertical
Position
Align
Vertical
Position
Relative
From
Width
Type
Abstract
Numbering
Alignment
Alignment
Attributes
Annotation
Reference
Attributes
Base
Emphasis
Mark
Base
Xml
Component
Body
Bookmark
Bookmark
End
Bookmark
Start
Border
Border
Element
Builder
Element
Carriage
Return
Column
Column
Break
Columns
Comment
Comment
Range
End
Comment
Range
Start
Comment
Reference
Comments
Concrete
Hyperlink
Concrete
Numbering
Continuation
Separator
Day
Long
Day
Short
Deleted
Text
Run
Doc
Grid
Attributes
Document
Document
Attributes
Document
Background
Document
Background
Attributes
Document
Defaults
Document
Grid
Dot
Emphasis
Mark
Drawing
Emphasis
Mark
Empty
Element
Endnote
Reference
External
Hyperlink
Foot
Note
Reference
Run
Attributes
Foot
Notes
Footer
Footer
Wrapper
Footnote
Reference
Footnote
Reference
Element
Footnote
Reference
Run
Frame
Properties
Frame
Properties
Attributes
Grid
Span
Header
Header
Footer
Reference
Header
Wrapper
Horizontal
Position
Hps
Measure
Element
Ignore
If
Empty
Xml
Component
Image
Run
Imported
Root
Element
Attributes
Imported
Xml
Component
Indent
Initializable
Xml
Component
Inserted
Text
Run
Internal
Hyperlink
Last
Rendered
Page
Break
Level
Level
Base
Level
For
Override
Level
Override
Line
Number
Type
Math
Math
Accent
Character
Math
Angled
Brackets
Math
Base
Math
Curly
Brackets
Math
Degree
Math
Denominator
Math
Fraction
Math
Function
Math
Function
Name
Math
Function
Properties
Math
Integral
Math
Limit
Location
MathNAry
Properties
Math
Numerator
Math
Pre
Sub
Super
Script
Math
Pre
Sub
Super
Script
Properties
Math
Radical
Math
Radical
Properties
Math
Round
Brackets
Math
Run
Math
Square
Brackets
Math
Sub
Script
Math
Sub
Script
Element
Math
Sub
Script
Properties
Math
Sub
Super
Script
Math
Sub
Super
Script
Properties
Math
Sum
Math
Super
Script
Math
Super
Script
Element
Math
Super
Script
Properties
Media
Month
Long
Month
Short
Next
Attribute
Component
No
Break
Hyphen
Number
Properties
Number
Value
Element
Numbering
On
Off
Element
Outline
Level
Packer
Page
Borders
Page
Break
Page
Break
Before
Page
Margin
Page
Number
Element
Page
Number
Type
Page
Number
Type
Attributes
Page
Reference
Page
Size
Page
Text
Direction
Paragraph
Paragraph
Properties
Paragraph
Properties
Defaults
Positional
Tab
Run
Run
Fonts
Run
Properties
Run
Properties
Change
Run
Properties
Defaults
Section
Properties
Section
Type
Attributes
Separator
Sequential
Identifier
Shading
Simple
Field
Simple
Mail
Merge
Field
Simple
Pos
Soft
Hyphen
Spacing
String
Container
String
Enum
Value
Element
String
Value
Element
Style
Style
For
Character
Style
For
Paragraph
Style
Level
Styles
Symbol
Run
TDirection
Tab
Tab
Attributes
Tab
Stop
Tab
Stop
Item
Table
Table
Borders
Table
Cell
Table
Cell
Borders
Table
Float
Properties
Table
Layout
Table
Of
Contents
Table
Properties
Table
Row
Table
Row
Height
Table
Row
Height
Attributes
Table
Row
Properties
Table
Width
Element
Text
Run
Thematic
Break
Type
Underline
Vertical
Align
Attributes
Vertical
Align
Element
Vertical
Merge
Vertical
Position
Wrap
None
Wrap
Square
Wrap
Tight
Wrap
Top
And
Bottom
Xml
Attribute
Component
Xml
Component
Year
Long
Year
Short
IAlignment
Frame
Options
IBase
Character
Style
Options
IBase
Paragraph
Style
Options
IBorder
Options
IBorders
Options
ICharacter
Style
Options
IComment
Options
IComments
Options
IConcrete
Numbering
Options
IContext
IDistance
IDoc
Grid
Attributes
Properties
IDocument
Attributes
Properties
IDocument
Background
Options
IDocument
Defaults
Options
IDocument
Footer
IDocument
Header
IDocument
Options
IDrawing
Options
IFloating
IFont
Attributes
Properties
IHeader
Footer
Group
IHeader
Footer
Options
IHeader
Options
IHorizontal
Position
Options
IImage
Options
IIndent
Attributes
Properties
ILevel
Paragraph
Style
Properties
Options
ILevels
Options
ILine
Number
Attributes
IMargins
IMath
Fraction
Options
IMath
Function
Options
IMath
Integral
Options
IMath
Options
IMath
Pre
Sub
Super
Script
Options
IMath
Radical
Options
IMath
Sub
Script
Options
IMath
Sub
Super
Script
Options
IMath
Sum
Options
IMath
Super
Script
Options
IMedia
Data
IMedia
Data
Transformation
IMedia
Transformation
INumbering
Options
IPage
Border
Attributes
IPage
Borders
Options
IPage
Number
Type
Attributes
IParagraph
Options
IParagraph
Properties
Options
IParagraph
Style
Options
IParagraph
Style
Properties
Options
IRun
Options
IRun
Properties
Change
Options
IRun
Properties
Options
IRun
Style
Properties
Options
ISection
Options
ISection
Properties
Options
IShading
Attributes
Properties
ISpacing
Properties
IStyles
Options
ISymbol
Run
Options
ITable
Borders
Options
ITable
Cell
Borders
ITable
Cell
Options
ITable
Of
Contents
Options
ITable
Options
ITable
Properties
Options
ITable
Row
Options
ITable
Row
Properties
Options
IText
Wrapping
IVertical
Position
Options
IXYFrame
Options
IXml
Attribute
IXmlable
Object
Patch
Document
Options
Positional
Tab
Options
Tab
Stop
Definition
Attribute
Data
Attribute
Map
Attribute
Payload
IColumns
Attributes
IFrame
Options
IPage
Margin
Attributes
IPage
Size
Attributes
IPatch
ITable
Float
Options
ITable
Width
Properties
Math
Component
Paragraph
Child
Percentage
Positive
Universal
Measure
Unique
Numeric
Id
Creator
Universal
Measure
EMPTY_
OBJECT
section
Margin
Defaults
section
Page
Size
Defaults
abstract
Num
Unique
Numeric
Id
Gen
bookmark
Unique
Numeric
Id
Gen
concrete
Num
Unique
Numeric
Id
Gen
convert
Inches
To
Twip
convert
Millimeters
To
Twip
convert
To
Xml
Component
date
Time
Value
decimal
Number
doc
Properties
Unique
Numeric
Id
Gen
eighth
Point
Measure
Value
hex
Color
Value
hps
Measure
Value
long
Hex
Number
measurement
Or
Percent
Value
patch
Document
percentage
Value
point
Measure
Value
positive
Universal
Measure
Value
short
Hex
Number
signed
Hps
Measure
Value
signed
Twips
Measure
Value
twips
Measure
Value
u
Char
Hex
Number
unique
Id
unique
Numeric
Id
Creator
universal
Measure
Value
unsigned
Decimal
Number
Generated using
TypeDoc