This class represents an image in a paragraph.
+It is used to embed image data in BASE64 encoding.
This class represents the metadata of a document.
It is used to set descriptive information about the document.
This class represents the content of a text document.
+This class represents a text document in OpenDocument format.
+ParagraphThis class represents a heading in a document.
+It is used to structure a document into multiple sections. +A chapter or section begins with a heading and extends to the next heading at the same or higher level.
+This class represents a hyperlink in a paragraph.
+This class represents a list and may contain any number list items.
+This class represents an item in a list.
+This class represents a paragraph.
+This class represents a Color.
Tab stops are used to align text in a paragraph. To become effective they must be set to the style of the respective paragraph.
-This class represents a heading.
-This class represents a hyperlink in a paragraph.
-This class represents a list. -It can contain multiple list items.
-This class represents an item in a list.
-This class represents a paragraph.
-This class represents an empty ODF text document.
-string
+ * [`.setStyle(style)`](#Image+setStyle) ⇒ [Image](#Image)
* [`.getStyle()`](#Image+getStyle) ⇒ IImageStyle
- * [`.toXml()`](#Image+toXml)
* * *
@@ -71,18 +78,51 @@ Creates an image
- path string
Path to the image file that should be embedded
+**Example**
+```js
+document.getBody()
+ .addParagraph()
+ .addImage("/home/homer/myself.png")
+ .getStyle()
+ .setSize(42, 23);
+```
+
+* * *
+
+
+
+### `image.getPath()` ⇒ string
+The `getPath()` method returns the path to the image file that should be embedded.
+
+**Return value**
+string - The path to the image file
+
+**Example**
+```js
+const image = new Image("/home/homer/myself.png");
+image.getPath(); // '/home/homer/myself.png'
+```
+**Since**: 0.7.0
* * *
-### `image.setStyle(style)`
+### `image.setStyle(style)` ⇒ [Image](#Image)
Sets the new style of this image.
#### Parameters
- style IImageStyle
The new style
+**Return value**
+[Image](#Image) - The `Image` object
+
+**Example**
+```js
+const image = new Image("/home/homer/myself.png");
+image.setStyle(new ImageStyle());
+```
**Since**: 0.5.0
* * *
@@ -95,16 +135,17 @@ Returns the style of this image.
**Return value**
IImageStyle - The style of the image
+**Example**
+```js
+const image = new Image("/home/homer/myself.png");
+image.getStyle(); // default style
+image.setStyle(new ImageStyle());
+image.getStyle(); // previously set style
+```
**Since**: 0.5.0
* * *
-
-
-### `image.toXml()`
-
-* * *
-
## Meta
@@ -118,9 +159,9 @@ It is used to set descriptive information about the document.
* [`new Meta()`](#new_Meta_new)
* [`.setCreator(creator)`](#Meta+setCreator) ⇒ [Meta](#Meta)
* [`.getCreator()`](#Meta+getCreator) ⇒ string \| undefined
- * [`.getCreationDate()`](#Meta+getCreationDate) ⇒ number
+ * [`.getCreationDate()`](#Meta+getCreationDate) ⇒ Date
* [`.setDate(date)`](#Meta+setDate) ⇒ [Meta](#Meta)
- * [`.getDate()`](#Meta+getDate) ⇒ number \| undefined
+ * [`.getDate()`](#Meta+getDate) ⇒ Date \| undefined
* [`.setDescription(description)`](#Meta+setDescription) ⇒ [Meta](#Meta)
* [`.getDescription()`](#Meta+getDescription) ⇒ string \| undefined
* [`.getEditingCycles()`](#Meta+getEditingCycles) ⇒ number
@@ -134,14 +175,13 @@ It is used to set descriptive information about the document.
* [`.setLanguage(language)`](#Meta+setLanguage) ⇒ [Meta](#Meta)
* [`.getLanguage()`](#Meta+getLanguage) ⇒ string \| undefined
* [`.setPrintDate(printDate)`](#Meta+setPrintDate) ⇒ [Meta](#Meta)
- * [`.getPrintDate()`](#Meta+getPrintDate) ⇒ number \| undefined
+ * [`.getPrintDate()`](#Meta+getPrintDate) ⇒ Date \| undefined
* [`.setPrintedBy(printedBy)`](#Meta+setPrintedBy) ⇒ [Meta](#Meta)
* [`.getPrintedBy()`](#Meta+getPrintedBy) ⇒ string \| undefined
* [`.setSubject(subject)`](#Meta+setSubject) ⇒ [Meta](#Meta)
* [`.getSubject()`](#Meta+getSubject) ⇒ string \| undefined
* [`.setTitle(title)`](#Meta+setTitle) ⇒ [Meta](#Meta)
* [`.getTitle()`](#Meta+getTitle) ⇒ string \| undefined
- * [`.toXml(document, root)`](#Meta+toXml)
* * *
@@ -213,13 +253,13 @@ meta.getCreator(); // 'Lisa Simpson'
-### `meta.getCreationDate()` ⇒ number
+### `meta.getCreationDate()` ⇒ Date
The `getCreationDate()` method returns the UTC timestamp specifying the date and time when a document was created.
The creation date is initialized with the UTC timestamp of the moment the `Meta` instance was created.
**Return value**
-number - The UTC timestamp specifying the date and time when a document was created
+Date - A `Date` instance specifying the date and time when a document was created
**Example**
```js
@@ -236,9 +276,9 @@ meta.getCreationDate(); // 1585742400000
The `setDate()` method sets the date and time when the document was last modified.
#### Parameters
-- date number | undefined
-The UTC timestamp specifying the date and time when the document was last modified
- or `undefined` to unset the date
+- date Date | undefined
+A `Date` instance specifying the date and time when the document was last modified
+ or `undefined` to unset the date
**Return value**
[Meta](#Meta) - The `Meta` object
@@ -246,7 +286,7 @@ The UTC timestamp specifying the date and time when the document was last modifi
**Example**
```js
const meta = new Meta();
-meta.setDate(Date.now()); // 2020-07-23 13:37:00
+meta.setDate(new Date()); // 2020-07-23 13:37:00
```
**Since**: 0.6.0
@@ -254,18 +294,18 @@ meta.setDate(Date.now()); // 2020-07-23 13:37:00
-### `meta.getDate()` ⇒ number \| undefined
+### `meta.getDate()` ⇒ Date \| undefined
The `getDate()` method returns the date and time when the document was last modified.
**Return value**
-number \| undefined - The UTC timestamp specifying the date and time when the document was last modified
- or `undefined` if the date is not set
+Date \| undefined - A `Date` instance specifying the date and time when the document was last modified
+ or `undefined` if the date is not set
**Example**
```js
const meta = new Meta();
meta.getDate(); // undefined
-meta.setDate(Date.now()); // 2020-07-23 13:37:00
+meta.setDate(new Date()); // 2020-07-23 13:37:00
meta.getDate(); // 1595511420000
```
**Since**: 0.6.0
@@ -528,9 +568,9 @@ meta.getLanguage(); // 'en-US'
The `setPrintDate()` method sets the date and time when the document was last printed.
#### Parameters
-- printDate number | undefined
-The UTC timestamp specifying the date and time when the document was last
- printed or `undefined` to unset the print date
+- printDate Date | undefined
+A `Date` instance specifying the date and time when the document was last
+ printed or `undefined` to unset the print date
**Return value**
[Meta](#Meta) - The `Meta` object
@@ -538,7 +578,7 @@ The UTC timestamp specifying the date and time when the document was last
**Example**
```js
const meta = new Meta();
-meta.setPrintDate(Date.now()); // 2020-07-23 13:37:00
+meta.setPrintDate(new Date()); // 2020-07-23 13:37:00
```
**Since**: 0.6.0
@@ -546,18 +586,18 @@ meta.setPrintDate(Date.now()); // 2020-07-23 13:37:00
-### `meta.getPrintDate()` ⇒ number \| undefined
+### `meta.getPrintDate()` ⇒ Date \| undefined
The `getPrintDate()` method returns the date and time when the document was last printed.
**Return value**
-number \| undefined - The UTC timestamp specifying the date and time when the document was last printed
- or `undefined` if the print date is not set
+Date \| undefined - A `Date` instance specifying the date and time when the document was last printed
+ or `undefined` if the print date is not set
**Example**
```js
const meta = new Meta();
meta.getPrintDate(); // undefined
-meta.setPrintDate(Date.now()); // 2020-07-23 13:37:00
+meta.setPrintDate(new Date()); // 2020-07-23 13:37:00
meta.getPrintDate(); // 1595511420000
```
**Since**: 0.6.0
@@ -689,1077 +729,1393 @@ meta.getTitle(); // 'Memoirs of Homer Simpson'
* * *
-
-
-### `meta.toXml(document, root)`
-Transforms the text style into Open Document Format.
-
-#### Parameters
-- document Document
-The XML document
-- root Element
-The root node in the DOM
-
-**Since**: 0.6.0
-
-* * *
-
-
+
-## Color
-This class represents a Color.
+## TextBody
+This class represents the content of a text document.
-**Since**: 0.4.0
+**Since**: 0.7.0
-* [Color](#Color)
- * [`new Color(red, green, blue)`](#new_Color_new)
- * _instance_
- * [`.toHex()`](#Color+toHex) ⇒ string
- * _static_
- * [`.fromHex(value)`](#Color.fromHex) ⇒ [Color](#Color) \| undefined
- * [`.fromRgb(red, green, blue)`](#Color.fromRgb) ⇒ [Color](#Color) \| undefined
+* [TextBody](#TextBody)
+ * [`.addHeading([text], [level])`](#TextBody+addHeading) ⇒ [Heading](#Heading)
+ * [`.addList()`](#TextBody+addList) ⇒ [List](#List)
+ * [`.addParagraph([text])`](#TextBody+addParagraph) ⇒ [Paragraph](#Paragraph)
* * *
-
+
-### `new Color(red, green, blue)`
-Creates a new color with the specified channel values.
+### `textBody.addHeading([text], [level])` ⇒ [Heading](#Heading)
+Adds a heading at the end of the document.
+If a text is given, this will be set as text content of the heading.
#### Parameters
-- red number
-The red channel of the color
-- green number
-The green channel of the color
-- blue number
-The blue channel of the color
-
-
-* * *
-
-
-
-### `color.toHex()` ⇒ string
-The toHex() method returns a string representing the color as hex string.
+- [text] string
+The text content of the heading
+- [level] number = 1
+The heading level; defaults to 1 if omitted
**Return value**
-string - A hex string representing the color
+[Heading](#Heading) - The newly added heading
-**Since**: 0.4.0
+**Since**: 0.7.0
* * *
-
-
-### `Color.fromHex(value)` ⇒ [Color](#Color) \| undefined
-The `Color.fromHex()` method parses a string argument and returns a color.
-The string is expected to be in `#rrggbb` or `rrggbb` format.
+
-#### Parameters
-- value string
-The value you want to parse
+### `textBody.addList()` ⇒ [List](#List)
+Adds an empty list at the end of the document.
**Return value**
-[Color](#Color) \| undefined - A color parsed from the given value.
-If the value cannot be converted to a color, `undefined` is returned.
+[List](#List) - The newly added list
-**Since**: 0.4.0
+**Since**: 0.7.0
* * *
-
+
-### `Color.fromRgb(red, green, blue)` ⇒ [Color](#Color) \| undefined
-The `Color.fromRgb()` method returns a color with the channel arguments.
+### `textBody.addParagraph([text])` ⇒ [Paragraph](#Paragraph)
+Adds a paragraph at the end of the document.
+If a text is given, this will be set as text content of the paragraph.
#### Parameters
-- red number
-The red channel of the color with a range of 0...255
-- green number
-The green channel of the color with a range of 0...255
-- blue number
-The blue channel of the color with a range of 0...255
+- [text] string
+The text content of the paragraph
**Return value**
-[Color](#Color) \| undefined - A color parsed from the given value.
-If any channel is outside the allowable range, `undefined` is returned.
+[Paragraph](#Paragraph) - The newly added paragraph
-**Since**: 0.4.0
+**Since**: 0.7.0
* * *
-
+
-## ImageStyle
-This class represents the style of an image
+## TextDocument
+This class represents a text document in OpenDocument format.
-**Since**: 0.5.0
+**Since**: 0.1.0
-* [ImageStyle](#ImageStyle)
- * [`new ImageStyle()`](#new_ImageStyle_new)
- * [`.setAnchorType()`](#ImageStyle+setAnchorType)
- * [`.getAnchorType()`](#ImageStyle+getAnchorType)
- * [`.setHeight(height)`](#ImageStyle+setHeight)
- * [`.getHeight()`](#ImageStyle+getHeight) ⇒ number \| undefined
- * [`.setWidth(width)`](#ImageStyle+setWidth)
- * [`.getWidth()`](#ImageStyle+getWidth) ⇒ number \| undefined
- * [`.setSize(width, height)`](#ImageStyle+setSize)
- * [`.toXml()`](#ImageStyle+toXml)
+* [TextDocument](#TextDocument)
+ * [`.getBody()`](#TextDocument+getBody) ⇒ [TextBody](#TextBody)
+ * [`.declareFont(name, fontFamily, fontPitch)`](#TextDocument+declareFont) ⇒ FontFace
+ * [`.getFonts()`](#TextDocument+getFonts) ⇒ Array.<FontFace>
+ * [`.getMeta()`](#TextDocument+getMeta) ⇒ [Meta](#Meta)
+ * [`.saveFlat(filePath)`](#TextDocument+saveFlat) ⇒ Promise.<void>
+ * ~~[`.toString()`](#TextDocument+toString) ⇒ string~~
* * *
-
+
-### `new ImageStyle()`
-Constructor.
+### `textDocument.getBody()` ⇒ [TextBody](#TextBody)
+The `getBody()` method returns the content of the document.
+**Return value**
+[TextBody](#TextBody) - A `TextBody` object that holds the content of the document
+
+**Example**
+```js
+new TextDocument()
+ .getBody()
+ .addHeading('My first document');
+```
+**Since**: 0.7.0
* * *
-
+
-### `imageStyle.setAnchorType()`
+### `textDocument.declareFont(name, fontFamily, fontPitch)` ⇒ FontFace
+The `declareFont` method creates a font face to be used in the document.
-* * *
+**Note: There is no check whether the font exists.
+In order to be displayed properly, the font must be present on the target system.**
-
+#### Parameters
+- name string
+The name of the font; this name must be set to a [ParagraphStyle](#ParagraphStyle)
+- fontFamily string
+The name of the font family
+- fontPitch FontPitch
+The pitch of the font
-### `imageStyle.getAnchorType()`
+**Return value**
+FontFace - The declared `FontFace` object
+
+**Example**
+```js
+new TextDocument()
+ .declareFont("FreeSans", "FreeSans", FontPitch.Variable);
+```
+**Since**: 0.4.0
* * *
-
+
-### `imageStyle.setHeight(height)`
-Sets the target height of the image.
+### `textDocument.getFonts()` ⇒ Array.<FontFace>
+The `getFonts()` method returns all font face declarations for the document.
-#### Parameters
-- height number
-The target height of the image in millimeter
+**Return value**
+Array.<FontFace> - A copy of the list of font face declarations for the document
-**Since**: 0.5.0
+**Example**
+```js
+const document = new TextDocument();
+document.declareFont("FreeSans", "FreeSans", FontPitch.Variable);
+document.getFonts();
+```
+**Since**: 0.7.0
* * *
-
+
-### `imageStyle.getHeight()` ⇒ number \| undefined
-Returns the target height of the image or `undefined` if no height was set.
+### `textDocument.getMeta()` ⇒ [Meta](#Meta)
+The `getMeta()` method returns the metadata of the document.
**Return value**
-number \| undefined - The target height of the image in millimeter or `undefined` if no height was set
+[Meta](#Meta) - An object holding the metadata of the document
-**Since**: 0.5.0
+**See**: [Meta](#Meta)
+**Example**
+```js
+new TextDocument.getMeta()
+ .setCreator('Homer Simpson');
+```
+**Since**: 0.6.0
* * *
-
+
-### `imageStyle.setWidth(width)`
-Sets the target width of the image.
+### `textDocument.saveFlat(filePath)` ⇒ Promise.<void>
+The `saveFlat()` method converts the document into an XML string and stores it in flat open document xml format.
#### Parameters
-- width number
-The target width of the image in millimeter
+- filePath string
+The file path to write to
-**Since**: 0.5.0
+**Example**
+```js
+new TextDocument()
+ .saveFlat("/home/homer/document.fodt");
+```
+**Since**: 0.1.0
* * *
-
+
-### `imageStyle.getWidth()` ⇒ number \| undefined
-Returns the target width of the image or `undefined` if no width was set.
+### ~~`textDocument.toString()` ⇒ string~~
+***Deprecated***
+
+Returns the string representation of this document in flat open document xml format.
**Return value**
-number \| undefined - The target width of the image in millimeter or `undefined` if no width was set
+string - The string representation of this document
-**Since**: 0.5.0
+**Since**: 0.1.0
* * *
-
-
-### `imageStyle.setSize(width, height)`
-Sets the target size of the image.
+
-#### Parameters
-- width number
-The target width of the image in millimeter
-- height number
-The target height of the image in millimeter
+## Heading ⇐ [Paragraph](#Paragraph)
+This class represents a heading in a document.
-**Since**: 0.5.0
+It is used to structure a document into multiple sections.
+A chapter or section begins with a heading and extends to the next heading at the same or higher level.
-* * *
+**Extends**: [Paragraph](#Paragraph)
+**Since**: 0.1.0
-
+* [Heading](#Heading) ⇐ [Paragraph](#Paragraph)
+ * [`new Heading([text], [level])`](#new_Heading_new)
+ * [`.setLevel(level)`](#Heading+setLevel) ⇒ [Heading](#Heading)
+ * [`.getLevel()`](#Heading+getLevel) ⇒ number
+ * [`.addText(text)`](#Paragraph+addText) ⇒ [Paragraph](#Paragraph)
+ * [`.getText()`](#Paragraph+getText) ⇒ string
+ * [`.setText(text)`](#Paragraph+setText) ⇒ [Paragraph](#Paragraph)
+ * [`.addHyperlink(text, uri)`](#Paragraph+addHyperlink) ⇒ [Hyperlink](#Hyperlink)
+ * [`.addImage(path)`](#Paragraph+addImage) ⇒ [Image](#Image)
+ * [`.setStyle(style)`](#Paragraph+setStyle) ⇒ [Paragraph](#Paragraph)
+ * [`.getStyle()`](#Paragraph+getStyle) ⇒ IParagraphStyle \| undefined
-### `imageStyle.toXml()`
* * *
-
+
-## ParagraphStyle
-This class represents the style of a paragraph
+### `new Heading([text], [level])`
+Creates a `Heading` instance that represents a heading in a document.
-**Since**: 0.4.0
-
-* [ParagraphStyle](#ParagraphStyle)
- * [`new ParagraphStyle()`](#new_ParagraphStyle_new)
- * [`.setColor()`](#ParagraphStyle+setColor)
- * [`.getColor()`](#ParagraphStyle+getColor)
- * [`.setFontName()`](#ParagraphStyle+setFontName)
- * [`.getFontName()`](#ParagraphStyle+getFontName)
- * [`.setFontSize()`](#ParagraphStyle+setFontSize)
- * [`.getFontSize()`](#ParagraphStyle+getFontSize)
- * [`.setTextTransformation()`](#ParagraphStyle+setTextTransformation)
- * [`.getTextTransformation()`](#ParagraphStyle+getTextTransformation)
- * [`.setTypeface()`](#ParagraphStyle+setTypeface)
- * [`.getTypeface()`](#ParagraphStyle+getTypeface)
- * [`.setHorizontalAlignment()`](#ParagraphStyle+setHorizontalAlignment)
- * [`.getHorizontalAlignment()`](#ParagraphStyle+getHorizontalAlignment)
- * [`.setPageBreakBefore()`](#ParagraphStyle+setPageBreakBefore)
- * [`.setKeepTogether()`](#ParagraphStyle+setKeepTogether)
- * [`.getTabStops()`](#ParagraphStyle+getTabStops)
- * [`.clearTabStops()`](#ParagraphStyle+clearTabStops)
- * [`.toXml()`](#ParagraphStyle+toXml)
+#### Parameters
+- [text] string = "''"
+The text content of the heading; defaults to an empty string if omitted
+- [level] number = 1
+The level of the heading, starting with `1`; defaults to `1` if omitted
+**Example**
+```js
+document.getBody().addHeading("First Headline", 1);
+```
+**Example**
+```js
+document.getBody().addHeading()
+ .setText("Second Headline")
+ .setLevel(2);
+```
* * *
-
+
-### `new ParagraphStyle()`
-Constructor.
+### `heading.setLevel(level)` ⇒ [Heading](#Heading)
+The `setLevel()` method sets the level of the heading, starting with `1`.
+If an illegal value is provided, then the heading is assumed to be at level `1`.
+#### Parameters
+- level number
+The level of the heading, starting with `1`
+
+**Return value**
+[Heading](#Heading) - The `Heading` object
+
+**Since**: 0.1.0
* * *
-
+
-### `paragraphStyle.setColor()`
+### `heading.getLevel()` ⇒ number
+The `getLevel()` method returns the level of the heading.
+
+**Return value**
+number - The level of the heading
+
+**Since**: 0.1.0
* * *
-
+
-### `paragraphStyle.getColor()`
+### `heading.addText(text)` ⇒ [Paragraph](#Paragraph)
+Appends the specified text to the end of the paragraph.
+
+#### Parameters
+- text string
+The additional text content
+
+**Return value**
+[Paragraph](#Paragraph) - The `Paragraph` object
+
+**Example**
+```js
+new Paragraph("Some text") // Some text
+ .addText("\nEven more text"); // Some text\nEven more text
+```
+**Since**: 0.1.0
* * *
-
+
-### `paragraphStyle.setFontName()`
+### `heading.getText()` ⇒ string
+Returns the text content of the paragraph.
+Note: This will only return the text; other elements and markup will be omitted.
+
+**Return value**
+string - The text content of the paragraph
+
+**Example**
+```js
+const paragraph = new Paragraph("Some text, ");
+paragraph.addHyperlink("some linked text");
+paragraph.addText(", even more text");
+paragraph.getText(); // Some text, some linked text, even more text
+```
+**Since**: 0.1.0
* * *
-
+
-### `paragraphStyle.getFontName()`
+### `heading.setText(text)` ⇒ [Paragraph](#Paragraph)
+Sets the text content of the paragraph.
+Note: This will replace any existing content of the paragraph.
+
+#### Parameters
+- text string
+The new text content
+
+**Return value**
+[Paragraph](#Paragraph) - The `Paragraph` object
+
+**Example**
+```js
+new Paragraph("Some text") // Some text
+ .setText("Some other text"); // Some other text
+```
+**Since**: 0.1.0
* * *
-
+
-### `paragraphStyle.setFontSize()`
+### `heading.addHyperlink(text, uri)` ⇒ [Hyperlink](#Hyperlink)
+Appends the specified text as hyperlink to the end of the paragraph.
+
+#### Parameters
+- text string
+The text content of the hyperlink
+- uri string
+The target URI of the hyperlink
+
+**Return value**
+[Hyperlink](#Hyperlink) - The added `Hyperlink` object
+
+**Example**
+```js
+new Paragraph("Some text, ") // Some text,
+ .addHyperlink("some linked text"); // Some text, some linked text
+```
+**Since**: 0.3.0
* * *
-
+
-### `paragraphStyle.getFontSize()`
+### `heading.addImage(path)` ⇒ [Image](#Image)
+Appends the image of the denoted path to the end of the paragraph.
+The current paragraph will be set as anchor for the image.
+
+#### Parameters
+- path string
+The path to the image file
+
+**Return value**
+[Image](#Image) - The added `Image` object
+
+**Example**
+```js
+new Paragraph("Some text")
+ .addImage("/home/homer/myself.png");
+```
+**Since**: 0.3.0
* * *
-
+
-### `paragraphStyle.setTextTransformation()`
+### `heading.setStyle(style)` ⇒ [Paragraph](#Paragraph)
+Sets the new style of the paragraph.
+To reset the style, `undefined` must be given.
+
+#### Parameters
+- style IParagraphStyle | undefined
+The new style or `undefined` to reset the style
+
+**Return value**
+[Paragraph](#Paragraph) - The `Paragraph` object
+
+**Example**
+```js
+new Paragraph("Some text")
+ .setStyle(new ParagraphStyle());
+```
+**Since**: 0.3.0
* * *
-
+
-### `paragraphStyle.getTextTransformation()`
+### `heading.getStyle()` ⇒ IParagraphStyle \| undefined
+Returns the style of the paragraph.
+
+**Return value**
+IParagraphStyle \| undefined - The style of the paragraph or `undefined` if no style was set
+
+**Example**
+```js
+const paragraph = new Paragraph("Some text");
+paragraph.getStyle(); // undefined
+paragraph.setStyle(new ParagraphStyle());
+paragraph.getStyle(); // previously set style
+```
+**Since**: 0.3.0
* * *
-
+
+
+## Hyperlink
+This class represents a hyperlink in a paragraph.
+
+**Since**: 0.3.0
+
+* [Hyperlink](#Hyperlink)
+ * [`new Hyperlink(text, uri)`](#new_Hyperlink_new)
+ * [`.setURI(uri)`](#Hyperlink+setURI) ⇒ [Hyperlink](#Hyperlink)
+ * [`.getURI()`](#Hyperlink+getURI) ⇒ string
-### `paragraphStyle.setTypeface()`
* * *
-
+
-### `paragraphStyle.getTypeface()`
+### `new Hyperlink(text, uri)`
+Creates a hyperlink
+
+#### Parameters
+- text string
+The text content of the hyperlink
+- uri string
+The target URI of the hyperlink
+
+**Example**
+```js
+document.getBody()
+ .addParagraph('This is a ')
+ .addHyperlink('link', 'https://example.com/');
+```
* * *
-
+
-### `paragraphStyle.setHorizontalAlignment()`
+### `hyperlink.setURI(uri)` ⇒ [Hyperlink](#Hyperlink)
+The `setURI()` method sets the target URI for this hyperlink.
+If an illegal value is provided, the value will be ignored.
+
+#### Parameters
+- uri string
+The target URI of this hyperlink
+
+**Return value**
+[Hyperlink](#Hyperlink) - The `Hyperlink` object
+
+**Example**
+```js
+const hyperlink = new Hyperlink('My website', 'https://example.com/');
+hyperlink.setURI('https://github.com'); // https://github.com
+hyperlink.setURI(''); // https://github.com
+```
+**Since**: 0.3.0
* * *
-
+
-### `paragraphStyle.getHorizontalAlignment()`
+### `hyperlink.getURI()` ⇒ string
+The `getURI()` method returns the target URI of this hyperlink.
+
+**Return value**
+string - The target URI of this hyperlink
+
+**Example**
+```js
+const hyperlink = new Hyperlink('My website', 'https://example.com/');
+hyperlink.getURI(); // https://example.com
+hyperlink.setURI('https://github.com');
+hyperlink.getURI(); // https://github.com
+```
+**Since**: 0.3.0
* * *
-
+
+
+## List
+This class represents a list and may contain any number list items.
+
+**Since**: 0.2.0
+
+* [List](#List)
+ * [`new List()`](#new_List_new)
+ * [`.addItem([item])`](#List+addItem) ⇒ [ListItem](#ListItem)
+ * [`.insertItem(position, item)`](#List+insertItem) ⇒ [ListItem](#ListItem)
+ * [`.getItem(position)`](#List+getItem) ⇒ [ListItem](#ListItem) \| undefined
+ * [`.getItems()`](#List+getItems) ⇒ [Array.<ListItem>](#ListItem)
+ * [`.removeItemAt(position)`](#List+removeItemAt) ⇒ [ListItem](#ListItem) \| undefined
+ * [`.clear()`](#List+clear) ⇒ [List](#List)
+ * [`.size()`](#List+size) ⇒ number
-### `paragraphStyle.setPageBreakBefore()`
* * *
-
+
-### `paragraphStyle.setKeepTogether()`
+### `new List()`
+Creates a `List` instance that represents a list.
+
+**Example**
+```js
+const list = document.getBody().addList();
+list.addItem("First item");
+list.addItem("Second item");
+list.insertItem(1, "After first item")
+list.removeItemAt(2);
+```
* * *
-
+
-### `paragraphStyle.getTabStops()`
+### `list.addItem([item])` ⇒ [ListItem](#ListItem)
+The `addItem()` method adds a new list item with the specified text or adds the specified item to the list.
+
+#### Parameters
+- [item] string | [ListItem](#ListItem)
+The text content of the new item or the item to add
+
+**Return value**
+[ListItem](#ListItem) - The added `ListItem` object
+
+**Example**
+```js
+const list = new List();
+list.addItem("First item");
+list.addItem(new ListItem("Second item"));
+```
+**Since**: 0.2.0
* * *
-
+
-### `paragraphStyle.clearTabStops()`
+### `list.insertItem(position, item)` ⇒ [ListItem](#ListItem)
+The `insertItem` method inserts a new list item with the specified text
+or inserts the specified item at the specified position.
+The item is inserted before the item at the specified position.
+
+If the position is greater than the current number items, the new item is appended at the end of the list.
+If the position is negative, the new item is inserted as first element.
+
+#### Parameters
+- position number
+The index at which to insert the list item (starting from 0).
+- item string | [ListItem](#ListItem)
+The text content of the new item or the item to insert
+
+**Return value**
+[ListItem](#ListItem) - The inserted `ListItem` object
+
+**Example**
+```js
+const list = new List();
+list.addItem("First item"); // "First item"
+list.addItem("Second item"); // "First item", "Second item"
+list.insertItem(1, "After first item"); // "First item", "After first item", "Second item"
+```
+**Since**: 0.2.0
* * *
-
+
-### `paragraphStyle.toXml()`
+### `list.getItem(position)` ⇒ [ListItem](#ListItem) \| undefined
+The `getItem()` method returns the item at the specified position in the list.
+If an invalid position is given, undefined is returned.
+
+#### Parameters
+- position number
+The index of the requested list item (starting from 0).
+
+**Return value**
+[ListItem](#ListItem) \| undefined - The `ListItem` object at the specified position
+or `undefined` if there is no list item at the specified position
+
+**Example**
+```js
+const list = new List();
+list.addItem("First item");
+list.addItem("Second item");
+list.getItem(1); // "Second item"
+list.getItem(2); // undefined
+```
+**Since**: 0.2.0
* * *
-
+
-## StyleHelper
-Utility class for dealing with styles.
+### `list.getItems()` ⇒ [Array.<ListItem>](#ListItem)
+The `getItems()` method returns all list items.
-**Since**: 0.4.0
+**Return value**
+[Array.<ListItem>](#ListItem) - A copy of the list of `ListItem` objects
+
+**Example**
+```js
+const list = new List();
+list.getItems(); // []
+list.addItem("First item");
+list.addItem("Second item");
+list.getItems(); // ["First item", "Second item"]
+```
+**Since**: 0.2.0
* * *
-
+
-### `StyleHelper.getAutomaticStylesElement(document)` ⇒ Element
-Returns the `automatic-styles` element of the document.
-If there is no such element yet, it will be created.
+### `list.removeItemAt(position)` ⇒ [ListItem](#ListItem) \| undefined
+The `removeItemAt()` method removes the list item from the specified position.
#### Parameters
-- document Document
-The XML document
+- position number
+The index of the list item to remove (starting from 0).
**Return value**
-Element - The documents `automatic-styles` element
+[ListItem](#ListItem) \| undefined - The removed `ListItem` object
+or undefined if there is no list item at the specified position
-**Since**: 0.4.0
+**Example**
+```js
+const list = new List();
+list.addItem("First item");
+list.addItem("Second item");
+list.removeItemAt(0); // "First item"
+list.getItems(); // ["Second item"]
+list.removeItemAt(2); // undefined
+```
+**Since**: 0.2.0
* * *
-
+
-## TabStop
-This class represents a tab stop.
+### `list.clear()` ⇒ [List](#List)
+The `clear()` method removes all items from the list.
-Tab stops are used to align text in a paragraph.
-To become effective they must be set to the style of the respective paragraph.
+**Return value**
+[List](#List) - The `List` object
-**Since**: 0.3.0
+**Example**
+```js
+const list = new List();
+list.addItem("First item"); // "First item"
+list.addItem("Second item"); // "First item", "Second item"
+list.clear(); // -
+```
+**Since**: 0.2.0
-* [TabStop](#TabStop)
- * [`new TabStop([position], [type])`](#new_TabStop_new)
- * [`.setPosition(position)`](#TabStop+setPosition)
- * [`.getPosition()`](#TabStop+getPosition) ⇒ number
- * [`.setType(type)`](#TabStop+setType)
- * [`.getType()`](#TabStop+getType) ⇒ TabStopType
- * [`.toXml(document, parent)`](#TabStop+toXml)
+* * *
+
+
+### `list.size()` ⇒ number
+The `size()` method returns the number of items in the list.
+
+**Return value**
+number - The number of items in this list
+
+**Example**
+```js
+const list = new List();
+list.size(); // 0
+list.addItem("First item");
+list.addItem("Second item");
+list.size(); // 2
+```
+**Since**: 0.2.0
* * *
-
+
-### `new TabStop([position], [type])`
-Creates a tab stop to be set to the style of a paragraph.
+## ListItem
+This class represents an item in a list.
+
+**Since**: 0.2.0
+
+* * *
+
+
+
+### `new ListItem([text])`
+Creates a `ListItem` instance that represents an item in a list.
#### Parameters
-- [position] number
-The position of the tab stop in centimeters relative to the left margin.
-If a negative value is given, the `position` will be set to `0`.
-- [type] TabStopType
-The type of the tab stop. Defaults to `TabStopType.Left`.
+- [text] string = "\"\""
+The text content of the list item; defaults to an empty string if omitted
**Example**
```js
-// creates a right aligned tab stop with a distance of 4 cm from the left margin
-const tabStop4 = new TabStop(4, TabStopType.Right);
-paragraph.getStyle().addTabStop(tabStop4);
+const list = document.getBody()
+ .addList()
+ .addItem("First item");
```
* * *
-
+
-### `tabStop.setPosition(position)`
-Sets the position of this tab stop.
+## Paragraph
+This class represents a paragraph.
-#### Parameters
-- position number
-The position of the tab stop in centimeters relative to the left margin.
-If a negative value is given, the `position` will be set to `0`.
+**Since**: 0.1.0
+
+* [Paragraph](#Paragraph)
+ * [`new Paragraph([text])`](#new_Paragraph_new)
+ * [`.addText(text)`](#Paragraph+addText) ⇒ [Paragraph](#Paragraph)
+ * [`.getText()`](#Paragraph+getText) ⇒ string
+ * [`.setText(text)`](#Paragraph+setText) ⇒ [Paragraph](#Paragraph)
+ * [`.addHyperlink(text, uri)`](#Paragraph+addHyperlink) ⇒ [Hyperlink](#Hyperlink)
+ * [`.addImage(path)`](#Paragraph+addImage) ⇒ [Image](#Image)
+ * [`.setStyle(style)`](#Paragraph+setStyle) ⇒ [Paragraph](#Paragraph)
+ * [`.getStyle()`](#Paragraph+getStyle) ⇒ IParagraphStyle \| undefined
-**Since**: 0.3.0
* * *
-
+
-### `tabStop.getPosition()` ⇒ number
-Returns the position of this tab stop.
+### `new Paragraph([text])`
+Creates a `Paragraph` instance.
-**Return value**
-number - The position of this tab stop in centimeters
+#### Parameters
+- [text] string
+The text content of the paragraph; defaults to an empty string if omitted
-**Since**: 0.3.0
+**Example**
+```js
+document.getBody().addParagraph("Some text")
+ .addText("\nEven more text")
+ .addImage("/home/homer/myself.png");
+```
* * *
-
+
-### `tabStop.setType(type)`
-Sets the type of this tab stop.
+### `paragraph.addText(text)` ⇒ [Paragraph](#Paragraph)
+Appends the specified text to the end of the paragraph.
#### Parameters
-- type TabStopType
-The type of the tab stop
+- text string
+The additional text content
-**Since**: 0.3.0
+**Return value**
+[Paragraph](#Paragraph) - The `Paragraph` object
+
+**Example**
+```js
+new Paragraph("Some text") // Some text
+ .addText("\nEven more text"); // Some text\nEven more text
+```
+**Since**: 0.1.0
* * *
-
+
-### `tabStop.getType()` ⇒ TabStopType
-Returns the type of this tab stop.
+### `paragraph.getText()` ⇒ string
+Returns the text content of the paragraph.
+Note: This will only return the text; other elements and markup will be omitted.
**Return value**
-TabStopType - The type of this tab stop
+string - The text content of the paragraph
-**Since**: 0.3.0
+**Example**
+```js
+const paragraph = new Paragraph("Some text, ");
+paragraph.addHyperlink("some linked text");
+paragraph.addText(", even more text");
+paragraph.getText(); // Some text, some linked text, even more text
+```
+**Since**: 0.1.0
* * *
-
+
-### `tabStop.toXml(document, parent)`
-Transforms the tab stop into Open Document Format.
+### `paragraph.setText(text)` ⇒ [Paragraph](#Paragraph)
+Sets the text content of the paragraph.
+Note: This will replace any existing content of the paragraph.
#### Parameters
-- document Document
-The XML document
-- parent Element
-The parent node in the DOM (`style:tab-stops`)
+- text string
+The new text content
-**Since**: 0.3.0
+**Return value**
+[Paragraph](#Paragraph) - The `Paragraph` object
+
+**Example**
+```js
+new Paragraph("Some text") // Some text
+ .setText("Some other text"); // Some other text
+```
+**Since**: 0.1.0
* * *
-
+
-## Heading
-This class represents a heading.
+### `paragraph.addHyperlink(text, uri)` ⇒ [Hyperlink](#Hyperlink)
+Appends the specified text as hyperlink to the end of the paragraph.
-**Since**: 0.1.0
+#### Parameters
+- text string
+The text content of the hyperlink
+- uri string
+The target URI of the hyperlink
-* [Heading](#Heading)
- * [`new Heading([text], [level])`](#new_Heading_new)
- * [`.setLevel(level)`](#Heading+setLevel)
- * [`.getLevel()`](#Heading+getLevel) ⇒ number
- * [`.createElement()`](#Heading+createElement)
+**Return value**
+[Hyperlink](#Hyperlink) - The added `Hyperlink` object
+**Example**
+```js
+new Paragraph("Some text, ") // Some text,
+ .addHyperlink("some linked text"); // Some text, some linked text
+```
+**Since**: 0.3.0
* * *
-
+
-### `new Heading([text], [level])`
-Creates a heading
+### `paragraph.addImage(path)` ⇒ [Image](#Image)
+Appends the image of the denoted path to the end of the paragraph.
+The current paragraph will be set as anchor for the image.
#### Parameters
-- [text] string
-The text content of the heading
-- [level] number
-The heading level; defaults to 1 if omitted
+- path string
+The path to the image file
+
+**Return value**
+[Image](#Image) - The added `Image` object
+**Example**
+```js
+new Paragraph("Some text")
+ .addImage("/home/homer/myself.png");
+```
+**Since**: 0.3.0
* * *
-
+
-### `heading.setLevel(level)`
-Sets the level of this heading.
+### `paragraph.setStyle(style)` ⇒ [Paragraph](#Paragraph)
+Sets the new style of the paragraph.
+To reset the style, `undefined` must be given.
#### Parameters
-- level number
-The heading level
+- style IParagraphStyle | undefined
+The new style or `undefined` to reset the style
-**Since**: 0.1.0
+**Return value**
+[Paragraph](#Paragraph) - The `Paragraph` object
+
+**Example**
+```js
+new Paragraph("Some text")
+ .setStyle(new ParagraphStyle());
+```
+**Since**: 0.3.0
* * *
-
+
-### `heading.getLevel()` ⇒ number
-Returns the level of this heading.
+### `paragraph.getStyle()` ⇒ IParagraphStyle \| undefined
+Returns the style of the paragraph.
**Return value**
-number - The heading level
-
-**Since**: 0.1.0
-
-* * *
-
-
+IParagraphStyle \| undefined - The style of the paragraph or `undefined` if no style was set
-### `heading.createElement()`
+**Example**
+```js
+const paragraph = new Paragraph("Some text");
+paragraph.getStyle(); // undefined
+paragraph.setStyle(new ParagraphStyle());
+paragraph.getStyle(); // previously set style
+```
+**Since**: 0.3.0
* * *
-
+
-## Hyperlink
-This class represents a hyperlink in a paragraph.
+## Color
+This class represents a Color.
-**Since**: 0.3.0
+**Since**: 0.4.0
-* [Hyperlink](#Hyperlink)
- * [`new Hyperlink(text, uri)`](#new_Hyperlink_new)
- * [`.setURI(uri)`](#Hyperlink+setURI)
- * [`.getURI()`](#Hyperlink+getURI) ⇒ string
- * [`.toXml()`](#Hyperlink+toXml)
+* [Color](#Color)
+ * [`new Color(red, green, blue)`](#new_Color_new)
+ * _instance_
+ * [`.toHex()`](#Color+toHex) ⇒ string
+ * _static_
+ * [`.fromHex(value)`](#Color.fromHex) ⇒ [Color](#Color) \| never
+ * [`.fromRgb(red, green, blue)`](#Color.fromRgb) ⇒ [Color](#Color) \| never
* * *
-
+
-### `new Hyperlink(text, uri)`
-Creates a hyperlink
+### `new Color(red, green, blue)`
+Creates a new color with the specified channel values.
#### Parameters
-- text string
-The text content of the hyperlink
-- uri string
-The target URI of the hyperlink
+- red number
+The red channel of the color
+- green number
+The green channel of the color
+- blue number
+The blue channel of the color
* * *
-
+
-### `hyperlink.setURI(uri)`
-Sets the target URI for this hyperlink.
+### `color.toHex()` ⇒ string
+The toHex() method returns a string representing the color as hex string.
-#### Parameters
-- uri string
-The new target URI
+**Return value**
+string - A hex string representing the color
-**Since**: 0.3.0
+**Since**: 0.4.0
* * *
-
+
-### `hyperlink.getURI()` ⇒ string
-Returns the target URI of this hyperlink.
+### `Color.fromHex(value)` ⇒ [Color](#Color) \| never
+The `Color.fromHex()` method parses a string argument and returns a color.
+The string is expected to be in `#rrggbb` or `rrggbb` format.
-**Return value**
-string - The target URI
+#### Parameters
+- value string
+The value you want to parse
-**Since**: 0.3.0
+**Return value**
+[Color](#Color) \| never - A color parsed from the given value
-* * *
+**Throws**:
-
+- Error If the value cannot be converted to a color
-### `hyperlink.toXml()`
+**Since**: 0.4.0
* * *
-
+
-## List
-This class represents a list.
-It can contain multiple list items.
+### `Color.fromRgb(red, green, blue)` ⇒ [Color](#Color) \| never
+The `Color.fromRgb()` method returns a color with the channel arguments.
-**Since**: 0.2.0
+#### Parameters
+- red number
+The red channel of the color with a range of 0...255
+- green number
+The green channel of the color with a range of 0...255
+- blue number
+The blue channel of the color with a range of 0...255
-* [List](#List)
- * [`new List()`](#new_List_new)
- * [`.addItem([item])`](#List+addItem) ⇒ [ListItem](#ListItem)
- * [`.insertItem(position, item)`](#List+insertItem) ⇒ [ListItem](#ListItem)
- * [`.getItem(position)`](#List+getItem) ⇒ [ListItem](#ListItem) \| undefined
- * [`.getItems()`](#List+getItems) ⇒ [Array.<ListItem>](#ListItem)
- * [`.removeItemAt(position)`](#List+removeItemAt) ⇒ [ListItem](#ListItem) \| undefined
- * [`.clear()`](#List+clear)
- * [`.size()`](#List+size) ⇒ number
- * [`.toXml()`](#List+toXml)
+**Return value**
+[Color](#Color) \| never - A color parsed from the given value
+
+**Throws**:
+- Error If any channel is outside the allowable range
+
+**Since**: 0.4.0
* * *
-
+
-### `new List()`
-Creates a list
+## ImageStyle
+This class represents the style of an image
+**Since**: 0.5.0
-* * *
+* [ImageStyle](#ImageStyle)
+ * [`new ImageStyle()`](#new_ImageStyle_new)
+ * [`.setAnchorType()`](#ImageStyle+setAnchorType)
+ * [`.getAnchorType()`](#ImageStyle+getAnchorType)
+ * [`.setHeight(height)`](#ImageStyle+setHeight)
+ * [`.getHeight()`](#ImageStyle+getHeight) ⇒ number \| undefined
+ * [`.setWidth(width)`](#ImageStyle+setWidth)
+ * [`.getWidth()`](#ImageStyle+getWidth) ⇒ number \| undefined
+ * [`.setSize(width, height)`](#ImageStyle+setSize)
+ * [`.toXml()`](#ImageStyle+toXml)
-
-### `list.addItem([item])` ⇒ [ListItem](#ListItem)
-Adds a new list item with the specified text or adds the specified item to the list.
+* * *
-#### Parameters
-- [item] string | [ListItem](#ListItem)
-The text content of the new item or the item to add
+
-**Return value**
-[ListItem](#ListItem) - The newly added list item
+### `new ImageStyle()`
+Constructor.
-**Since**: 0.2.0
* * *
-
+
-### `list.insertItem(position, item)` ⇒ [ListItem](#ListItem)
-Inserts a new list item with the specified text or inserts the specified item at the specified position.
-The item is inserted before the item at the specified position.
+### `imageStyle.setAnchorType()`
-#### Parameters
-- position number
-The index at which to insert the list item (starting from 0).
-- item string | [ListItem](#ListItem)
-The text content of the new item or the item to insert
+* * *
-**Return value**
-[ListItem](#ListItem) - The newly added list item
+
-**Since**: 0.2.0
+### `imageStyle.getAnchorType()`
* * *
-
+
-### `list.getItem(position)` ⇒ [ListItem](#ListItem) \| undefined
-Returns the item at the specified position in this list.
-If an invalid position is given, undefined is returned.
+### `imageStyle.setHeight(height)`
+Sets the target height of the image.
#### Parameters
-- position number
-The index of the requested the list item (starting from 0).
-
-**Return value**
-[ListItem](#ListItem) \| undefined - The list item at the specified position
-or undefined if there is no list item at the specified position
+- height number
+The target height of the image in millimeter
-**Since**: 0.2.0
+**Since**: 0.5.0
* * *
-
+
-### `list.getItems()` ⇒ [Array.<ListItem>](#ListItem)
-Returns all list items.
+### `imageStyle.getHeight()` ⇒ number \| undefined
+Returns the target height of the image or `undefined` if no height was set.
**Return value**
-[Array.<ListItem>](#ListItem) - A copy of the list of list items
+number \| undefined - The target height of the image in millimeter or `undefined` if no height was set
-**Since**: 0.2.0
+**Since**: 0.5.0
* * *
-
+
-### `list.removeItemAt(position)` ⇒ [ListItem](#ListItem) \| undefined
-Removes the list item from the specified position.
+### `imageStyle.setWidth(width)`
+Sets the target width of the image.
#### Parameters
-- position number
-The index of the list item to remove (starting from 0).
-
-**Return value**
-[ListItem](#ListItem) \| undefined - The removed list item
-or undefined if there is no list item at the specified position
+- width number
+The target width of the image in millimeter
-**Since**: 0.2.0
+**Since**: 0.5.0
* * *
-
+
+
+### `imageStyle.getWidth()` ⇒ number \| undefined
+Returns the target width of the image or `undefined` if no width was set.
-### `list.clear()`
-Removes all items from this list.
+**Return value**
+number \| undefined - The target width of the image in millimeter or `undefined` if no width was set
-**Since**: 0.2.0
+**Since**: 0.5.0
* * *
-
+
-### `list.size()` ⇒ number
-Returns the number of items in this list.
+### `imageStyle.setSize(width, height)`
+Sets the target size of the image.
-**Return value**
-number - The number of items in this list
+#### Parameters
+- width number
+The target width of the image in millimeter
+- height number
+The target height of the image in millimeter
-**Since**: 0.2.0
+**Since**: 0.5.0
* * *
-
+
-### `list.toXml()`
+### `imageStyle.toXml()`
* * *
-
+
-## ListItem
-This class represents an item in a list.
+## ParagraphStyle
+This class represents the style of a paragraph
-**Since**: 0.2.0
+**Since**: 0.4.0
-* [ListItem](#ListItem)
- * [`new ListItem([text])`](#new_ListItem_new)
- * [`.toXml()`](#ListItem+toXml)
+* [ParagraphStyle](#ParagraphStyle)
+ * [`new ParagraphStyle()`](#new_ParagraphStyle_new)
+ * [`.setColor()`](#ParagraphStyle+setColor)
+ * [`.getColor()`](#ParagraphStyle+getColor)
+ * [`.setFontName()`](#ParagraphStyle+setFontName)
+ * [`.getFontName()`](#ParagraphStyle+getFontName)
+ * [`.setFontSize()`](#ParagraphStyle+setFontSize)
+ * [`.getFontSize()`](#ParagraphStyle+getFontSize)
+ * [`.setTextTransformation()`](#ParagraphStyle+setTextTransformation)
+ * [`.getTextTransformation()`](#ParagraphStyle+getTextTransformation)
+ * [`.setTypeface()`](#ParagraphStyle+setTypeface)
+ * [`.getTypeface()`](#ParagraphStyle+getTypeface)
+ * [`.setHorizontalAlignment()`](#ParagraphStyle+setHorizontalAlignment)
+ * [`.getHorizontalAlignment()`](#ParagraphStyle+getHorizontalAlignment)
+ * [`.setPageBreakBefore()`](#ParagraphStyle+setPageBreakBefore)
+ * [`.setKeepTogether()`](#ParagraphStyle+setKeepTogether)
+ * [`.getTabStops()`](#ParagraphStyle+getTabStops)
+ * [`.clearTabStops()`](#ParagraphStyle+clearTabStops)
+ * [`.toXml()`](#ParagraphStyle+toXml)
* * *
-
-
-### `new ListItem([text])`
-Creates a list item
+
-#### Parameters
-- [text] string
-The text content of the list item
+### `new ParagraphStyle()`
+Constructor.
* * *
-
+
-### `listItem.toXml()`
+### `paragraphStyle.setColor()`
* * *
-
+
-## Paragraph
-This class represents a paragraph.
+### `paragraphStyle.getColor()`
-**Since**: 0.1.0
+* * *
-* [Paragraph](#Paragraph)
- * [`new Paragraph([text])`](#new_Paragraph_new)
- * [`.addText(text)`](#Paragraph+addText)
- * [`.getText()`](#Paragraph+getText) ⇒ string
- * [`.setText(text)`](#Paragraph+setText)
- * [`.addHyperlink(text, uri)`](#Paragraph+addHyperlink) ⇒ [Hyperlink](#Hyperlink)
- * [`.addImage(path)`](#Paragraph+addImage) ⇒ [Image](#Image)
- * [`.setStyle(style)`](#Paragraph+setStyle)
- * [`.getStyle()`](#Paragraph+getStyle) ⇒ IParagraphStyle \| undefined
- * [`.createElement(document)`](#Paragraph+createElement) ⇒ Element
- * [`.toXml()`](#Paragraph+toXml)
+
+### `paragraphStyle.setFontName()`
* * *
-
+
-### `new Paragraph([text])`
-Creates a paragraph
+### `paragraphStyle.getFontName()`
-#### Parameters
-- [text] string
-The text content of the paragraph
+* * *
+
+
+### `paragraphStyle.setFontSize()`
* * *
-
+
+
+### `paragraphStyle.getFontSize()`
-### `paragraph.addText(text)`
-Appends the specified text to the end of this paragraph.
+* * *
-#### Parameters
-- text string
-The additional text content
+
-**Since**: 0.1.0
+### `paragraphStyle.setTextTransformation()`
* * *
-
+
-### `paragraph.getText()` ⇒ string
-Returns the text content of this paragraph.
-Note: This will only return the text; other elements and markup will be omitted.
+### `paragraphStyle.getTextTransformation()`
-**Return value**
-string - The text content of this paragraph
+* * *
-**Since**: 0.1.0
+
+
+### `paragraphStyle.setTypeface()`
* * *
-
+
-### `paragraph.setText(text)`
-Sets the text content of this paragraph.
-Note: This will replace any existing content of the paragraph.
+### `paragraphStyle.getTypeface()`
-#### Parameters
-- text string
-The new text content
+* * *
-**Since**: 0.1.0
+
+
+### `paragraphStyle.setHorizontalAlignment()`
* * *
-
+
-### `paragraph.addHyperlink(text, uri)` ⇒ [Hyperlink](#Hyperlink)
-Appends the specified text as hyperlink to the end of this paragraph.
+### `paragraphStyle.getHorizontalAlignment()`
-#### Parameters
-- text string
-The text content of the hyperlink
-- uri string
-The target URI of the hyperlink
+* * *
-**Return value**
-[Hyperlink](#Hyperlink) - The newly added hyperlink
+
-**Since**: 0.3.0
+### `paragraphStyle.setPageBreakBefore()`
* * *
-
+
-### `paragraph.addImage(path)` ⇒ [Image](#Image)
-Appends the image of the denoted path to the end of this paragraph.
-The current paragraph will be set as anchor for the image.
+### `paragraphStyle.setKeepTogether()`
-#### Parameters
-- path string
-The path to the image file
+* * *
-**Return value**
-[Image](#Image) - The newly added image
+
-**Since**: 0.3.0
+### `paragraphStyle.getTabStops()`
* * *
-
+
-### `paragraph.setStyle(style)`
-Sets the new style of this paragraph.
-To reset the style, `undefined` must be given.
+### `paragraphStyle.clearTabStops()`
-#### Parameters
-- style IParagraphStyle | undefined
-The new style or `undefined` to reset the style
+* * *
-**Since**: 0.3.0
+
-* * *
+### `paragraphStyle.toXml()`
-
+* * *
-### `paragraph.getStyle()` ⇒ IParagraphStyle \| undefined
-Returns the style of this paragraph.
+
-**Return value**
-IParagraphStyle \| undefined - The style of the paragraph or `undefined` if no style was set
+## StyleHelper
+Utility class for dealing with styles.
-**Since**: 0.3.0
+**Since**: 0.4.0
* * *
-
+
-### `paragraph.createElement(document)` ⇒ Element
-Creates the paragraph element.
+### `StyleHelper.getAutomaticStylesElement(document)` ⇒ Element
+Returns the `automatic-styles` element of the document.
+If there is no such element yet, it will be created.
#### Parameters
- document Document
The XML document
**Return value**
-Element - The DOM element representing this paragraph
+Element - The documents `automatic-styles` element
-**Since**: 0.1.0
+**Since**: 0.4.0
* * *
-
-
-### `paragraph.toXml()`
-
-* * *
+
-
+## TabStop
+This class represents a tab stop.
-## TextDocument
-This class represents an empty ODF text document.
+Tab stops are used to align text in a paragraph.
+To become effective they must be set to the style of the respective paragraph.
-**Since**: 0.1.0
+**Since**: 0.3.0
-* [TextDocument](#TextDocument)
- * [`.getMeta()`](#TextDocument+getMeta) ⇒ [Meta](#Meta)
- * [`.declareFont(name, fontFamily, fontPitch)`](#TextDocument+declareFont)
- * [`.addHeading([text], [level])`](#TextDocument+addHeading) ⇒ [Heading](#Heading)
- * [`.addList()`](#TextDocument+addList) ⇒ [List](#List)
- * [`.addParagraph([text])`](#TextDocument+addParagraph) ⇒ [Paragraph](#Paragraph)
- * [`.saveFlat(filePath)`](#TextDocument+saveFlat) ⇒ Promise.<void>
- * ~~[`.toString()`](#TextDocument+toString) ⇒ string~~
- * [`.toXml()`](#TextDocument+toXml)
+* [TabStop](#TabStop)
+ * [`new TabStop([position], [type])`](#new_TabStop_new)
+ * [`.setPosition(position)`](#TabStop+setPosition)
+ * [`.getPosition()`](#TabStop+getPosition) ⇒ number
+ * [`.setType(type)`](#TabStop+setType)
+ * [`.getType()`](#TabStop+getType) ⇒ TabStopType
+ * [`.toXml(document, parent)`](#TabStop+toXml)
* * *
-
+
-### `textDocument.getMeta()` ⇒ [Meta](#Meta)
-The `getMeta()` method returns the metadata of the document.
+### `new TabStop([position], [type])`
+Creates a tab stop to be set to the style of a paragraph.
-**Return value**
-[Meta](#Meta) - An object holding the metadata of the document
+#### Parameters
+- [position] number
+The position of the tab stop in centimeters relative to the left margin.
+If a negative value is given, the `position` will be set to `0`.
+- [type] TabStopType
+The type of the tab stop. Defaults to `TabStopType.Left`.
-**See**: [Meta](#Meta)
**Example**
```js
-document.getMeta().setCreator('Lisa Simpson');
+// creates a right aligned tab stop with a distance of 4 cm from the left margin
+const tabStop4 = new TabStop(4, TabStopType.Right);
+paragraph.getStyle().addTabStop(tabStop4);
```
-**Since**: 0.6.0
* * *
-
-
-### `textDocument.declareFont(name, fontFamily, fontPitch)`
-Declares a font to be used in the document.
+
-**Note: There is no check whether the font exists.
-In order to be displayed properly, the font must be present on the target system.**
+### `tabStop.setPosition(position)`
+Sets the position of this tab stop.
#### Parameters
-- name string
-The name of the font; this name must be set to a [ParagraphStyle](#ParagraphStyle)
-- fontFamily string
-The name of the font family
-- fontPitch FontPitch
-The ptich of the fonr
+- position number
+The position of the tab stop in centimeters relative to the left margin.
+If a negative value is given, the `position` will be set to `0`.
-**Since**: 0.4.0
+**Since**: 0.3.0
* * *
-
-
-### `textDocument.addHeading([text], [level])` ⇒ [Heading](#Heading)
-Adds a heading at the end of the document.
-If a text is given, this will be set as text content of the heading.
+
-#### Parameters
-- [text] string
-The text content of the heading
-- [level] number = 1
-The heading level; defaults to 1 if omitted
+### `tabStop.getPosition()` ⇒ number
+Returns the position of this tab stop.
**Return value**
-[Heading](#Heading) - The newly added heading
+number - The position of this tab stop in centimeters
-**Since**: 0.1.0
+**Since**: 0.3.0
* * *
-
+
-### `textDocument.addList()` ⇒ [List](#List)
-Adds an empty list at the end of the document.
+### `tabStop.setType(type)`
+Sets the type of this tab stop.
-**Return value**
-[List](#List) - The newly added list
+#### Parameters
+- type TabStopType
+The type of the tab stop
-**Since**: 0.2.0
+**Since**: 0.3.0
* * *
-
-
-### `textDocument.addParagraph([text])` ⇒ [Paragraph](#Paragraph)
-Adds a paragraph at the end of the document.
-If a text is given, this will be set as text content of the paragraph.
+
-#### Parameters
-- [text] string
-The text content of the paragraph
+### `tabStop.getType()` ⇒ TabStopType
+Returns the type of this tab stop.
**Return value**
-[Paragraph](#Paragraph) - The newly added paragraph
+TabStopType - The type of this tab stop
-**Since**: 0.1.0
+**Since**: 0.3.0
* * *
-
+
-### `textDocument.saveFlat(filePath)` ⇒ Promise.<void>
-Saves the document in flat open document xml format.
+### `tabStop.toXml(document, parent)`
+Transforms the tab stop into Open Document Format.
#### Parameters
-- filePath string
-The file path to write to
-
-**Since**: 0.1.0
-
-* * *
-
-
-
-### ~~`textDocument.toString()` ⇒ string~~
-***Deprecated***
-
-Returns the string representation of this document in flat open document xml format.
-
-**Return value**
-string - The string representation of this document
-
-**Since**: 0.1.0
-
-* * *
-
-
+- document Document
+The XML document
+- parent Element
+The parent node in the DOM (`style:tab-stops`)
-### `textDocument.toXml()`
+**Since**: 0.3.0
* * *
diff --git a/package.json b/package.json
index ca7e1d58..d10e5aaf 100644
--- a/package.json
+++ b/package.json
@@ -35,8 +35,8 @@
"test": "jest",
"watch-test": "jest --watch",
"coverage": "jest --coverage",
- "lint": "tslint -c tslint.json 'src/**/*.ts', 'test/**/*.ts'",
- "docs": "rm -r ./lib && tsc && jsdoc2md --name-format --param-list-format list --separators --partial ./jsdoc2md/body.hbs ./jsdoc2md/params-list.hbs ./jsdoc2md/returns.hbs ./jsdoc2md/scope.hbs --files ./lib/**/*.js ./lib/*.js > ./docs/API.md"
+ "lint": "tslint -c tslint.json 'src/**/*.ts'",
+ "docs": "rm -r ./lib && tsc && jsdoc2md --name-format --param-list-format list --separators --partial ./jsdoc2md/body.hbs ./jsdoc2md/params-list.hbs ./jsdoc2md/returns.hbs ./jsdoc2md/scope.hbs --files ./lib/api/**/*.js ./lib/style/**/*.js > ./docs/API.md"
},
"dependencies": {
"xmldom": "^0.1.27"
diff --git a/src/TextDocument.spec.ts b/src/TextDocument.spec.ts
deleted file mode 100644
index 53f23d2e..00000000
--- a/src/TextDocument.spec.ts
+++ /dev/null
@@ -1,150 +0,0 @@
-import { readFile, unlink } from "fs";
-import { promisify } from "util";
-import { Meta } from "./meta/Meta";
-import { FontPitch } from "./style/FontPitch";
-import { Heading } from "./text/Heading";
-import { List } from "./text/List";
-import { Paragraph } from "./text/Paragraph";
-import { TextDocument, XML_DECLARATION } from "./TextDocument";
-
-const FILEPATH = "./test.fodt";
-
-jest.mock("../src/meta/Meta");
-
-describe(TextDocument.name, () => {
-
- /* tslint:disable-next-line:max-line-length */
- const baseDocument = 'super.toXML(...).
- *
- * @param {Document} document The XML document
- * @param {Element} parent The parent node
- * @since 0.1.0
- */
- protected toXml(document: Document, parent: Element): void {
- this.children.forEach((child: OdfElement) => {
- child.toXml(document, parent);
- });
- }
}
diff --git a/src/api/draw/Image.spec.ts b/src/api/draw/Image.spec.ts
new file mode 100644
index 00000000..d8c37803
--- /dev/null
+++ b/src/api/draw/Image.spec.ts
@@ -0,0 +1,46 @@
+import { AnchorType } from "../../style/AnchorType";
+import { ImageStyle } from "../../style/ImageStyle";
+import { Image } from "./Image";
+
+describe(Image.name, () => {
+ const testImagePath = "/some/image.path.png";
+
+ let image: Image;
+
+ beforeEach(() => {
+ image = new Image(testImagePath);
+ });
+
+ describe("path", () => {
+ it("return initial path", () => {
+ expect(image.getPath()).toBe(testImagePath);
+ });
+ });
+
+ describe("style", () => {
+ let testStyle: ImageStyle;
+
+ beforeEach(() => {
+ testStyle = new ImageStyle();
+ });
+
+ it("return style by default", () => {
+ expect(image.getStyle()).toBeInstanceOf(ImageStyle);
+ });
+
+ it("return previous set style", () => {
+ testStyle.setAnchorType(AnchorType.AsChar);
+
+ image.setStyle(testStyle);
+
+ expect(image.getStyle()).toBe(testStyle);
+ });
+
+ it("ignore invalid input", () => {
+ image.setStyle(testStyle);
+ image.setStyle(