docs: update documentation

schoero · Oct 1, 2023 · 60ea763 · 60ea763
1 parent 229d082
commit 60ea763
Show file tree

Hide file tree

Showing 5 changed files with 274 additions and 346 deletions.
diff --git a/docs/pdf/swissqrbill.md b/docs/pdf/swissqrbill.md
@@ -9,10 +9,6 @@
 
       - [constructor(data\[, options\])](#constructordata-options)
 
-    - Property
-
-      - [data](#data)
-
     - Method
 
       - [attachTo(doc, xPosition, yPosition)](#attachtodoc-xposition-yposition)
@@ -29,7 +25,7 @@ Defined in: [pdf/swissqrbill.ts](../pdf/swissqrbill.ts#L14C0)
 
 ##### constructor(data\[, options\])
 
-Defined in: [pdf/swissqrbill.ts](../pdf/swissqrbill.ts#L28C2)  
+Defined in: [pdf/swissqrbill.ts](../pdf/swissqrbill.ts#L27C2)  
 
 ###### Parameters
 
@@ -40,18 +36,6 @@ Defined in: [pdf/swissqrbill.ts](../pdf/swissqrbill.ts#L28C2)
 
 [SwissQRBill](#swissqrbill)  
 
-### Property
-
-#### data
-
-`protected`  
-
-Defined in: [pdf/swissqrbill.ts](../pdf/swissqrbill.ts#L16C2)  
-
-##### Type
-
-[`Data`](./types.md#data)  
-
 ### Method
 
 ---
@@ -60,7 +44,7 @@ Defined in: [pdf/swissqrbill.ts](../pdf/swissqrbill.ts#L16C2)
 
 `public`  
 
-Defined in: [pdf/swissqrbill.ts](../pdf/swissqrbill.ts#L72C2)  
+Defined in: [pdf/swissqrbill.ts](../pdf/swissqrbill.ts#L71C2)  
 
 ##### Parameters
 

diff --git a/docs/pdf/types.md b/docs/pdf/types.md
@@ -9,9 +9,6 @@
 
 - Interfaces
 
-  - [PDFColumn](#pdfcolumn)
-  - [PDFRow](#pdfrow)
-  - [PDFTable](#pdftable)
   - [Data](#data)
   - [Debtor](#debtor)
   - [Creditor](#creditor)
@@ -25,7 +22,7 @@
 
 ### Currency
 
-Defined in: [src/shared/types.ts](../../src/shared/types.ts#L6C0)  
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L5C0)  
 
 #### Type
 
@@ -35,7 +32,7 @@ Defined in: [src/shared/types.ts](../../src/shared/types.ts#L6C0)
 
 ### Size
 
-Defined in: [src/shared/types.ts](../../src/shared/types.ts#L7C0)  
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L6C0)  
 
 #### Type
 
@@ -45,7 +42,7 @@ Defined in: [src/shared/types.ts](../../src/shared/types.ts#L7C0)
 
 ### Languages
 
-Defined in: [src/shared/types.ts](../../src/shared/types.ts#L8C0)  
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L7C0)  
 
 #### Type
 
@@ -55,158 +52,9 @@ Defined in: [src/shared/types.ts](../../src/shared/types.ts#L8C0)
 
 ---
 
-### PDFColumn
-
-Defined in: [pdf/table.ts](../pdf/table.ts#L65C0)  
-
-- **text** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) | [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) Cell text.
-- **align** `"center"` | `"left"` | `"right"` Horizontal alignment of the text inside the cell `optional`
-- **backgroundColor** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) Background color of the cell. `optional`
-- **border** `union` Width of the borders of the row. `optional`
-
-  - [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-  - `tuple`
-
-    - top [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-    - right [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-    - bottom [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-    - left [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-
-- **borderColor** `union` The colors of the border `optional`
-
-  - [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
-  - `tuple`
-
-    - top [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
-    - right [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
-    - bottom [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
-    - left [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
-
-- **font** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) Font of the text inside the cell. `optional`
-- **fontSize** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) Font size of the text inside the cell. `optional`
-- **padding** `union` Cell padding of the table cell. `optional`
-
-  - [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-  - `tuple`
-
-    - top [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-    - right [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-    - bottom [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-    - left [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-
-- **textColor** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) Text color of texts inside the cell. `optional`
-- **textOptions** `TextOptions` Same as text [PDFKit text options](http://pdfkit.org/docs/text.html#text_styling). `optional`
-- **verticalAlign** `"bottom"` | `"center"` | `"top"` Vertical alignment of the text inside the cell `optional`
-- **width** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) Width of the cell. `optional`
-
----
-
-### PDFRow
-
-Defined in: [pdf/table.ts](../pdf/table.ts#L32C0)  
-
-- **columns** [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) Table columns.
-
-  - [`PDFColumn`](#pdfcolumn)
-
-- **align** `"center"` | `"left"` | `"right"` Horizontal alignment of texts inside the row `optional`
-- **backgroundColor** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) Background color of the row. `optional`
-- **border** `union` Width of the borders of the row. `optional`
-
-  - [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-  - `tuple`
-
-    - top [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-    - right [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-    - bottom [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-    - left [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-
-- **borderColor** `union` The colors of the border `optional`
-
-  - [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
-  - `tuple`
-
-    - top [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
-    - right [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
-    - bottom [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
-    - left [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
-
-- **font** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) Font of the text inside the row. `optional`
-- **fontSize** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) Font size of the text inside the row. `optional`
-- **header** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) A header row gets inserted automatically on new pages. Only one header row is allowed. `optional`
-- **height** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) Height of the row. Overrides minHeight and maxHeight `optional`
-- **maxHeight** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) Maximum height of the row `optional`
-- **minHeight** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) Minimum height of the row `optional`
-- **padding** `union` Cell padding of the table cells inside the row. `optional`
-
-  - [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-  - `tuple`
-
-    - top [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-    - right [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-    - bottom [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-    - left [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-
-- **textColor** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) Text color of texts inside the row. `optional`
-- **textOptions** `TextOptions` Same as text [PDFKit text options](http://pdfkit.org/docs/text.html#text_styling). `optional`
-- **verticalAlign** `"bottom"` | `"center"` | `"top"` Vertical alignment of texts inside the row `optional`
-
----
-
-### PDFTable
-
-Defined in: [pdf/table.ts](../pdf/table.ts#L1C0)  
-
-- **rows** [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) Table rows.
-
-  - [`PDFRow`](#pdfrow)
-
-- **align** `"center"` | `"left"` | `"right"` Horizontal alignment of texts inside the table `optional`
-- **backgroundColor** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) Background color of the table. `optional`
-- **border** `union` Width of the borders of the row. `optional`
-
-  - [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-  - `tuple`
-
-    - top [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-    - right [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-    - bottom [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-    - left [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-
-- **borderColor** `union` The colors of the border `optional`
-
-  - [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
-  - `tuple`
-
-    - top [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
-    - right [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
-    - bottom [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
-    - left [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
-
-- **font** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) Font of the text inside the table. `optional`
-- **fontSize** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) Font size of the text inside the table. `optional`
-- **padding** `union` Cell padding of the table cells. `optional`
-
-  - [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-  - `tuple`
-
-    - top [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-    - right [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-    - bottom [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-    - left [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
-
-- **textColor** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) Text color of texts inside table. `optional`
-- **textOptions** `TextOptions` Same as text [PDFKit text options](http://pdfkit.org/docs/text.html#text_styling). `optional`
-- **verticalAlign** `"bottom"` | `"center"` | `"top"` Vertical alignment of texts inside the table `optional`
-- **width** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) Width of whole table. `optional`
-- **x** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) Horizontal start position of the table. `optional`
-- **y** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) Vertical start position of the table. `optional`
-
----
-
 ### Data
 
-Defined in: [src/shared/types.ts](../../src/shared/types.ts#L10C0)  
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L9C0)  
 
 - **creditor** [`Creditor`](#creditor) Creditor related data.
 - **currency** [`Currency`](#currency) The currency to be used. **3 characters.**
@@ -228,7 +76,7 @@ Defined in: [src/shared/types.ts](../../src/shared/types.ts#L10C0)
 
 ### Debtor
 
-Defined in: [src/shared/types.ts](../../src/shared/types.ts#L69C0)  
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L68C0)  
 
 - **address** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) Address. **Max 70 characters.**
 - **city** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) City. **Max 35 characters.**
@@ -241,7 +89,7 @@ Defined in: [src/shared/types.ts](../../src/shared/types.ts#L69C0)
 
 ### Creditor
 
-Defined in: [src/shared/types.ts](../../src/shared/types.ts#L102C0)  
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L101C0)  
 
 - **address** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) Address. **Max 70 characters.**
 - **city** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) City. **Max 35 characters.**
@@ -255,7 +103,7 @@ Defined in: [src/shared/types.ts](../../src/shared/types.ts#L102C0)
 
 ### QRBillOptions
 
-Defined in: [src/shared/types.ts](../../src/shared/types.ts#L110C0)  
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L109C0)  
 
 - **language** [`Languages`](#languages) The language with which the bill is rendered. `optional`
 - **outlines** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want render the outlines. This option may be disabled if you use perforated paper. `optional`
@@ -267,7 +115,7 @@ Defined in: [src/shared/types.ts](../../src/shared/types.ts#L110C0)
 
 ### PDFOptions
 
-Defined in: [src/shared/types.ts](../../src/shared/types.ts#L147C0)  
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L146C0)  
 
 - **language** [`Languages`](#languages) The language with which the bill is rendered. `optional`
 - **outlines** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) Whether you want render the outlines. This option may be disabled if you use perforated paper. `optional`
@@ -280,6 +128,6 @@ Defined in: [src/shared/types.ts](../../src/shared/types.ts#L147C0)
 
 ### SVGOptions
 
-Defined in: [src/shared/types.ts](../../src/shared/types.ts#L156C0)  
+Defined in: [src/shared/types.ts](../../src/shared/types.ts#L155C0)  
 
 - **language** [`Languages`](#languages) The language with which the bill is rendered. `optional`
diff --git a/docs/svg/swissqrbill.md b/docs/svg/swissqrbill.md
@@ -26,15 +26,15 @@
 
 ### SwissQRBill
 
-Defined in: [svg/swissqrbill.ts](../svg/swissqrbill.ts#L15C0)  
+Defined in: [svg/swissqrbill.ts](../svg/swissqrbill.ts#L13C0)  
 
 #### Construct Signature
 
 ---
 
 ##### constructor(data\[, options\])
 
-Defined in: [svg/swissqrbill.ts](../svg/swissqrbill.ts#L22C2)  
+Defined in: [svg/swissqrbill.ts](../svg/swissqrbill.ts#L20C2)  
 
 ###### Parameters
 
@@ -51,7 +51,7 @@ Defined in: [svg/swissqrbill.ts](../svg/swissqrbill.ts#L22C2)
 
 `protected`  
 
-Defined in: [svg/swissqrbill.ts](../svg/swissqrbill.ts#L17C2)  
+Defined in: [svg/swissqrbill.ts](../svg/swissqrbill.ts#L15C2)  
 
 ##### Type
 
@@ -65,7 +65,7 @@ Defined in: [svg/swissqrbill.ts](../svg/swissqrbill.ts#L17C2)
 
 `public`  
 
-Defined in: [svg/swissqrbill.ts](../svg/swissqrbill.ts#L58C2)  
+Defined in: [svg/swissqrbill.ts](../svg/swissqrbill.ts#L56C2)  
 
 ##### Return Type
 
@@ -83,7 +83,7 @@ Outputs the SVG as a string.
 
 `public`  
 
-Defined in: [svg/swissqrbill.ts](../svg/swissqrbill.ts#L49C2)  
+Defined in: [svg/swissqrbill.ts](../svg/swissqrbill.ts#L47C2)  
 
 ##### Return Type
 
@@ -95,7 +95,7 @@ Defined in: [svg/swissqrbill.ts](../svg/swissqrbill.ts#L49C2)
 
 `public`  
 
-Defined in: [svg/swissqrbill.ts](../svg/swissqrbill.ts#L68C2)  
+Defined in: [svg/swissqrbill.ts](../svg/swissqrbill.ts#L66C2)  
 
 ##### Return Type