From 91170899c74d386e69c4f85c608f8514364757a0 Mon Sep 17 00:00:00 2001 From: "Deployment Bot (from Travis CI)" Date: Tue, 6 Aug 2019 22:40:09 +0000 Subject: [PATCH] Deploy dolanmiu/docx to github.com/dolanmiu/docx.git:gh-pages --- README.md | 48 +- _sidebar.md | 1 + api/classes/abstractnumbering.html | 16 +- api/classes/adjustmentvalues.html | 10 +- api/classes/alias.html | 10 +- api/classes/align.html | 10 +- api/classes/alignment.html | 14 +- api/classes/alignmentattributes.html | 8 +- api/classes/anchor.html | 10 +- api/classes/anchorattributes.html | 8 +- api/classes/appproperties.html | 10 +- api/classes/apppropertiesattributes.html | 8 +- api/classes/attributes.html | 8 +- api/classes/basedon.html | 10 +- api/classes/baseunderline.html | 10 +- api/classes/basexmlcomponent.html | 6 +- api/classes/begin.html | 10 +- api/classes/bidirectional.html | 10 +- api/classes/blip.html | 10 +- api/classes/blipfill.html | 10 +- api/classes/body.html | 76 +- api/classes/bold.html | 10 +- api/classes/boldcomplexscript.html | 10 +- api/classes/bookmark.html | 10 +- api/classes/bookmarkend.html | 12 +- api/classes/bookmarkendattributes.html | 8 +- api/classes/bookmarkstart.html | 12 +- api/classes/bookmarkstartattributes.html | 8 +- api/classes/border.html | 166 +--- api/classes/borderattributes.html | 304 ++++++ api/classes/bottomcellmargin.html | 10 +- api/classes/break.html | 10 +- api/classes/cantsplit.html | 10 +- api/classes/caps.html | 10 +- api/classes/centertabstop.html | 10 +- api/classes/characterspacing.html | 10 +- api/classes/characterstyle.html | 40 +- api/classes/childnonvisualproperties.html | 10 +- api/classes/color.html | 10 +- api/classes/columns.html | 10 +- api/classes/columnsattributes.html | 8 +- api/classes/compatibility.html | 12 +- api/classes/compiler.html | 4 +- api/classes/contenttypeattributes.html | 8 +- api/classes/contenttypes.html | 14 +- api/classes/contextualspacing.html | 10 +- api/classes/continuationseperator.html | 10 +- api/classes/continuationseperatorrun.html | 424 +------- api/classes/coreproperties.html | 10 +- api/classes/created.html | 10 +- api/classes/creator.html | 10 +- api/classes/dashdotdotheavyunderline.html | 10 +- api/classes/dashdotheavyunderline.html | 10 +- api/classes/dashlongheavyunderline.html | 10 +- api/classes/dashlongunderline.html | 10 +- api/classes/dashunderline.html | 10 +- api/classes/datecomponent.html | 10 +- api/classes/default.html | 10 +- api/classes/defaultattributes.html | 8 +- api/classes/defaultstylesfactory.html | 2 +- api/classes/description.html | 10 +- api/classes/docgridattributes.html | 8 +- api/classes/docproperties.html | 10 +- api/classes/docpropertiesattributes.html | 8 +- api/classes/document.html | 205 +--- api/classes/documentattributes.html | 8 +- api/classes/documentdefaults.html | 10 +- api/classes/documentgrid.html | 10 +- api/classes/dotdashunderline.html | 10 +- api/classes/dotdotdashunderline.html | 10 +- api/classes/dottedheavyunderline.html | 10 +- api/classes/dottedunderline.html | 10 +- api/classes/doublestrike.html | 10 +- api/classes/doubleunderline.html | 10 +- api/classes/drawing.html | 12 +- api/classes/effectextent.html | 10 +- api/classes/effectextentattributes.html | 8 +- api/classes/emboss.html | 10 +- api/classes/end.html | 10 +- api/classes/extent.html | 12 +- api/classes/extentattributes.html | 8 +- api/classes/extents.html | 12 +- api/classes/extentsattributes.html | 8 +- api/classes/externalstylesfactory.html | 2 +- api/classes/fieldinstruction.html | 10 +- api/classes/file.html | 478 +-------- api/classes/footer.html | 172 ++-- api/classes/footerattributes.html | 8 +- api/classes/footerreference.html | 10 +- api/classes/footerreferenceattributes.html | 8 +- api/classes/footerwrapper.html | 183 +--- api/classes/footnote.html | 64 +- api/classes/footnoteattributes.html | 8 +- api/classes/footnoteref.html | 10 +- api/classes/footnotereference.html | 10 +- api/classes/footnotereferencerun.html | 424 +------- .../footnotereferencerunattributes.html | 8 +- api/classes/footnotereferencestyle.html | 36 +- api/classes/footnoterefrun.html | 424 +------- api/classes/footnotes.html | 12 +- api/classes/footnotesattributes.html | 8 +- api/classes/footnotetext.html | 88 +- api/classes/footnotetextchar.html | 36 +- api/classes/form.html | 12 +- api/classes/formatter.html | 2 +- api/classes/graphic.html | 12 +- api/classes/graphicdata.html | 12 +- api/classes/graphicdataattributes.html | 8 +- api/classes/graphicframelockattributes.html | 8 +- api/classes/graphicframelocks.html | 10 +- api/classes/graphicframeproperties.html | 10 +- api/classes/gridcol.html | 10 +- api/classes/gridspan.html | 10 +- api/classes/header.html | 172 ++-- api/classes/headerattributes.html | 8 +- api/classes/headerreference.html | 14 +- api/classes/headerreferenceattributes.html | 8 +- api/classes/headerwrapper.html | 183 +--- api/classes/heading1style.html | 88 +- api/classes/heading2style.html | 88 +- api/classes/heading3style.html | 88 +- api/classes/heading4style.html | 88 +- api/classes/heading5style.html | 88 +- api/classes/heading6style.html | 88 +- api/classes/headingstyle.html | 88 +- api/classes/highlight.html | 10 +- api/classes/highlightcomplexscript.html | 10 +- api/classes/horizontalposition.html | 10 +- api/classes/hyperlink.html | 14 +- api/classes/hyperlinkattributes.html | 8 +- api/classes/hyperlinkstyle.html | 36 +- api/classes/ignoreifemptyxmlcomponent.html | 16 +- api/classes/image.html | 44 +- api/classes/imageparagraph.html | 925 +----------------- api/classes/imagereplacer.html | 4 +- api/classes/importdotx.html | 2 +- .../importedrootelementattributes.html | 10 +- api/classes/importedxmlcomponent.html | 14 +- api/classes/imprint.html | 10 +- api/classes/indent.html | 10 +- api/classes/initializablexmlcomponent.html | 10 +- api/classes/inline.html | 14 +- api/classes/inlineattributes.html | 8 +- api/classes/italics.html | 10 +- api/classes/italicscomplexscript.html | 10 +- api/classes/keeplines.html | 10 +- api/classes/keepnext.html | 10 +- api/classes/keywords.html | 10 +- api/classes/lastmodifiedby.html | 10 +- api/classes/leftcellmargin.html | 10 +- api/classes/lefttabstop.html | 10 +- api/classes/level.html | 70 +- api/classes/levelbase.html | 70 +- api/classes/levelforoverride.html | 70 +- api/classes/leveloverride.html | 12 +- api/classes/linenumberattributes.html | 8 +- api/classes/linenumbertype.html | 10 +- api/classes/link.html | 10 +- api/classes/listparagraph.html | 88 +- api/classes/maxrighttabstop.html | 10 +- api/classes/media.html | 16 +- api/classes/modified.html | 10 +- api/classes/multileveltype.html | 10 +- api/classes/name.html | 10 +- api/classes/next.html | 10 +- api/classes/nonvisualpicproperties.html | 10 +- api/classes/nonvisualproperties.html | 10 +- .../nonvisualpropertiesattributes.html | 8 +- api/classes/num.html | 14 +- api/classes/numbering.html | 14 +- api/classes/numberofpages.html | 10 +- api/classes/numberproperties.html | 10 +- api/classes/offset.html | 10 +- api/classes/offsetattributes.html | 8 +- api/classes/outlinelevel.html | 18 +- api/classes/override.html | 10 +- api/classes/overrideattributes.html | 8 +- api/classes/packer.html | 8 +- api/classes/page.html | 10 +- api/classes/pageborders.html | 10 +- api/classes/pagebreak.html | 424 +------- api/classes/pagebreakbefore.html | 10 +- api/classes/pagemargin.html | 10 +- api/classes/pagemarginattributes.html | 8 +- api/classes/pagenumbertype.html | 10 +- api/classes/pagenumbertypeattributes.html | 8 +- api/classes/pagesize.html | 10 +- api/classes/pagesizeattributes.html | 8 +- api/classes/paragraph.html | 862 +--------------- api/classes/paragraphproperties.html | 63 +- api/classes/paragraphpropertiesdefaults.html | 10 +- api/classes/paragraphstyle.html | 92 +- api/classes/pic.html | 12 +- api/classes/picattributes.html | 8 +- api/classes/piclocks.html | 10 +- api/classes/piclocksattributes.html | 8 +- api/classes/picturerun.html | 458 +-------- api/classes/positionoffset.html | 10 +- api/classes/preferredtablewidth.html | 10 +- api/classes/presetgeometry.html | 10 +- api/classes/presetgeometryattributes.html | 8 +- api/classes/quickformat.html | 10 +- api/classes/relationship.html | 10 +- api/classes/relationshipattributes.html | 8 +- api/classes/relationships.html | 16 +- api/classes/relationshipsattributes.html | 8 +- api/classes/revision.html | 10 +- api/classes/rightcellmargin.html | 10 +- api/classes/righttabstop.html | 10 +- api/classes/righttoleft.html | 10 +- api/classes/rsid.html | 10 +- api/classes/run.html | 416 +------- api/classes/runfonts.html | 10 +- api/classes/runproperties.html | 12 +- api/classes/runpropertiesdefaults.html | 14 +- api/classes/sectionproperties.html | 12 +- api/classes/semihidden.html | 10 +- api/classes/separate.html | 10 +- api/classes/seperator.html | 10 +- api/classes/seperatorrun.html | 424 +------- api/classes/sequentialidentifier.html | 424 +------- .../sequentialidentifierinstruction.html | 10 +- api/classes/settings.html | 14 +- api/classes/settingsattributes.html | 8 +- api/classes/{shadow.html => shading.html} | 44 +- api/classes/shadowcomplexscript.html | 10 +- api/classes/shapeproperties.html | 12 +- api/classes/shapepropertiesattributes.html | 8 +- api/classes/simplepos.html | 10 +- api/classes/singleunderline.html | 10 +- api/classes/size.html | 10 +- api/classes/sizecomplexscript.html | 10 +- api/classes/smallcaps.html | 10 +- api/classes/sourcerectangle.html | 10 +- api/classes/spacing.html | 10 +- api/classes/stretch.html | 10 +- api/classes/strike.html | 10 +- api/classes/structureddocumenttagcontent.html | 10 +- .../structureddocumenttagproperties.html | 10 +- api/classes/style.html | 29 +- api/classes/stylelevel.html | 6 +- api/classes/styles.html | 18 +- api/classes/subject.html | 10 +- api/classes/subscript.html | 10 +- api/classes/superscript.html | 10 +- api/classes/tab.html | 10 +- api/classes/tabattributes.html | 8 +- api/classes/table.html | 37 +- api/classes/tableborders.html | 10 +- api/classes/tablecell.html | 132 +-- api/classes/tablecellborders.html | 22 +- api/classes/tablecellmargin.html | 18 +- api/classes/tablecellproperties.html | 24 +- api/classes/tablecellwidth.html | 10 +- api/classes/tablecolumn.html | 6 +- api/classes/tablefloatoptionsattributes.html | 8 +- api/classes/tablefloatproperties.html | 10 +- api/classes/tablegrid.html | 10 +- api/classes/tableheader.html | 10 +- api/classes/tablelayout.html | 10 +- api/classes/tableofcontents.html | 10 +- api/classes/tableproperties.html | 40 +- api/classes/tablerow.html | 22 +- api/classes/tablerowheight.html | 10 +- api/classes/tablerowheightattributes.html | 8 +- api/classes/tablerowproperties.html | 16 +- api/classes/tableshading.html | 10 +- api/classes/tabstop.html | 10 +- api/classes/tabstopitem.html | 10 +- api/classes/text.html | 10 +- api/classes/textrun.html | 428 +------- api/classes/thematicbreak.html | 10 +- api/classes/thickunderline.html | 10 +- api/classes/title.html | 10 +- api/classes/titlepage.html | 10 +- api/classes/titlepageattributes.html | 8 +- api/classes/titlestyle.html | 88 +- api/classes/topcellmargin.html | 10 +- api/classes/uipriority.html | 10 +- api/classes/underline.html | 10 +- api/classes/unhidewhenused.html | 10 +- api/classes/updatefields.html | 10 +- api/classes/updatefieldsattributes.html | 8 +- api/classes/valign.html | 10 +- api/classes/verticalalign.html | 16 +- api/classes/verticalposition.html | 10 +- api/classes/vmerge.html | 10 +- api/classes/waveunderline.html | 10 +- api/classes/wavydoubleunderline.html | 10 +- api/classes/wavyheavyunderline.html | 10 +- api/classes/wordsunderline.html | 10 +- api/classes/wrapnone.html | 10 +- api/classes/wrapsquare.html | 10 +- api/classes/wraptight.html | 10 +- api/classes/wraptopandbottom.html | 10 +- api/classes/xmlattributecomponent.html | 23 +- api/classes/xmlcomponent.html | 262 ++--- ...ignmentoptions.html => alignmenttype.html} | 64 +- api/enums/borderstyle.html | 54 +- api/enums/footerreferencetype.html | 6 +- api/enums/footnotetype.html | 4 +- api/enums/headerreferencetype.html | 6 +- api/enums/headinglevel.html | 271 +++++ api/enums/heightrule.html | 6 +- api/enums/horizontalpositionalign.html | 10 +- api/enums/horizontalpositionrelativefrom.html | 16 +- api/enums/leadertype.html | 10 +- api/enums/levelsuffix.html | 6 +- api/enums/linenumberrestartformat.html | 6 +- api/enums/pageborderdisplay.html | 6 +- api/enums/pageborderoffsetfrom.html | 4 +- api/enums/pageborderzorder.html | 4 +- api/enums/pagenumberformat.html | 24 +- api/enums/pageorientation.html | 4 +- api/enums/relativehorizontalposition.html | 10 +- api/enums/relativeverticalposition.html | 12 +- api/enums/shadingtype.html | 74 +- api/enums/spacetype.html | 4 +- api/enums/tableanchortype.html | 6 +- api/enums/tablelayouttype.html | 4 +- api/enums/tabvalue.html | 18 +- api/enums/targetmodetype.html | 2 +- api/enums/textwrappingside.html | 8 +- api/enums/textwrappingtype.html | 8 +- api/enums/underlinetype.html | 411 ++++++++ api/enums/verticalpositionalign.html | 10 +- api/enums/verticalpositionrelativefrom.html | 16 +- api/enums/vmergetype.html | 4 +- api/enums/widthtype.html | 8 +- api/globals.html | 68 +- api/index.html | 37 +- api/interfaces/ianchorattributes.html | 20 +- api/interfaces/iapppropertiesattributes.html | 4 +- api/interfaces/iattributesproperties.html | 40 +- .../ibookmarkendattributesproperties.html | 2 +- .../ibookmarkstartattributesproperties.html | 4 +- .../iborderattributesproperties.html | 237 +++++ api/interfaces/iborderoptions.html | 237 +++++ api/interfaces/icellmarginproperties.html | 4 +- api/interfaces/icolumnsattributes.html | 4 +- api/interfaces/icontenttypeattributes.html | 2 +- api/interfaces/idefaultattributes.html | 4 +- api/interfaces/idistance.html | 8 +- .../idocgridattributesproperties.html | 2 +- api/interfaces/idocpropertiesattributes.html | 6 +- .../idocumentattributesproperties.html | 46 +- api/interfaces/idocumentfooter.html | 4 +- api/interfaces/idocumentheader.html | 4 +- api/interfaces/idocumenttemplate.html | 12 +- api/interfaces/idrawingoptions.html | 2 +- api/interfaces/ieffectextentattributes.html | 8 +- api/interfaces/iextentattributes.html | 4 +- api/interfaces/iextentsattributes.html | 4 +- api/interfaces/ifileproperties.html | 2 +- api/interfaces/ifloating.html | 16 +- .../ifooterattributesproperties.html | 44 +- api/interfaces/ifooteroptions.html | 4 +- .../ifooterreferenceattributes.html | 4 +- .../ifootnoteattributesproperties.html | 4 +- ...tnotereferencerunattributesproperties.html | 2 +- .../ifootnotesattributesproperties.html | 34 +- api/interfaces/igraphicdataattributes.html | 2 +- .../igraphicframelockattributes.html | 4 +- .../iheaderattributesproperties.html | 66 +- api/interfaces/iheaderfootergroup.html | 6 +- api/interfaces/iheaderoptions.html | 26 +- .../iheaderreferenceattributes.html | 6 +- api/interfaces/iheaderreferenceoptions.html | 209 ++++ .../ihorizontalpositionoptions.html | 6 +- .../ihyperlinkattributesproperties.html | 6 +- .../iindentattributesproperties.html | 10 +- api/interfaces/iinlineattributes.html | 8 +- api/interfaces/ilinenumberattributes.html | 8 +- api/interfaces/imargins.html | 8 +- api/interfaces/imediadata.html | 8 +- api/interfaces/imediadatadimensions.html | 4 +- .../inonvisualpropertiesattributes.html | 6 +- api/interfaces/ioffsetattributes.html | 4 +- api/interfaces/ioverrideattributes.html | 4 +- api/interfaces/ipageborderattributes.html | 6 +- api/interfaces/ipageborderconfiguration.html | 8 +- api/interfaces/ipagebordersoptions.html | 10 +- api/interfaces/ipagemarginattributes.html | 16 +- api/interfaces/ipagenumbertypeattributes.html | 4 +- api/interfaces/ipagesizeattributes.html | 6 +- api/interfaces/iparagraphoptions.html | 433 ++++++++ api/interfaces/ipicattributes.html | 2 +- api/interfaces/ipiclocksattributes.html | 4 +- api/interfaces/ipresetgeometryattributes.html | 2 +- api/interfaces/ipropertiesoptions.html | 16 +- .../irelationshipattributesproperties.html | 8 +- .../irelationshipsattributesproperties.html | 2 +- api/interfaces/irunoptions.html | 410 ++++++++ api/interfaces/isectionoptions.html | 265 +++++ .../isettingsattributesproperties.html | 34 +- .../ishapepropertiesattributes.html | 2 +- api/interfaces/ispacingproperties.html | 8 +- api/interfaces/istyleattributes.html | 8 +- api/interfaces/itablecellmarginoptions.html | 8 +- api/interfaces/itablecelloptions.html | 195 ++++ api/interfaces/itablefloatoptions.html | 20 +- api/interfaces/itableofcontentsoptions.html | 32 +- api/interfaces/itableoptions.html | 28 +- .../itableshadingattributesproperties.html | 6 +- api/interfaces/itextrunoptions.html | 440 +++++++++ api/interfaces/itextwrapping.html | 6 +- .../iupdatefieldsattributesproperties.html | 2 +- api/interfaces/iverticalpositionoptions.html | 6 +- api/interfaces/ixmlableobject.html | 2 +- contribution-guidelines.md | 34 +- usage/bullet-points.md | 14 +- usage/document.md | 8 +- usage/headers-and-footers.md | 10 +- usage/images.md | 43 +- usage/numbering.md | 6 +- usage/packers.md | 16 +- usage/paragraph.md | 247 ++++- usage/sections.md | 21 + usage/styling-with-js.md | 12 +- usage/styling-with-xml.md | 8 +- usage/tab-stops.md | 22 +- usage/table-of-contents.md | 18 +- usage/tables.md | 59 +- usage/text.md | 75 +- 424 files changed, 7127 insertions(+), 9994 deletions(-) create mode 100644 api/classes/borderattributes.html rename api/classes/{shadow.html => shading.html} (88%) rename api/enums/{alignmentoptions.html => alignmenttype.html} (82%) create mode 100644 api/enums/headinglevel.html create mode 100644 api/enums/underlinetype.html create mode 100644 api/interfaces/iborderattributesproperties.html create mode 100644 api/interfaces/iborderoptions.html create mode 100644 api/interfaces/iheaderreferenceoptions.html create mode 100644 api/interfaces/iparagraphoptions.html create mode 100644 api/interfaces/irunoptions.html create mode 100644 api/interfaces/isectionoptions.html create mode 100644 api/interfaces/itablecelloptions.html create mode 100644 api/interfaces/itextrunoptions.html create mode 100644 usage/sections.md diff --git a/README.md b/README.md index fd5ad9ecd9..e8da69f267 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- clippy the assistant + clippy the assistant

@@ -18,33 +18,51 @@ npm install --save docx Then you can `require` or `import` as usual: -```js -let docx = require("docx"); +```ts +const docx = require("docx"); ``` -```js +```ts import * as docx from "docx"; +// or +import { ... } from "docx"; ``` ## Basic Usage -```js -var fs = require("fs"); -var docx = require("docx"); +```ts +import * as fs from "fs"; +import { Document, Packer, Paragraph, TextRun } from "docx"; // Create document -var doc = new docx.Document(); +const doc = new Document(); -// Add some content in the document -var paragraph = new docx.Paragraph("Some cool text here."); -// Add more text into the paragraph if you wish -paragraph.addRun(new docx.TextRun("Lorem Ipsum Foo Bar")); -doc.addParagraph(paragraph); +// Documents contain sections, you can have multiple sections per document, go here to learn more about sections +// This simple example will only contain one section +doc.addSection({ + properties: {}, + children: [ + new Paragraph({ + children: [ + new TextRun("Hello World"), + new TextRun({ + text: "Foo Bar", + bold: true, + }), + new TextRun({ + text: "Github is the best", + bold: true, + }).tab(), + ], + }), + ], +}); // Used to export the file into a .docx file -var packer = new docx.Packer(); +const packer = new Packer(); + packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My First Document.docx", buffer); + fs.writeFileSync("My Document.docx", buffer); }); // Done! A file called 'My First Document.docx' will be in your file system. diff --git a/_sidebar.md b/_sidebar.md index 558029dbf6..9e329b6448 100644 --- a/_sidebar.md +++ b/_sidebar.md @@ -9,6 +9,7 @@ * Usage * [Document](usage/document.md) + * [Sections](usage/sections.md) * [Paragraph](usage/paragraph.md) * [Text](usage/text.md) * [Image](usage/images.md) diff --git a/api/classes/abstractnumbering.html b/api/classes/abstractnumbering.html index 0037035715..78499040f8 100644 --- a/api/classes/abstractnumbering.html +++ b/api/classes/abstractnumbering.html @@ -125,7 +125,7 @@

Parameters

@@ -147,7 +147,7 @@
id: number
@@ -165,7 +165,7 @@

Returns boolean

@@ -186,7 +186,7 @@

Parameters

@@ -209,7 +209,7 @@
  • Parameters

    @@ -232,7 +232,7 @@
  • Parameters

    @@ -265,7 +265,7 @@

    Returns void

    @@ -284,7 +284,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/adjustmentvalues.html b/api/classes/adjustmentvalues.html index 5441173682..7ccfac29d5 100644 --- a/api/classes/adjustmentvalues.html +++ b/api/classes/adjustmentvalues.html @@ -117,7 +117,7 @@

    Returns AdjustmentValues

    @@ -138,7 +138,7 @@

    Returns boolean

    @@ -159,7 +159,7 @@

    Parameters

    @@ -183,7 +183,7 @@

    Returns void

    @@ -202,7 +202,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/alias.html b/api/classes/alias.html index c19a81931b..7f4637e7ac 100644 --- a/api/classes/alias.html +++ b/api/classes/alias.html @@ -117,7 +117,7 @@

    Parameters

    @@ -144,7 +144,7 @@

    Returns boolean

    @@ -165,7 +165,7 @@

    Parameters

    @@ -189,7 +189,7 @@

    Returns void

    @@ -208,7 +208,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/align.html b/api/classes/align.html index 697b82a7c7..33e419bca6 100644 --- a/api/classes/align.html +++ b/api/classes/align.html @@ -117,7 +117,7 @@

    Parameters

    @@ -144,7 +144,7 @@

    Returns boolean

    @@ -165,7 +165,7 @@

    Parameters

    @@ -189,7 +189,7 @@

    Returns void

    @@ -208,7 +208,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/alignment.html b/api/classes/alignment.html index 6eb6b372de..e1fbfa2922 100644 --- a/api/classes/alignment.html +++ b/api/classes/alignment.html @@ -110,20 +110,20 @@

    constructor

    -
    +

    Accessors

    @@ -100,7 +99,6 @@
  • addChildElement
  • addSection
  • delete
  • -
  • getParagraphs
  • getTablesOfContents
  • prepForXml
  • push
  • @@ -115,46 +113,23 @@

    constructor

    -
    +

    Accessors

    -
    - -

    DefaultSection

    - - -

    IsDeleted

    @@ -166,7 +141,7 @@

    Returns boolean

    @@ -187,7 +162,7 @@

    Parameters

    @@ -204,13 +179,13 @@

    addSection

    -
    - -

    getParagraphs

    - - -

    getTablesOfContents

    @@ -282,7 +240,7 @@
  • Returns TableOfContents[]

    @@ -300,7 +258,7 @@

    Returns IXmlableObject @@ -320,7 +278,7 @@
  • Parameters

    @@ -353,9 +311,6 @@
  • constructor
  • -
  • - DefaultSection -
  • IsDeleted
  • @@ -368,9 +323,6 @@
  • delete
  • -
  • - getParagraphs -
  • getTablesOfContents
  • diff --git a/api/classes/bold.html b/api/classes/bold.html index 1f7123088e..4009785ab2 100644 --- a/api/classes/bold.html +++ b/api/classes/bold.html @@ -117,7 +117,7 @@

    Returns Bold

    @@ -138,7 +138,7 @@

    Returns boolean

    @@ -159,7 +159,7 @@

    Parameters

    @@ -183,7 +183,7 @@

    Returns void

    @@ -202,7 +202,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/boldcomplexscript.html b/api/classes/boldcomplexscript.html index 0db4929855..744413762d 100644 --- a/api/classes/boldcomplexscript.html +++ b/api/classes/boldcomplexscript.html @@ -117,7 +117,7 @@

    Returns BoldComplexScript

    @@ -138,7 +138,7 @@

    Returns boolean

    @@ -159,7 +159,7 @@

    Parameters

    @@ -183,7 +183,7 @@

    Returns void

    @@ -202,7 +202,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/bookmark.html b/api/classes/bookmark.html index 513e84f7f5..961ba1d026 100644 --- a/api/classes/bookmark.html +++ b/api/classes/bookmark.html @@ -106,7 +106,7 @@
  • Parameters

    @@ -134,7 +134,7 @@
  • @@ -144,7 +144,7 @@
    linkId: number
    @@ -154,7 +154,7 @@
    @@ -164,7 +164,7 @@
    text: TextRun
    diff --git a/api/classes/bookmarkend.html b/api/classes/bookmarkend.html index cd24549731..f9cf6d0b04 100644 --- a/api/classes/bookmarkend.html +++ b/api/classes/bookmarkend.html @@ -123,7 +123,7 @@

    Parameters

    @@ -145,7 +145,7 @@
    linkId: number
    @@ -163,7 +163,7 @@

    Returns boolean

    @@ -184,7 +184,7 @@

    Parameters

    @@ -208,7 +208,7 @@

    Returns void

    @@ -227,7 +227,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/bookmarkendattributes.html b/api/classes/bookmarkendattributes.html index e3ac6dfec2..d95a7df686 100644 --- a/api/classes/bookmarkendattributes.html +++ b/api/classes/bookmarkendattributes.html @@ -117,7 +117,7 @@

    Inherited from XmlAttributeComponent.constructor

    Overrides BaseXmlComponent.constructor

    Parameters

    @@ -144,7 +144,7 @@

    Returns boolean

    @@ -166,7 +166,7 @@

    Inherited from XmlAttributeComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject

    @@ -184,7 +184,7 @@

    Parameters

    diff --git a/api/classes/bookmarkstart.html b/api/classes/bookmarkstart.html index 8becc23d86..8c090bc525 100644 --- a/api/classes/bookmarkstart.html +++ b/api/classes/bookmarkstart.html @@ -123,7 +123,7 @@

    Parameters

    @@ -148,7 +148,7 @@
    linkId: number
    @@ -166,7 +166,7 @@

    Returns boolean

    @@ -187,7 +187,7 @@

    Parameters

    @@ -211,7 +211,7 @@

    Returns void

    @@ -230,7 +230,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/bookmarkstartattributes.html b/api/classes/bookmarkstartattributes.html index 6d1d63ade5..6dd72bf02f 100644 --- a/api/classes/bookmarkstartattributes.html +++ b/api/classes/bookmarkstartattributes.html @@ -117,7 +117,7 @@

    Inherited from XmlAttributeComponent.constructor

    Overrides BaseXmlComponent.constructor

    Parameters

    @@ -144,7 +144,7 @@

    Returns boolean

    @@ -166,7 +166,7 @@

    Inherited from XmlAttributeComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject

    @@ -184,7 +184,7 @@

    Parameters

    diff --git a/api/classes/border.html b/api/classes/border.html index 5754cfeb93..f334da7424 100644 --- a/api/classes/border.html +++ b/api/classes/border.html @@ -93,14 +93,10 @@
  • IsDeleted
  • -
    +

    Methods

    @@ -114,16 +110,22 @@

    constructor

    @@ -142,7 +144,7 @@

    Returns boolean

    @@ -150,40 +152,8 @@
    -
    +

    Methods

    -
    - -

    addBottomBorder

    -
      -
    • addBottomBorder(color?: string, space?: string, value?: string, size?: string): XmlComponent
    • -
    -
      -
    • - -

      Parameters

      -
        -
      • -
        Default value color: string = "auto"
        -
      • -
      • -
        Default value space: string = "1"
        -
      • -
      • -
        Default value value: string = "single"
        -
      • -
      • -
        Default value size: string = "6"
        -
      • -
      -

      Returns XmlComponent

      -
    • -
    -

    addChildElement

    @@ -195,7 +165,7 @@

    Parameters

    @@ -208,102 +178,6 @@
    -
    - -

    addLeftBorder

    -
      -
    • addLeftBorder(color?: string, space?: string, value?: string, size?: string): XmlComponent
    • -
    -
      -
    • - -

      Parameters

      -
        -
      • -
        Default value color: string = "auto"
        -
      • -
      • -
        Default value space: string = "1"
        -
      • -
      • -
        Default value value: string = "single"
        -
      • -
      • -
        Default value size: string = "6"
        -
      • -
      -

      Returns XmlComponent

      -
    • -
    -
    -
    - -

    addRightBorder

    -
      -
    • addRightBorder(color?: string, space?: string, value?: string, size?: string): XmlComponent
    • -
    -
      -
    • - -

      Parameters

      -
        -
      • -
        Default value color: string = "auto"
        -
      • -
      • -
        Default value space: string = "1"
        -
      • -
      • -
        Default value value: string = "single"
        -
      • -
      • -
        Default value size: string = "6"
        -
      • -
      -

      Returns XmlComponent

      -
    • -
    -
    -
    - -

    addTopBorder

    -
      -
    • addTopBorder(color?: string, space?: string, value?: string, size?: string): XmlComponent
    • -
    -
      -
    • - -

      Parameters

      -
        -
      • -
        Default value color: string = "auto"
        -
      • -
      • -
        Default value space: string = "1"
        -
      • -
      • -
        Default value value: string = "single"
        -
      • -
      • -
        Default value size: string = "6"
        -
      • -
      -

      Returns XmlComponent

      -
    • -
    -

    delete

    @@ -315,7 +189,7 @@

    Returns void

    @@ -334,7 +208,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject @@ -367,21 +241,9 @@
  • IsDeleted
  • -
  • - addBottomBorder -
  • addChildElement
  • -
  • - addLeftBorder -
  • -
  • - addRightBorder -
  • -
  • - addTopBorder -
  • delete
  • diff --git a/api/classes/borderattributes.html b/api/classes/borderattributes.html new file mode 100644 index 0000000000..483226d6ec --- /dev/null +++ b/api/classes/borderattributes.html @@ -0,0 +1,304 @@ + + + + + + BorderAttributes | docx + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
    • +
    • Public/Protected
    • +
    • All
    • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class BorderAttributes

    +
    +
    +
    +
    +
    +
    +
    +

    Hierarchy

    + +
    +
    +

    Index

    +
    +
    +
    +

    Constructors

    + +
    +
    +

    Accessors

    + +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Constructors

    +
    + +

    constructor

    + + +
    +
    +
    +

    Accessors

    +
    + +

    IsDeleted

    +
      +
    • get IsDeleted(): boolean
    • +
    + +
    +
    +
    +

    Methods

    +
    + +

    prepForXml

    + + +
    +
    + +

    set

    + + +
    +
    +
    + +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Module
    • +
    • Object literal
    • +
    • Variable
    • +
    • Function
    • +
    • Function with type parameter
    • +
    • Index signature
    • +
    • Type alias
    • +
    +
      +
    • Enumeration
    • +
    • Enumeration member
    • +
    • Property
    • +
    • Method
    • +
    +
      +
    • Interface
    • +
    • Interface with type parameter
    • +
    • Constructor
    • +
    • Property
    • +
    • Method
    • +
    • Index signature
    • +
    +
      +
    • Class
    • +
    • Class with type parameter
    • +
    • Constructor
    • +
    • Property
    • +
    • Method
    • +
    • Accessor
    • +
    • Index signature
    • +
    +
      +
    • Inherited constructor
    • +
    • Inherited property
    • +
    • Inherited method
    • +
    • Inherited accessor
    • +
    +
      +
    • Protected property
    • +
    • Protected method
    • +
    • Protected accessor
    • +
    +
      +
    • Private property
    • +
    • Private method
    • +
    • Private accessor
    • +
    +
      +
    • Static property
    • +
    • Static method
    • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + + \ No newline at end of file diff --git a/api/classes/bottomcellmargin.html b/api/classes/bottomcellmargin.html index 5b59b39681..e77e435e65 100644 --- a/api/classes/bottomcellmargin.html +++ b/api/classes/bottomcellmargin.html @@ -117,7 +117,7 @@

    Parameters

    @@ -144,7 +144,7 @@

    Returns boolean

    @@ -165,7 +165,7 @@

    Parameters

    @@ -189,7 +189,7 @@

    Returns void

    @@ -208,7 +208,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/break.html b/api/classes/break.html index 5249191ab1..fd3a62151c 100644 --- a/api/classes/break.html +++ b/api/classes/break.html @@ -117,7 +117,7 @@

    Returns Break

    @@ -138,7 +138,7 @@

    Returns boolean

    @@ -159,7 +159,7 @@

    Parameters

    @@ -183,7 +183,7 @@

    Returns void

    @@ -202,7 +202,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/cantsplit.html b/api/classes/cantsplit.html index 005bed60f4..fa3b0644f6 100644 --- a/api/classes/cantsplit.html +++ b/api/classes/cantsplit.html @@ -117,7 +117,7 @@

    Returns CantSplit

    @@ -138,7 +138,7 @@

    Returns boolean

    @@ -159,7 +159,7 @@

    Parameters

    @@ -183,7 +183,7 @@

    Returns void

    @@ -202,7 +202,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/caps.html b/api/classes/caps.html index 42fc5bda1f..e335e38dca 100644 --- a/api/classes/caps.html +++ b/api/classes/caps.html @@ -120,7 +120,7 @@

    Returns Caps

    @@ -142,7 +142,7 @@

    Inherited from BaseXmlComponent.IsDeleted

    Overrides BaseXmlComponent.IsDeleted

    Returns boolean

    @@ -164,7 +164,7 @@

    Inherited from XmlComponent.addChildElement

    Overrides XmlComponent.addChildElement

    Parameters

    @@ -189,7 +189,7 @@

    Inherited from XmlComponent.delete

    Overrides XmlComponent.delete

    Returns void

    @@ -208,7 +208,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/centertabstop.html b/api/classes/centertabstop.html index fbbbfb05ad..3fedfac18d 100644 --- a/api/classes/centertabstop.html +++ b/api/classes/centertabstop.html @@ -117,7 +117,7 @@

    Parameters

    @@ -147,7 +147,7 @@

    Returns boolean

    @@ -168,7 +168,7 @@

    Parameters

    @@ -192,7 +192,7 @@

    Returns void

    @@ -211,7 +211,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/characterspacing.html b/api/classes/characterspacing.html index 5387a2224d..a3fa99a9ce 100644 --- a/api/classes/characterspacing.html +++ b/api/classes/characterspacing.html @@ -117,7 +117,7 @@

    Parameters

    @@ -144,7 +144,7 @@

    Returns boolean

    @@ -165,7 +165,7 @@

    Parameters

    @@ -189,7 +189,7 @@

    Returns void

    @@ -208,7 +208,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/characterstyle.html b/api/classes/characterstyle.html index 615208c80b..6b64cad2fe 100644 --- a/api/classes/characterstyle.html +++ b/api/classes/characterstyle.html @@ -68,7 +68,7 @@

    Hierarchy

    @@ -137,7 +121,7 @@

    Returns ContinuationSeperatorRun

    @@ -158,7 +142,7 @@

    Returns boolean

    @@ -179,7 +163,7 @@

    Parameters

    @@ -192,42 +176,6 @@
    -
    - -

    allCaps

    -
      -
    • allCaps(): Run
    • -
    - -
    -
    - -

    bold

    -
      -
    • bold(): Run
    • -
    - -

    break

    @@ -239,37 +187,13 @@

    Returns Run

    -
    - -

    color

    -
      -
    • color(color: string): Run
    • -
    - -

    delete

    @@ -281,100 +205,13 @@

    Returns void

    -
    - -

    doubleStrike

    -
      -
    • doubleStrike(): Run
    • -
    - -
    -
    - -

    font

    -
      -
    • font(fontName: string, hint?: string | undefined): Run
    • -
    - -
    -
    - -

    highlight

    -
      -
    • highlight(color: string): Run
    • -
    - -
    -
    - -

    italics

    -
      -
    • italics(): Run
    • -
    - -

    numberOfTotalPages

    @@ -386,7 +223,7 @@

    Returns Run

    @@ -404,7 +241,7 @@

    Returns Run

    @@ -423,7 +260,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject @@ -433,174 +270,6 @@

    -
    - -

    rightToLeft

    -
      -
    • rightToLeft(): Run
    • -
    - -
    -
    - -

    shadow

    -
      -
    • shadow(value: string, fill: string, color: string): Run
    • -
    - -
    -
    - -

    size

    -
      -
    • size(size: number): Run
    • -
    - -
    -
    - -

    smallCaps

    -
      -
    • smallCaps(): Run
    • -
    - -
    -
    - -

    strike

    -
      -
    • strike(): Run
    • -
    - -
    -
    - -

    style

    -
      -
    • style(styleId: string): Run
    • -
    - -
    -
    - -

    subScript

    -
      -
    • subScript(): Run
    • -
    - -
    -
    - -

    superScript

    -
      -
    • superScript(): Run
    • -
    - -

    tab

    @@ -612,40 +281,13 @@

    Returns Run

    -
    - -

    underline

    -
      -
    • underline(underlineType?: undefined | string, color?: undefined | string): Run
    • -
    - -
    @@ -117,7 +113,7 @@
  • Parameters

    @@ -149,7 +145,7 @@
  • Returns Footer

    @@ -166,7 +162,7 @@
  • Returns Media

    @@ -183,7 +179,7 @@
  • Returns Relationships

    @@ -193,6 +189,29 @@

    Methods

    +
    + +

    add

    + + +

    addChildElement

    @@ -203,7 +222,7 @@
  • Parameters

    @@ -226,7 +245,7 @@
  • Parameters

    @@ -239,130 +258,6 @@
  • -
    - -

    addParagraph

    -
      -
    • addParagraph(paragraph: Paragraph): void
    • -
    - -
    -
    - -

    addTable

    -
      -
    • addTable(table: Table): void
    • -
    - -
    -
    - -

    createImage

    -
      -
    • createImage(image: Buffer | string | Uint8Array | ArrayBuffer, width?: undefined | number, height?: undefined | number): void
    • -
    -
      -
    • - -

      Parameters

      -
        -
      • -
        image: Buffer | string | Uint8Array | ArrayBuffer
        -
      • -
      • -
        Optional width: undefined | number
        -
      • -
      • -
        Optional height: undefined | number
        -
      • -
      -

      Returns void

      -
    • -
    -
    -
    - -

    createParagraph

    -
      -
    • createParagraph(text?: undefined | string): Paragraph
    • -
    - -
    -
    - -

    createTable

    -
      -
    • createTable(rows: number, cols: number): Table
    • -
    - -
  • Relationships
  • +
  • + add +
  • addChildElement
  • addImage
  • -
  • - addParagraph -
  • -
  • - addTable -
  • -
  • - createImage -
  • -
  • - createParagraph -
  • -
  • - createTable -
  • diff --git a/api/classes/footnote.html b/api/classes/footnote.html index 1048be1844..0cbcafc0fe 100644 --- a/api/classes/footnote.html +++ b/api/classes/footnote.html @@ -96,8 +96,8 @@

    Methods

    @@ -118,7 +118,7 @@

    Parameters

    @@ -148,7 +148,7 @@

    Returns boolean

    @@ -158,6 +158,29 @@

    Methods

    +
    + +

    add

    + + +

    addChildElement

    @@ -169,7 +192,7 @@

    Parameters

    @@ -182,29 +205,6 @@
    -
    - -

    addParagraph

    -
      -
    • addParagraph(paragraph: Paragraph): void
    • -
    - -

    delete

    @@ -216,7 +216,7 @@

    Returns void

    @@ -235,7 +235,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject @@ -268,12 +268,12 @@
  • IsDeleted
  • +
  • + add +
  • addChildElement
  • -
  • - addParagraph -
  • delete
  • diff --git a/api/classes/footnoteattributes.html b/api/classes/footnoteattributes.html index c03a21ed68..132c7c4825 100644 --- a/api/classes/footnoteattributes.html +++ b/api/classes/footnoteattributes.html @@ -117,7 +117,7 @@

    Inherited from XmlAttributeComponent.constructor

    Overrides BaseXmlComponent.constructor

    Parameters

    @@ -144,7 +144,7 @@

    Returns boolean

    @@ -166,7 +166,7 @@

    Inherited from XmlAttributeComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject

    @@ -184,7 +184,7 @@

    Parameters

    diff --git a/api/classes/footnoteref.html b/api/classes/footnoteref.html index 2d3f20a3b8..56cc755de8 100644 --- a/api/classes/footnoteref.html +++ b/api/classes/footnoteref.html @@ -117,7 +117,7 @@

    Returns FootnoteRef

    @@ -138,7 +138,7 @@

    Returns boolean

    @@ -159,7 +159,7 @@

    Parameters

    @@ -183,7 +183,7 @@

    Returns void

    @@ -202,7 +202,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/footnotereference.html b/api/classes/footnotereference.html index 6ba60ac504..152b6a5676 100644 --- a/api/classes/footnotereference.html +++ b/api/classes/footnotereference.html @@ -117,7 +117,7 @@

    Parameters

    @@ -144,7 +144,7 @@

    Returns boolean

    @@ -165,7 +165,7 @@

    Parameters

    @@ -189,7 +189,7 @@

    Returns void

    @@ -208,7 +208,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/footnotereferencerun.html b/api/classes/footnotereferencerun.html index 0b332bce2c..4ef82b37bd 100644 --- a/api/classes/footnotereferencerun.html +++ b/api/classes/footnotereferencerun.html @@ -97,28 +97,12 @@

    Methods

    @@ -137,7 +121,7 @@

    Parameters

    @@ -164,7 +148,7 @@

    Returns boolean

    @@ -185,7 +169,7 @@

    Parameters

    @@ -198,42 +182,6 @@
    -
    - -

    allCaps

    - - -
    -
    - -

    bold

    - - -

    break

    @@ -245,37 +193,13 @@

    Returns Run

    -
    - -

    color

    - - -

    delete

    @@ -287,100 +211,13 @@

    Returns void

    -
    - -

    doubleStrike

    - - -
    -
    - -

    font

    - - -
    -
    - -

    highlight

    - - -
    -
    - -

    italics

    - - -

    numberOfTotalPages

    @@ -392,7 +229,7 @@

    Returns Run

    @@ -410,7 +247,7 @@

    Returns Run

    @@ -429,7 +266,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject @@ -439,174 +276,6 @@

    -
    - -

    rightToLeft

    - - -
    -
    - -

    shadow

    - - -
    -
    - -

    size

    - - -
    -
    - -

    smallCaps

    - - -
    -
    - -

    strike

    - - -
    -
    - -

    style

    - - -
    -
    - -

    subScript

    - - -
    -
    - -

    superScript

    - - -

    tab

    @@ -618,40 +287,13 @@

    Returns Run

    -
    - -

    underline

    - - -
    @@ -137,7 +121,7 @@

    Returns FootnoteRefRun

    @@ -158,7 +142,7 @@

    Returns boolean

    @@ -179,7 +163,7 @@

    Parameters

    @@ -192,42 +176,6 @@ -
    - -

    allCaps

    - - -
    -
    - -

    bold

    - - -

    break

    @@ -239,37 +187,13 @@

    Returns Run

    -
    - -

    color

    - - -

    delete

    @@ -281,100 +205,13 @@

    Returns void

    -
    - -

    doubleStrike

    - - -
    -
    - -

    font

    - - -
    -
    - -

    highlight

    - - -
    -
    - -

    italics

    - - -

    numberOfTotalPages

    @@ -386,7 +223,7 @@

    Returns Run

    @@ -404,7 +241,7 @@

    Returns Run

    @@ -423,7 +260,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject @@ -433,174 +270,6 @@

    -
    - -

    rightToLeft

    - - -
    -
    - -

    shadow

    - - -
    -
    - -

    size

    - - -
    -
    - -

    smallCaps

    - - -
    -
    - -

    strike

    - - -
    -
    - -

    style

    - - -
    -
    - -

    subScript

    - - -
    -
    - -

    superScript

    - - -

    tab

    @@ -612,40 +281,13 @@

    Returns Run

    -
    - -

    underline

    - - -
    @@ -117,7 +113,7 @@
  • Parameters

    @@ -149,7 +145,7 @@
  • Returns Header

    @@ -166,7 +162,7 @@
  • Returns Media

    @@ -183,7 +179,7 @@
  • Returns Relationships

    @@ -193,6 +189,29 @@

    Methods

    +
    + +

    add

    + + +

    addChildElement

    @@ -203,7 +222,7 @@
  • Parameters

    @@ -226,7 +245,7 @@
  • Parameters

    @@ -239,130 +258,6 @@
  • -
    - -

    addParagraph

    -
      -
    • addParagraph(paragraph: Paragraph): void
    • -
    - -
    -
    - -

    addTable

    -
      -
    • addTable(table: Table): void
    • -
    - -
    -
    - -

    createImage

    -
      -
    • createImage(image: Buffer | string | Uint8Array | ArrayBuffer, width?: undefined | number, height?: undefined | number): void
    • -
    -
      -
    • - -

      Parameters

      -
        -
      • -
        image: Buffer | string | Uint8Array | ArrayBuffer
        -
      • -
      • -
        Optional width: undefined | number
        -
      • -
      • -
        Optional height: undefined | number
        -
      • -
      -

      Returns void

      -
    • -
    -
    -
    - -

    createParagraph

    -
      -
    • createParagraph(text?: undefined | string): Paragraph
    • -
    - -
    -
    - -

    createTable

    -
      -
    • createTable(rows: number, cols: number): Table
    • -
    - -
  • Relationships
  • +
  • + add +
  • addChildElement
  • addImage
  • -
  • - addParagraph -
  • -
  • - addTable -
  • -
  • - createImage -
  • -
  • - createParagraph -
  • -
  • - createTable -
  • diff --git a/api/classes/heading1style.html b/api/classes/heading1style.html index 8eadaa891d..cb5ebfd71b 100644 --- a/api/classes/heading1style.html +++ b/api/classes/heading1style.html @@ -154,7 +154,7 @@

    Returns Heading1Style

    @@ -175,7 +175,7 @@

    Returns boolean

    @@ -196,7 +196,7 @@

    Parameters

    @@ -220,7 +220,7 @@

    Parameters

    @@ -244,7 +244,7 @@

    Parameters

    @@ -268,7 +268,7 @@

    Returns ParagraphStyle

    @@ -286,7 +286,7 @@

    Parameters

    @@ -310,7 +310,7 @@

    Returns ParagraphStyle

    @@ -328,7 +328,7 @@

    Returns ParagraphStyle

    @@ -346,7 +346,7 @@

    Parameters

    @@ -370,7 +370,7 @@

    Parameters

    @@ -394,7 +394,7 @@

    Returns void

    @@ -412,7 +412,7 @@

    Returns ParagraphStyle

    @@ -430,7 +430,7 @@

    Parameters

    @@ -454,7 +454,7 @@

    Parameters

    @@ -478,7 +478,7 @@

    Parameters

    @@ -502,7 +502,7 @@

    Returns ParagraphStyle

    @@ -520,7 +520,7 @@

    Returns ParagraphStyle

    @@ -538,7 +538,7 @@

    Returns ParagraphStyle

    @@ -556,7 +556,7 @@

    Returns ParagraphStyle

    @@ -574,7 +574,7 @@

    Returns ParagraphStyle

    @@ -592,7 +592,7 @@

    Parameters

    @@ -616,7 +616,7 @@

    Parameters

    @@ -640,7 +640,7 @@

    Returns ParagraphStyle

    @@ -658,7 +658,7 @@

    Parameters

    @@ -675,20 +675,20 @@

    outlineLevel

    - -
    - -

    pageBreakBefore

    - -
    -
    - -

    right

    - - -
    -
    - -

    rightTabStop

    - - -
    -
    - -

    scale

    - - -
    -
    - -

    setCustomNumbering

    - - -
    -
    - -

    setNumbering

    - - -
    -
    - -

    spacing

    - - -
    -
    - -

    start

    - - -
    -
    - -

    style

    - - -
    -
    - -

    thematicBreak

    - - -
    -
    - -

    title

    - - -
    @@ -158,20 +123,20 @@

    constructor

    -
    +

    Accessors

    -
    - -

    Borders

    - - -

    IsDeleted

    @@ -209,30 +157,13 @@

    Returns boolean

    -
    - -

    paragraphProperties

    - - -

    Methods

    @@ -246,7 +177,7 @@
  • Parameters

    @@ -270,7 +201,7 @@

    Parameters

    @@ -293,7 +224,7 @@
  • Parameters

    @@ -316,7 +247,7 @@
  • Parameters

    @@ -339,7 +270,7 @@
  • Parameters

    @@ -362,7 +293,7 @@
  • Parameters

    @@ -385,7 +316,7 @@
  • Parameters

    @@ -398,152 +329,6 @@
  • -
    - -

    bidirectional

    - - -
    -
    - -

    bullet

    -
      -
    • bullet(indentLevel?: number): Paragraph
    • -
    - -
    -
    - -

    center

    - - -
    -
    - -

    centerTabStop

    - - -
    -
    - -

    contextualSpacing

    -
      -
    • contextualSpacing(value: boolean): Paragraph
    • -
    - -
    -
    - -

    createBorder

    - - -
    -
    - -

    createTextRun

    -
      -
    • createTextRun(text: string): TextRun
    • -
    - -

    delete

    @@ -555,312 +340,13 @@

    Returns void

    -
    - -

    distribute

    - - -
    -
    - -

    end

    - - -
    -
    - -

    heading1

    - - -
    -
    - -

    heading2

    - - -
    -
    - -

    heading3

    - - -
    -
    - -

    heading4

    - - -
    -
    - -

    heading5

    - - -
    -
    - -

    heading6

    - - -
    -
    - -

    indent

    - - -
    -
    - -

    justified

    - - -
    -
    - -

    keepLines

    - - -
    -
    - -

    keepNext

    - - -
    -
    - -

    left

    - - -
    -
    - -

    leftTabStop

    - - -
    -
    - -

    maxRightTabStop

    - - -
    -
    - -

    outlineLevel

    - - -

    pageBreak

    @@ -871,24 +357,7 @@
  • -

    Returns Paragraph

    -
  • - -
    -
    - -

    pageBreakBefore

    - -
    -
    - -

    right

    - - -
    -
    - -

    rightTabStop

    - - -
    -
    - -

    setCustomNumbering

    -
      -
    • setCustomNumbering(numberId: number, indentLevel: number): Paragraph
    • -
    - -
    -
    - -

    setNumbering

    -
      -
    • setNumbering(numbering: Num, indentLevel: number): Paragraph
    • -
    - -
    -
    - -

    spacing

    - - -
    -
    - -

    start

    - - -
    -
    - -

    style

    - - -
    -
    - -

    thematicBreak

    - - -
    -
    - -

    title

    - - -
    @@ -138,7 +121,7 @@

    Parameters

    @@ -168,7 +151,7 @@

    Returns boolean

    @@ -176,7 +159,7 @@ -
    +

    Methods

    @@ -189,7 +172,7 @@

    Parameters

    @@ -202,42 +185,6 @@
    -
    - -

    allCaps

    -
      -
    • allCaps(): Run
    • -
    - -
    -
    - -

    bold

    -
      -
    • bold(): Run
    • -
    - -

    break

    @@ -249,37 +196,13 @@

    Returns Run

    -
    - -

    color

    -
      -
    • color(color: string): Run
    • -
    - -

    delete

    @@ -291,100 +214,13 @@

    Returns void

    -
    - -

    doubleStrike

    -
      -
    • doubleStrike(): Run
    • -
    - -
    -
    - -

    font

    -
      -
    • font(fontName: string, hint?: string | undefined): Run
    • -
    - -
    -
    - -

    highlight

    -
      -
    • highlight(color: string): Run
    • -
    - -
    -
    - -

    italics

    -
      -
    • italics(): Run
    • -
    - -

    numberOfTotalPages

    @@ -396,7 +232,7 @@

    Returns Run

    @@ -414,7 +250,7 @@

    Returns Run

    @@ -433,7 +269,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject @@ -443,200 +279,6 @@

    -
    - -

    rightToLeft

    -
      -
    • rightToLeft(): Run
    • -
    - -
    -
    - -

    scale

    -
      -
    • scale(factorX?: number, factorY?: number): void
    • -
    -
      -
    • - -

      Parameters

      -
        -
      • -
        Default value factorX: number = 1
        -
      • -
      • -
        Default value factorY: number = factorX
        -
      • -
      -

      Returns void

      -
    • -
    -
    -
    - -

    shadow

    -
      -
    • shadow(value: string, fill: string, color: string): Run
    • -
    - -
    -
    - -

    size

    -
      -
    • size(size: number): Run
    • -
    - -
    -
    - -

    smallCaps

    -
      -
    • smallCaps(): Run
    • -
    - -
    -
    - -

    strike

    -
      -
    • strike(): Run
    • -
    - -
    -
    - -

    style

    -
      -
    • style(styleId: string): Run
    • -
    - -
    -
    - -

    subScript

    -
      -
    • subScript(): Run
    • -
    - -
    -
    - -

    superScript

    -
      -
    • superScript(): Run
    • -
    - -

    tab

    @@ -648,40 +290,13 @@

    Returns Run

    -
    - -

    underline

    -
      -
    • underline(underlineType?: undefined | string, color?: undefined | string): Run
    • -
    - -
    @@ -156,16 +140,22 @@

    constructor

    @@ -184,7 +174,7 @@

    Returns boolean

    @@ -205,7 +195,7 @@

    Parameters

    @@ -218,40 +208,6 @@ -
    - -

    allCaps

    - - -
    -
    - -

    bold

    - - -

    break

    @@ -262,36 +218,13 @@
  • Returns Run

  • -
    - -

    color

    - - -

    delete

    @@ -303,96 +236,13 @@

    Returns void

    -
    - -

    doubleStrike

    - - -
    -
    - -

    font

    - - -
    -
    - -

    highlight

    - - -
    -
    - -

    italics

    - - -

    numberOfTotalPages

    @@ -403,7 +253,7 @@
  • Returns Run

    @@ -420,7 +270,7 @@
  • Returns Run

    @@ -439,7 +289,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject @@ -449,166 +299,6 @@

  • -
    - -

    rightToLeft

    - - -
    -
    - -

    shadow

    - - -
    -
    - -

    size

    - - -
    -
    - -

    smallCaps

    - - -
    -
    - -

    strike

    - - -
    -
    - -

    style

    - - -
    -
    - -

    subScript

    - - -
    -
    - -

    superScript

    - - -

    tab

    @@ -619,39 +309,13 @@
  • Returns Run

  • -
    - -

    underline

    - - -
    @@ -137,7 +121,7 @@

    Returns SeperatorRun

    @@ -158,7 +142,7 @@

    Returns boolean

    @@ -179,7 +163,7 @@

    Parameters

    @@ -192,42 +176,6 @@ -
    - -

    allCaps

    - - -
    -
    - -

    bold

    - - -

    break

    @@ -239,37 +187,13 @@

    Returns Run

    -
    - -

    color

    - - -

    delete

    @@ -281,100 +205,13 @@

    Returns void

    -
    - -

    doubleStrike

    - - -
    -
    - -

    font

    - - -
    -
    - -

    highlight

    - - -
    -
    - -

    italics

    - - -

    numberOfTotalPages

    @@ -386,7 +223,7 @@

    Returns Run

    @@ -404,7 +241,7 @@

    Returns Run

    @@ -423,7 +260,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject @@ -433,174 +270,6 @@

    -
    - -

    rightToLeft

    - - -
    -
    - -

    shadow

    - - -
    -
    - -

    size

    - - -
    -
    - -

    smallCaps

    - - -
    -
    - -

    strike

    - - -
    -
    - -

    style

    - - -
    -
    - -

    subScript

    - - -
    -
    - -

    superScript

    - - -

    tab

    @@ -612,40 +281,13 @@

    Returns Run

    -
    - -

    underline

    - - -
    @@ -137,7 +121,7 @@

    Parameters

    @@ -164,7 +148,7 @@

    Returns boolean

    @@ -185,7 +169,7 @@

    Parameters

    @@ -198,42 +182,6 @@ -
    - -

    allCaps

    - - -
    -
    - -

    bold

    - - -

    break

    @@ -245,37 +193,13 @@

    Returns Run

    -
    - -

    color

    - - -

    delete

    @@ -287,100 +211,13 @@

    Returns void

    -
    - -

    doubleStrike

    - - -
    -
    - -

    font

    - - -
    -
    - -

    highlight

    - - -
    -
    - -

    italics

    - - -

    numberOfTotalPages

    @@ -392,7 +229,7 @@

    Returns Run

    @@ -410,7 +247,7 @@

    Returns Run

    @@ -429,7 +266,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject @@ -439,174 +276,6 @@

    -
    - -

    rightToLeft

    - - -
    -
    - -

    shadow

    - - -
    -
    - -

    size

    - - -
    -
    - -

    smallCaps

    - - -
    -
    - -

    strike

    - - -
    -
    - -

    style

    - - -
    -
    - -

    subScript

    - - -
    -
    - -

    superScript

    - - -

    tab

    @@ -618,40 +287,13 @@

    Returns Run

    -
    - -

    underline

    - - -
    @@ -71,7 +71,7 @@ XmlComponent @@ -84,21 +84,21 @@

    Constructors

    Accessors

    Methods

    @@ -110,14 +110,14 @@

    constructor

    -

    Returns Shadow

    +

    Returns Shading

    @@ -150,7 +150,7 @@

    Returns boolean

    @@ -171,7 +171,7 @@

    Parameters

    @@ -195,7 +195,7 @@

    Returns void

    @@ -214,7 +214,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject @@ -239,22 +239,22 @@ -
    - -

    setFixedWidthLayout

    -
      -
    • setFixedWidthLayout(): Table
    • -
    - -
    @@ -130,20 +114,20 @@

    constructor

    -
    - -

    allCaps

    - - -
    -
    - -

    bold

    - - -

    break

    @@ -245,37 +193,13 @@

    Returns Run

    -
    - -

    color

    - - -

    delete

    @@ -287,100 +211,13 @@

    Returns void

    -
    - -

    doubleStrike

    - - -
    -
    - -

    font

    - - -
    -
    - -

    highlight

    - - -
    -
    - -

    italics

    - - -

    numberOfTotalPages

    @@ -392,7 +229,7 @@

    Returns Run

    @@ -410,7 +247,7 @@

    Returns Run

    @@ -429,7 +266,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject @@ -439,174 +276,6 @@

    -
    - -

    rightToLeft

    - - -
    -
    - -

    shadow

    - - -
    -
    - -

    size

    - - -
    -
    - -

    smallCaps

    - - -
    -
    - -

    strike

    - - -
    -
    - -

    style

    - - -
    -
    - -

    subScript

    - - -
    -
    - -

    superScript

    - - -

    tab

    @@ -618,40 +287,13 @@

    Returns Run

    -
    - -

    underline

    - - -
    @@ -71,13 +71,14 @@

    Enumeration members

    @@ -91,7 +92,7 @@
    BOTH: = "both"
    @@ -101,7 +102,7 @@
    CENTER: = "center"
    @@ -111,7 +112,7 @@
    DISTRIBUTE: = "distribute"
    @@ -121,7 +122,17 @@
    END: = "end"
    + +
    + +

    JUSTIFIED

    +
    JUSTIFIED: = "both"
    +
    @@ -131,7 +142,7 @@
    LEFT: = "left"
    @@ -141,7 +152,7 @@
    RIGHT: = "right"
    @@ -151,7 +162,7 @@
    START: = "start"
    @@ -170,28 +181,31 @@