TransactionsDataTableBuilder
A TransactionsDataTableBuilder is used to setup and build two-dimensional arrays containing transactions.
Constructors
Constructor
new TransactionsDataTableBuilder( book, transactions, account?): TransactionsDataTableBuilder;Parameters
| Parameter | Type |
|---|---|
book | Book |
transactions | Transaction[] |
account? | Account |
Returns
TransactionsDataTableBuilder
Methods
build()
build(): Promise<any[][]>;Builds a two-dimensional array containing all transactions.
Returns
Promise<any[][]>
A promise resolving to a two-dimensional array containing all transactions
formatDates()
formatDates(format): TransactionsDataTableBuilder;Defines whether the dates should be formatted, based on date pattern of the Book.
Parameters
| Parameter | Type | Description |
|---|---|---|
format | boolean | Whether to format dates |
Returns
TransactionsDataTableBuilder
This builder with respective formatting option, for chaining.
formatValues()
formatValues(format): TransactionsDataTableBuilder;Defines whether amounts should be formatted based on DecimalSeparator of the Book.
Parameters
| Parameter | Type | Description |
|---|---|---|
format | boolean | Whether to format values |
Returns
TransactionsDataTableBuilder
This builder with respective formatting option, for chaining.
getAccount()
getAccount(): Account | undefined;Gets the account used to filter transactions, when applicable.
Returns
Account | undefined
The account, when filtering by a single account.
hiddenProperties()
hiddenProperties(include): TransactionsDataTableBuilder;Defines whether to include hidden properties (keys ending with underscore ”_”). Only relevant when properties is enabled. Default is false — hidden properties are excluded.
Parameters
| Parameter | Type | Description |
|---|---|---|
include | boolean | Whether to include hidden properties |
Returns
TransactionsDataTableBuilder
This builder with respective option, for chaining.
ids()
ids(include): TransactionsDataTableBuilder;Defines whether to include transaction ids and remote ids.
Parameters
| Parameter | Type | Description |
|---|---|---|
include | boolean | Whether to include ids |
Returns
TransactionsDataTableBuilder
This builder with respective option, for chaining.
includeIds()
includeIds(include): TransactionsDataTableBuilder;Parameters
| Parameter | Type |
|---|---|
include | boolean |
Returns
TransactionsDataTableBuilder
includeProperties()
includeProperties(include): TransactionsDataTableBuilder;Parameters
| Parameter | Type |
|---|---|
include | boolean |
Returns
TransactionsDataTableBuilder
includeUrls()
includeUrls(include): TransactionsDataTableBuilder;Parameters
| Parameter | Type |
|---|---|
include | boolean |
Returns
TransactionsDataTableBuilder
properties()
properties(include): TransactionsDataTableBuilder;Defines whether to include custom transaction properties.
Parameters
| Parameter | Type | Description |
|---|---|---|
include | boolean | Whether to include properties |
Returns
TransactionsDataTableBuilder
This builder with respective option, for chaining.
recordedAt()
recordedAt(include): TransactionsDataTableBuilder;Defines whether to include the “Recorded at” column.
Parameters
| Parameter | Type | Description |
|---|---|---|
include | boolean | Whether to include the recorded at column |
Returns
TransactionsDataTableBuilder
This builder with respective option, for chaining.
urls()
urls(include): TransactionsDataTableBuilder;Defines whether to include attachments and url links.
Parameters
| Parameter | Type | Description |
|---|---|---|
include | boolean | Whether to include URLs |
Returns
TransactionsDataTableBuilder
This builder with respective option, for chaining.