@tectra-ng/ui 0.3.2 → 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/data-view/README.md +9 -1
- package/dialog/README.md +3 -0
- package/fesm2022/tectra-ng-ui-accordion.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-amount.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-analog-clock.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-avatar.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-breadcrumb.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-carousel.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-checkbox.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-chips-input.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-color-picker.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-confirm.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-countdown.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-country.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-data-view.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-datepicker.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-dialog.mjs +51 -0
- package/fesm2022/tectra-ng-ui-dialog.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-email-suggestion.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-export-font.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-export.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-file-upload.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-galleria.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-highlight-text.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-icon-field.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-image.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-input-mask.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-input-number.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-key-filter.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-list-input.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-mention-textarea.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-menu.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-month-calendar.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-paginator.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-panel-menu.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-password-generator.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-radio-button.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-select.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-sparkline.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-splitter.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-stat-tiles.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-stepper.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-table.mjs +2 -2
- package/fesm2022/tectra-ng-ui-table.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-tabs.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-toast.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-toolbar.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-tooltip.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-tree-select.mjs +20 -3
- package/fesm2022/tectra-ng-ui-tree-select.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-tree-table.mjs +2 -2
- package/fesm2022/tectra-ng-ui-tree-table.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-tree.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui-virtual-scroller.mjs.map +1 -1
- package/fesm2022/tectra-ng-ui.mjs +1 -1
- package/fesm2022/tectra-ng-ui.mjs.map +1 -1
- package/package.json +4 -4
- package/table/README.md +1 -0
- package/tree-select/README.md +1 -0
- package/types/tectra-ng-ui-accordion.d.ts +96 -65
- package/types/tectra-ng-ui-accordion.d.ts.map +1 -1
- package/types/tectra-ng-ui-amount.d.ts +40 -17
- package/types/tectra-ng-ui-amount.d.ts.map +1 -1
- package/types/tectra-ng-ui-analog-clock.d.ts +28 -41
- package/types/tectra-ng-ui-analog-clock.d.ts.map +1 -1
- package/types/tectra-ng-ui-autocomplete.d.ts +35 -96
- package/types/tectra-ng-ui-autocomplete.d.ts.map +1 -1
- package/types/tectra-ng-ui-avatar.d.ts +84 -259
- package/types/tectra-ng-ui-avatar.d.ts.map +1 -1
- package/types/tectra-ng-ui-badge.d.ts +18 -61
- package/types/tectra-ng-ui-badge.d.ts.map +1 -1
- package/types/tectra-ng-ui-breadcrumb.d.ts +53 -36
- package/types/tectra-ng-ui-breadcrumb.d.ts.map +1 -1
- package/types/tectra-ng-ui-button-group.d.ts +4 -0
- package/types/tectra-ng-ui-button-group.d.ts.map +1 -1
- package/types/tectra-ng-ui-button.d.ts +45 -266
- package/types/tectra-ng-ui-button.d.ts.map +1 -1
- package/types/tectra-ng-ui-card.d.ts +14 -16
- package/types/tectra-ng-ui-card.d.ts.map +1 -1
- package/types/tectra-ng-ui-carousel.d.ts +55 -27
- package/types/tectra-ng-ui-carousel.d.ts.map +1 -1
- package/types/tectra-ng-ui-cascade-select.d.ts +48 -8
- package/types/tectra-ng-ui-cascade-select.d.ts.map +1 -1
- package/types/tectra-ng-ui-checkbox.d.ts +79 -119
- package/types/tectra-ng-ui-checkbox.d.ts.map +1 -1
- package/types/tectra-ng-ui-chip.d.ts +19 -22
- package/types/tectra-ng-ui-chip.d.ts.map +1 -1
- package/types/tectra-ng-ui-chips-input.d.ts +41 -11
- package/types/tectra-ng-ui-chips-input.d.ts.map +1 -1
- package/types/tectra-ng-ui-color-picker.d.ts +51 -47
- package/types/tectra-ng-ui-color-picker.d.ts.map +1 -1
- package/types/tectra-ng-ui-confirm.d.ts +45 -0
- package/types/tectra-ng-ui-confirm.d.ts.map +1 -1
- package/types/tectra-ng-ui-countdown.d.ts +42 -10
- package/types/tectra-ng-ui-countdown.d.ts.map +1 -1
- package/types/tectra-ng-ui-country-select.d.ts +41 -96
- package/types/tectra-ng-ui-country-select.d.ts.map +1 -1
- package/types/tectra-ng-ui-country.d.ts +40 -17
- package/types/tectra-ng-ui-country.d.ts.map +1 -1
- package/types/tectra-ng-ui-data-view.d.ts +92 -34
- package/types/tectra-ng-ui-data-view.d.ts.map +1 -1
- package/types/tectra-ng-ui-datepicker.d.ts +186 -147
- package/types/tectra-ng-ui-datepicker.d.ts.map +1 -1
- package/types/tectra-ng-ui-dialog.d.ts +149 -67
- package/types/tectra-ng-ui-dialog.d.ts.map +1 -1
- package/types/tectra-ng-ui-divider.d.ts +17 -12
- package/types/tectra-ng-ui-divider.d.ts.map +1 -1
- package/types/tectra-ng-ui-drawer.d.ts +31 -67
- package/types/tectra-ng-ui-drawer.d.ts.map +1 -1
- package/types/tectra-ng-ui-email-suggestion.d.ts +25 -8
- package/types/tectra-ng-ui-email-suggestion.d.ts.map +1 -1
- package/types/tectra-ng-ui-export-font.d.ts +1 -0
- package/types/tectra-ng-ui-export-font.d.ts.map +1 -1
- package/types/tectra-ng-ui-export.d.ts +238 -0
- package/types/tectra-ng-ui-export.d.ts.map +1 -1
- package/types/tectra-ng-ui-field.d.ts +24 -11
- package/types/tectra-ng-ui-field.d.ts.map +1 -1
- package/types/tectra-ng-ui-fieldset.d.ts +14 -23
- package/types/tectra-ng-ui-fieldset.d.ts.map +1 -1
- package/types/tectra-ng-ui-file-upload.d.ts +127 -115
- package/types/tectra-ng-ui-file-upload.d.ts.map +1 -1
- package/types/tectra-ng-ui-galleria.d.ts +84 -84
- package/types/tectra-ng-ui-galleria.d.ts.map +1 -1
- package/types/tectra-ng-ui-highlight-text.d.ts +24 -10
- package/types/tectra-ng-ui-highlight-text.d.ts.map +1 -1
- package/types/tectra-ng-ui-icon-field.d.ts +20 -0
- package/types/tectra-ng-ui-icon-field.d.ts.map +1 -1
- package/types/tectra-ng-ui-image.d.ts +60 -36
- package/types/tectra-ng-ui-image.d.ts.map +1 -1
- package/types/tectra-ng-ui-input-group.d.ts +9 -0
- package/types/tectra-ng-ui-input-group.d.ts.map +1 -1
- package/types/tectra-ng-ui-input-mask.d.ts +39 -0
- package/types/tectra-ng-ui-input-mask.d.ts.map +1 -1
- package/types/tectra-ng-ui-input-number.d.ts +73 -15
- package/types/tectra-ng-ui-input-number.d.ts.map +1 -1
- package/types/tectra-ng-ui-input-otp.d.ts +28 -21
- package/types/tectra-ng-ui-input-otp.d.ts.map +1 -1
- package/types/tectra-ng-ui-input.d.ts +17 -50
- package/types/tectra-ng-ui-input.d.ts.map +1 -1
- package/types/tectra-ng-ui-key-filter.d.ts +14 -0
- package/types/tectra-ng-ui-key-filter.d.ts.map +1 -1
- package/types/tectra-ng-ui-knob.d.ts +38 -18
- package/types/tectra-ng-ui-knob.d.ts.map +1 -1
- package/types/tectra-ng-ui-label.d.ts +19 -0
- package/types/tectra-ng-ui-label.d.ts.map +1 -1
- package/types/tectra-ng-ui-link.d.ts +39 -34
- package/types/tectra-ng-ui-link.d.ts.map +1 -1
- package/types/tectra-ng-ui-list-input.d.ts +54 -45
- package/types/tectra-ng-ui-list-input.d.ts.map +1 -1
- package/types/tectra-ng-ui-listbox.d.ts +24 -14
- package/types/tectra-ng-ui-listbox.d.ts.map +1 -1
- package/types/tectra-ng-ui-mention-textarea.d.ts +36 -9
- package/types/tectra-ng-ui-mention-textarea.d.ts.map +1 -1
- package/types/tectra-ng-ui-menu.d.ts +92 -166
- package/types/tectra-ng-ui-menu.d.ts.map +1 -1
- package/types/tectra-ng-ui-menubar.d.ts +29 -58
- package/types/tectra-ng-ui-menubar.d.ts.map +1 -1
- package/types/tectra-ng-ui-message.d.ts +61 -126
- package/types/tectra-ng-ui-message.d.ts.map +1 -1
- package/types/tectra-ng-ui-month-calendar.d.ts +98 -87
- package/types/tectra-ng-ui-month-calendar.d.ts.map +1 -1
- package/types/tectra-ng-ui-multiselect.d.ts +26 -96
- package/types/tectra-ng-ui-multiselect.d.ts.map +1 -1
- package/types/tectra-ng-ui-overlay-badge.d.ts +20 -9
- package/types/tectra-ng-ui-overlay-badge.d.ts.map +1 -1
- package/types/tectra-ng-ui-paginator.d.ts +69 -47
- package/types/tectra-ng-ui-paginator.d.ts.map +1 -1
- package/types/tectra-ng-ui-panel-menu.d.ts +52 -105
- package/types/tectra-ng-ui-panel-menu.d.ts.map +1 -1
- package/types/tectra-ng-ui-panel.d.ts +22 -30
- package/types/tectra-ng-ui-panel.d.ts.map +1 -1
- package/types/tectra-ng-ui-password-generator.d.ts +27 -0
- package/types/tectra-ng-ui-password-generator.d.ts.map +1 -1
- package/types/tectra-ng-ui-password.d.ts +55 -26
- package/types/tectra-ng-ui-password.d.ts.map +1 -1
- package/types/tectra-ng-ui-pill.d.ts +23 -70
- package/types/tectra-ng-ui-pill.d.ts.map +1 -1
- package/types/tectra-ng-ui-popover.d.ts +58 -46
- package/types/tectra-ng-ui-popover.d.ts.map +1 -1
- package/types/tectra-ng-ui-progress-bar.d.ts +32 -28
- package/types/tectra-ng-ui-progress-bar.d.ts.map +1 -1
- package/types/tectra-ng-ui-progress-spinner.d.ts +18 -16
- package/types/tectra-ng-ui-progress-spinner.d.ts.map +1 -1
- package/types/tectra-ng-ui-radio-button.d.ts +64 -115
- package/types/tectra-ng-ui-radio-button.d.ts.map +1 -1
- package/types/tectra-ng-ui-rating.d.ts +40 -29
- package/types/tectra-ng-ui-rating.d.ts.map +1 -1
- package/types/tectra-ng-ui-scroll-panel.d.ts +22 -17
- package/types/tectra-ng-ui-scroll-panel.d.ts.map +1 -1
- package/types/tectra-ng-ui-select.d.ts +169 -100
- package/types/tectra-ng-ui-select.d.ts.map +1 -1
- package/types/tectra-ng-ui-skeleton.d.ts +34 -37
- package/types/tectra-ng-ui-skeleton.d.ts.map +1 -1
- package/types/tectra-ng-ui-slider.d.ts +37 -33
- package/types/tectra-ng-ui-slider.d.ts.map +1 -1
- package/types/tectra-ng-ui-sparkline.d.ts +22 -15
- package/types/tectra-ng-ui-sparkline.d.ts.map +1 -1
- package/types/tectra-ng-ui-speed-dial.d.ts +34 -11
- package/types/tectra-ng-ui-speed-dial.d.ts.map +1 -1
- package/types/tectra-ng-ui-split-button.d.ts +28 -7
- package/types/tectra-ng-ui-split-button.d.ts.map +1 -1
- package/types/tectra-ng-ui-splitter.d.ts +47 -23
- package/types/tectra-ng-ui-splitter.d.ts.map +1 -1
- package/types/tectra-ng-ui-stat-tiles.d.ts +39 -91
- package/types/tectra-ng-ui-stat-tiles.d.ts.map +1 -1
- package/types/tectra-ng-ui-status-icon.d.ts +19 -23
- package/types/tectra-ng-ui-status-icon.d.ts.map +1 -1
- package/types/tectra-ng-ui-stepper.d.ts +106 -133
- package/types/tectra-ng-ui-stepper.d.ts.map +1 -1
- package/types/tectra-ng-ui-table.d.ts +415 -183
- package/types/tectra-ng-ui-table.d.ts.map +1 -1
- package/types/tectra-ng-ui-tabs.d.ts +91 -133
- package/types/tectra-ng-ui-tabs.d.ts.map +1 -1
- package/types/tectra-ng-ui-tag.d.ts +46 -135
- package/types/tectra-ng-ui-tag.d.ts.map +1 -1
- package/types/tectra-ng-ui-textarea.d.ts +25 -31
- package/types/tectra-ng-ui-textarea.d.ts.map +1 -1
- package/types/tectra-ng-ui-timeline.d.ts +39 -27
- package/types/tectra-ng-ui-timeline.d.ts.map +1 -1
- package/types/tectra-ng-ui-toast.d.ts +84 -78
- package/types/tectra-ng-ui-toast.d.ts.map +1 -1
- package/types/tectra-ng-ui-toggle-button.d.ts +29 -55
- package/types/tectra-ng-ui-toggle-button.d.ts.map +1 -1
- package/types/tectra-ng-ui-toggle-switch.d.ts +41 -55
- package/types/tectra-ng-ui-toggle-switch.d.ts.map +1 -1
- package/types/tectra-ng-ui-toolbar.d.ts +15 -14
- package/types/tectra-ng-ui-toolbar.d.ts.map +1 -1
- package/types/tectra-ng-ui-tooltip.d.ts +72 -22
- package/types/tectra-ng-ui-tooltip.d.ts.map +1 -1
- package/types/tectra-ng-ui-tree-select.d.ts +65 -104
- package/types/tectra-ng-ui-tree-select.d.ts.map +1 -1
- package/types/tectra-ng-ui-tree-table.d.ts +30 -0
- package/types/tectra-ng-ui-tree-table.d.ts.map +1 -1
- package/types/tectra-ng-ui-tree.d.ts +197 -69
- package/types/tectra-ng-ui-tree.d.ts.map +1 -1
- package/types/tectra-ng-ui-truncate-text.d.ts +21 -14
- package/types/tectra-ng-ui-truncate-text.d.ts.map +1 -1
- package/types/tectra-ng-ui-virtual-scroller.d.ts +97 -13
- package/types/tectra-ng-ui-virtual-scroller.d.ts.map +1 -1
- package/types/tectra-ng-ui.d.ts +2 -1
- package/types/tectra-ng-ui.d.ts.map +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tectra-ng-ui-export-font.d.ts","names":[],"sources":["../../../../packages/ui/export-font/src/export-font.ts"],"mappings":"
|
|
1
|
+
{"version":3,"file":"tectra-ng-ui-export-font.d.ts","names":[],"sources":["../../../../packages/ui/export-font/src/export-font.ts"],"mappings":"AAGA;qBAAa"}
|
|
@@ -3,187 +3,358 @@ import { InjectionToken, Provider } from "@angular/core";
|
|
|
3
3
|
import { TxPassThroughOptions } from "@tectra-ng/core/config";
|
|
4
4
|
import { TxButtonSeverity, TxButtonSize, TxButtonVariant } from "@tectra-ng/ui/button";
|
|
5
5
|
import { TxMenuItem } from "@tectra-ng/ui/menu";
|
|
6
|
+
/** One row of data to export: an object with the values by key. */
|
|
6
7
|
export type TxExportRow = Record<string, unknown>;
|
|
8
|
+
/**
|
|
9
|
+
* File or action an export produces: `csv`, `excel`, `word`, `pdf`, `json`, `html`, `markdown`, `copy` or `print`.
|
|
10
|
+
*/
|
|
7
11
|
export type TxExportFormat = 'csv' | 'excel' | 'word' | 'pdf' | 'json' | 'html' | 'markdown' | 'copy' | 'print';
|
|
12
|
+
/** Alignment of a column: `start`, `center` or `end`. */
|
|
8
13
|
export type TxExportAlign = 'start' | 'center' | 'end';
|
|
14
|
+
/** How a column's values are written: `text`, `number`, `date`, `datetime` or `boolean`. */
|
|
9
15
|
export type TxExportValueType = 'text' | 'number' | 'date' | 'datetime' | 'boolean';
|
|
16
|
+
/** Page orientation: `portrait`, `landscape`, or `auto` (landscape above five columns). */
|
|
10
17
|
export type TxExportOrientation = 'auto' | 'portrait' | 'landscape';
|
|
18
|
+
/** Page size: `a3`, `a4`, `a5`, `letter`, `legal` or `[width, height]` in points. */
|
|
11
19
|
export type TxExportPageSize = 'a3' | 'a4' | 'a5' | 'letter' | 'legal' | readonly [number, number];
|
|
20
|
+
/** Names of the parts of the export buttons that `pt` can style. */
|
|
12
21
|
export type TxExportPart = 'root' | 'button';
|
|
22
|
+
/** One column of an export: which value to read and how to write it. */
|
|
13
23
|
export interface TxExportField<T = TxExportRow> {
|
|
24
|
+
/** Key of the value in a row, or a path like `team.title`. */
|
|
14
25
|
field: string;
|
|
26
|
+
/** Column title; the `field` when not set. */
|
|
15
27
|
title?: string;
|
|
28
|
+
/** Computes the value from the read value, the row and its index instead of using the value as it is. */
|
|
16
29
|
aggregator?: (value: unknown, row: T, index: number) => unknown;
|
|
30
|
+
/** How the values are written; guessed from the values when not set. */
|
|
17
31
|
type?: TxExportValueType;
|
|
32
|
+
/** Column width in characters. */
|
|
18
33
|
width?: number;
|
|
34
|
+
/** Alignment of the column; numbers end, booleans center and the rest start by default. */
|
|
19
35
|
align?: TxExportAlign;
|
|
36
|
+
/** Excel number or date format, such as `#,##0.00` or `dd.mm.yyyy`. */
|
|
20
37
|
format?: string;
|
|
38
|
+
/** Takes the column only in these formats; every format when not set. */
|
|
21
39
|
formats?: readonly TxExportFormat[];
|
|
22
40
|
}
|
|
41
|
+
/** A column of the table to export, with its type and alignment resolved. */
|
|
23
42
|
export interface TxExportColumn {
|
|
43
|
+
/** The `field` the column was read from. */
|
|
24
44
|
key: string;
|
|
45
|
+
/** Column title. */
|
|
25
46
|
title: string;
|
|
47
|
+
/** How the values are written. */
|
|
26
48
|
type: TxExportValueType;
|
|
49
|
+
/** Column width in characters. */
|
|
27
50
|
width?: number;
|
|
51
|
+
/** Alignment of the column. */
|
|
28
52
|
align: TxExportAlign;
|
|
53
|
+
/** Excel number or date format of the column. */
|
|
29
54
|
format?: string;
|
|
30
55
|
}
|
|
56
|
+
/** The data an export writes: columns and the rows of values in the same order. */
|
|
31
57
|
export interface TxExportTable {
|
|
58
|
+
/** The columns in order. */
|
|
32
59
|
columns: TxExportColumn[];
|
|
60
|
+
/** One list of values per row, one value per column. */
|
|
33
61
|
rows: unknown[][];
|
|
34
62
|
}
|
|
63
|
+
/** Options shared by documents that have a heading: the title, subtitle, date and the header row. */
|
|
35
64
|
export interface TxExportDocumentOptions {
|
|
65
|
+
/** Title at the top of the document. */
|
|
36
66
|
title?: string;
|
|
67
|
+
/** Line under the title. */
|
|
37
68
|
subtitle?: string;
|
|
69
|
+
/** Shows the date and time of the export under the title. */
|
|
38
70
|
showDate?: boolean;
|
|
71
|
+
/** Shows the row of column titles (default on). */
|
|
39
72
|
header?: boolean;
|
|
40
73
|
}
|
|
74
|
+
/** Options of paged documents (Word and PDF): page, text and table look. */
|
|
41
75
|
export interface TxExportPageOptions extends TxExportDocumentOptions {
|
|
76
|
+
/** Page size (default `a4`). */
|
|
42
77
|
pageSize?: TxExportPageSize;
|
|
78
|
+
/** Page orientation (default `auto`). */
|
|
43
79
|
orientation?: TxExportOrientation;
|
|
80
|
+
/** Page margin in points: one number, or `[top, right, bottom, left]` (default 36). */
|
|
44
81
|
margin?: number | readonly [number, number, number, number];
|
|
82
|
+
/** Text size in points (default 10 in Word, 9 in PDF). */
|
|
45
83
|
fontSize?: number;
|
|
84
|
+
/** Shows page numbers at the bottom (default on). */
|
|
46
85
|
pageNumbers?: boolean;
|
|
86
|
+
/** Repeats the header row on every page (default on). */
|
|
47
87
|
repeatHeader?: boolean;
|
|
88
|
+
/** Shades every second row (default off). */
|
|
48
89
|
striped?: boolean;
|
|
90
|
+
/** Draws lines between cells; `false` keeps only horizontal lines (default on). */
|
|
49
91
|
gridlines?: boolean;
|
|
92
|
+
/** Background colour of the header row, as hex. */
|
|
50
93
|
headerBackground?: string;
|
|
94
|
+
/** Background colour of shaded rows, as hex. */
|
|
51
95
|
stripeBackground?: string;
|
|
96
|
+
/** Colour of the table lines, as hex. */
|
|
52
97
|
borderColor?: string;
|
|
98
|
+
/** Colour of the text, as hex. */
|
|
53
99
|
textColor?: string;
|
|
100
|
+
/** Colour of the subtitle, date and page numbers, as hex. */
|
|
54
101
|
mutedColor?: string;
|
|
55
102
|
}
|
|
103
|
+
/** Font files for the PDF export. */
|
|
56
104
|
export interface TxExportFont {
|
|
105
|
+
/** TrueType file of the regular weight: its bytes, or a base64 string. */
|
|
57
106
|
regular: ArrayBuffer | Uint8Array | string;
|
|
107
|
+
/** TrueType file of the bold weight; the regular one is emulated when not set. */
|
|
58
108
|
bold?: ArrayBuffer | Uint8Array | string;
|
|
59
109
|
}
|
|
110
|
+
/** Options of the CSV file. */
|
|
60
111
|
export interface TxExportCsvOptions {
|
|
112
|
+
/** Text between cells (default `,`). */
|
|
61
113
|
separator?: string;
|
|
114
|
+
/** Starts the file with a byte order mark so spreadsheet apps read non-Latin text (default on). */
|
|
62
115
|
bom?: boolean;
|
|
116
|
+
/** Line ending: `\r\n` (default) or `\n`. */
|
|
63
117
|
lineEnding?: '\r\n' | '\n';
|
|
118
|
+
/** Writes the row of column titles (default on). */
|
|
64
119
|
header?: boolean;
|
|
120
|
+
/** Quotes every cell, not only the ones that need it. */
|
|
65
121
|
quoteAll?: boolean;
|
|
122
|
+
/** Puts a quote before cells a spreadsheet would run as a formula (default on). */
|
|
66
123
|
formulaGuard?: boolean;
|
|
67
124
|
}
|
|
125
|
+
/** Options of the Excel `.xlsx` file. */
|
|
68
126
|
export interface TxExportExcelOptions {
|
|
127
|
+
/** Name of the worksheet (default `Sheet1`). */
|
|
69
128
|
sheetName?: string;
|
|
129
|
+
/** Writes the row of column titles (default on). */
|
|
70
130
|
header?: boolean;
|
|
131
|
+
/** Keeps the header row in view when scrolling (default on). */
|
|
71
132
|
freezeHeader?: boolean;
|
|
133
|
+
/** Adds filter arrows to the header row (default on). */
|
|
72
134
|
autoFilter?: boolean;
|
|
135
|
+
/** Sizes columns to their content (default on). */
|
|
73
136
|
autoWidth?: boolean;
|
|
137
|
+
/** Smallest automatic column width in characters (default 8). */
|
|
74
138
|
minWidth?: number;
|
|
139
|
+
/** Largest automatic column width in characters (default 60). */
|
|
75
140
|
maxWidth?: number;
|
|
141
|
+
/** Writes the header in bold (default on). */
|
|
76
142
|
headerBold?: boolean;
|
|
143
|
+
/** Background of the header row as hex, or `none`. */
|
|
77
144
|
headerBackground?: string;
|
|
145
|
+
/** Text colour of the header row as hex. */
|
|
78
146
|
headerColor?: string;
|
|
147
|
+
/** Wraps cells that hold line breaks (default on). */
|
|
79
148
|
wrapText?: boolean;
|
|
149
|
+
/** Excel number format for number columns without their own `format`. */
|
|
80
150
|
numberFormat?: string;
|
|
151
|
+
/** Excel format for date columns without their own `format`. */
|
|
81
152
|
dateFormat?: string;
|
|
153
|
+
/** Excel format for date and time columns without their own `format`. */
|
|
82
154
|
dateTimeFormat?: string;
|
|
155
|
+
/** Title stored in the file properties. */
|
|
83
156
|
title?: string;
|
|
157
|
+
/** Author stored in the file properties. */
|
|
84
158
|
author?: string;
|
|
159
|
+
/** Compresses the file (default on). */
|
|
85
160
|
compress?: boolean;
|
|
86
161
|
}
|
|
162
|
+
/** Options of the Word `.docx` file. */
|
|
87
163
|
export interface TxExportWordOptions extends TxExportPageOptions {
|
|
164
|
+
/** Compresses the file (default on). */
|
|
88
165
|
compress?: boolean;
|
|
89
166
|
}
|
|
167
|
+
/** Options of the PDF file. */
|
|
90
168
|
export interface TxExportPdfOptions extends TxExportPageOptions {
|
|
169
|
+
/** Loads the TrueType font; the Onest font of `@tectra-ng/ui/export-font` when not set. */
|
|
91
170
|
font?: () => Promise<TxExportFont>;
|
|
171
|
+
/** Line height as a multiple of the font size (default 1.35). */
|
|
92
172
|
lineHeight?: number;
|
|
173
|
+
/** Space inside a cell in points (default 4). */
|
|
93
174
|
cellPadding?: number;
|
|
175
|
+
/** Author stored in the file properties. */
|
|
94
176
|
author?: string;
|
|
177
|
+
/** Compresses the file (default on). */
|
|
95
178
|
compress?: boolean;
|
|
96
179
|
}
|
|
180
|
+
/** Options of the JSON file. */
|
|
97
181
|
export interface TxExportJsonOptions {
|
|
182
|
+
/** Which names the objects use as keys: the `field` (default) or the column `title`. */
|
|
98
183
|
keys?: 'field' | 'title';
|
|
184
|
+
/** Spaces of indentation (default 2). */
|
|
99
185
|
indent?: number;
|
|
100
186
|
}
|
|
187
|
+
/** Options of the HTML file. */
|
|
101
188
|
export interface TxExportHtmlOptions extends TxExportDocumentOptions {
|
|
189
|
+
/** Own CSS added to the page. */
|
|
102
190
|
styles?: string;
|
|
103
191
|
}
|
|
192
|
+
/** Options of the Markdown file. */
|
|
104
193
|
export interface TxExportMarkdownOptions {
|
|
194
|
+
/** Heading above the table. */
|
|
105
195
|
title?: string;
|
|
196
|
+
/** Writes the row of column titles (default on). */
|
|
106
197
|
header?: boolean;
|
|
107
198
|
}
|
|
199
|
+
/** Options of copying to the clipboard. */
|
|
108
200
|
export interface TxExportCopyOptions {
|
|
201
|
+
/** Copies the row of column titles (default on). */
|
|
109
202
|
header?: boolean;
|
|
203
|
+
/** Also puts an HTML table on the clipboard so it pastes as a table (default on). */
|
|
110
204
|
html?: boolean;
|
|
111
205
|
}
|
|
206
|
+
/** Options of printing. */
|
|
112
207
|
export interface TxExportPrintOptions extends TxExportDocumentOptions {
|
|
208
|
+
/** Page size of the print (default `a4`). */
|
|
113
209
|
pageSize?: TxExportPageSize;
|
|
210
|
+
/** Page orientation of the print (default `auto`). */
|
|
114
211
|
orientation?: TxExportOrientation;
|
|
212
|
+
/** Page margin in points: one number, or `[top, right, bottom, left]`. */
|
|
115
213
|
margin?: number | readonly [number, number, number, number];
|
|
214
|
+
/** Own CSS added to the printed page. */
|
|
116
215
|
styles?: string;
|
|
117
216
|
}
|
|
217
|
+
/** Options of an export: names and texts shared by every format, and one object per format. */
|
|
118
218
|
export interface TxExportOptions {
|
|
219
|
+
/** File name, with or without the extension (default `ExportedData`). */
|
|
119
220
|
filename?: string;
|
|
221
|
+
/** Title of the document, and of the Excel file. */
|
|
120
222
|
title?: string;
|
|
223
|
+
/** Line under the title. */
|
|
121
224
|
subtitle?: string;
|
|
225
|
+
/** Shows the date and time of the export under the title. */
|
|
122
226
|
showDate?: boolean;
|
|
227
|
+
/** Locale for dates in the file; the tectra locale when not set. */
|
|
123
228
|
locale?: string;
|
|
229
|
+
/** Options of the CSV file. */
|
|
124
230
|
csv?: TxExportCsvOptions;
|
|
231
|
+
/** Options of the Excel file. */
|
|
125
232
|
excel?: TxExportExcelOptions;
|
|
233
|
+
/** Options of the Word file. */
|
|
126
234
|
word?: TxExportWordOptions;
|
|
235
|
+
/** Options of the PDF file. */
|
|
127
236
|
pdf?: TxExportPdfOptions;
|
|
237
|
+
/** Options of the JSON file. */
|
|
128
238
|
json?: TxExportJsonOptions;
|
|
239
|
+
/** Options of the HTML file. */
|
|
129
240
|
html?: TxExportHtmlOptions;
|
|
241
|
+
/** Options of the Markdown file. */
|
|
130
242
|
markdown?: TxExportMarkdownOptions;
|
|
243
|
+
/** Options of copying to the clipboard. */
|
|
131
244
|
copy?: TxExportCopyOptions;
|
|
245
|
+
/** Options of printing. */
|
|
132
246
|
print?: TxExportPrintOptions;
|
|
133
247
|
}
|
|
248
|
+
/** Loads the rows to export when the button is clicked; `null` or nothing cancels the export. */
|
|
134
249
|
export type TxExportFetch<T = TxExportRow> = () => Promise<readonly T[] | null | undefined>;
|
|
250
|
+
/** What `TxExportService.export` runs: the format, the rows, the fields and the options. */
|
|
135
251
|
export interface TxExportRequest<T = TxExportRow> {
|
|
252
|
+
/** Format to produce. */
|
|
136
253
|
format: TxExportFormat;
|
|
254
|
+
/** Rows to export. */
|
|
137
255
|
rows: readonly T[];
|
|
256
|
+
/** Columns in order. */
|
|
138
257
|
fields: readonly TxExportField<T>[];
|
|
258
|
+
/** Options merged over the defaults from `provideTxExport`. */
|
|
139
259
|
options?: TxExportOptions;
|
|
140
260
|
}
|
|
261
|
+
/** What an export did. */
|
|
141
262
|
export interface TxExportResult {
|
|
263
|
+
/** Format that was produced. */
|
|
142
264
|
format: TxExportFormat;
|
|
265
|
+
/** Name of the saved file; `null` for copy and print. */
|
|
143
266
|
filename: string | null;
|
|
267
|
+
/** Number of rows written. */
|
|
144
268
|
rows: number;
|
|
145
269
|
}
|
|
270
|
+
/** Payload of `exported`: the result and the rows that were exported. */
|
|
146
271
|
export interface TxExportedEvent<T = TxExportRow> extends TxExportResult {
|
|
272
|
+
/** The rows that were exported. */
|
|
147
273
|
data: readonly T[];
|
|
148
274
|
}
|
|
275
|
+
/** Reads a value from a row by key or by a path like `team.title`. */
|
|
149
276
|
export declare function readExportField(row: unknown, field: string): unknown;
|
|
277
|
+
/** Keeps the fields that take part in the format; a field with `formats` is left out of the others. */
|
|
150
278
|
export declare function fieldsFor<T>(fields: readonly TxExportField<T>[], format?: TxExportFormat): TxExportField<T>[];
|
|
279
|
+
/** Builds the table as a matrix of values whose first row is the column titles. */
|
|
151
280
|
export declare function exportMatrix<T>(rows: readonly T[], fields: readonly TxExportField<T>[], format?: TxExportFormat): unknown[][];
|
|
281
|
+
/**
|
|
282
|
+
* Reads the rows through the fields into columns and rows of values, with types and alignment worked out for the format.
|
|
283
|
+
*/
|
|
152
284
|
export declare function buildExportTable<T>(rows: readonly T[], fields: readonly TxExportField<T>[], format?: TxExportFormat): TxExportTable;
|
|
285
|
+
/**
|
|
286
|
+
* Guesses the column type from its values: number, boolean, date, datetime, or text when they are mixed or empty.
|
|
287
|
+
*/
|
|
153
288
|
export declare function inferType(values: readonly unknown[]): TxExportValueType;
|
|
289
|
+
/** Turns a `Date`, a date string or milliseconds into a `Date`; `null` when it is not a valid date. */
|
|
154
290
|
export declare function toDate(value: unknown): Date | null;
|
|
291
|
+
/** Locale and texts used to turn cell values into text. */
|
|
155
292
|
export interface TxExportTextContext {
|
|
293
|
+
/** Locale for dates; the runtime default when not set. */
|
|
156
294
|
locale?: string;
|
|
295
|
+
/** Text for `true`. */
|
|
157
296
|
yes: string;
|
|
297
|
+
/** Text for `false`. */
|
|
158
298
|
no: string;
|
|
159
299
|
}
|
|
300
|
+
/** Writes a cell as display text: booleans as the yes and no texts, dates in the locale, objects as JSON. */
|
|
160
301
|
export declare function cellText(value: unknown, column: TxExportColumn, context: TxExportTextContext): string;
|
|
302
|
+
/** Writes a date as local `yyyy-MM-dd`, with the time when it has one; any other value comes back unchanged. */
|
|
161
303
|
export declare function localIso(value: unknown, type: TxExportValueType): unknown;
|
|
304
|
+
/**
|
|
305
|
+
* Puts a quote before text that a spreadsheet would run as a formula (starting with `=`, `+`, `-` or `@`); plain signed numbers stay as they are.
|
|
306
|
+
*/
|
|
162
307
|
export declare function safeExportText(text: string): string;
|
|
308
|
+
/**
|
|
309
|
+
* Writes one value as a CSV cell, quoting it when needed and guarding formulas unless `formulaGuard` is `false`.
|
|
310
|
+
*/
|
|
163
311
|
export declare function csvCell(value: unknown, separator?: string, options?: {
|
|
164
312
|
quoteAll?: boolean;
|
|
165
313
|
formulaGuard?: boolean;
|
|
166
314
|
}): string;
|
|
315
|
+
/** Joins a matrix of values into CSV text with `\r\n` line endings. */
|
|
167
316
|
export declare function matrixToCsv(matrix: readonly (readonly unknown[])[], separator?: string): string;
|
|
317
|
+
/** Adds the extension to a file name unless it already ends with it. */
|
|
168
318
|
export declare function withExtension(filename: string, extension: string): string;
|
|
319
|
+
/**
|
|
320
|
+
* Saves a blob as a file with the given name through a temporary link; does nothing without a browser window.
|
|
321
|
+
*/
|
|
169
322
|
export declare function downloadBlob(document: Document, blob: Blob, filename: string): void;
|
|
323
|
+
/** Saves CSV text as a UTF-8 file with a byte order mark, adding `.csv` to the name when missing. */
|
|
170
324
|
export declare function downloadCsv(document: Document, csv: string, filename: string): void;
|
|
325
|
+
/** Escapes text for XML and drops characters XML cannot hold. */
|
|
171
326
|
export declare function escapeXml(text: string): string;
|
|
327
|
+
/** Normalizes a hex colour to six upper-case digits without `#`; the fallback when it is not a hex colour. */
|
|
172
328
|
export declare function hexColor(color: string | undefined, fallback: string): string;
|
|
329
|
+
/** Default export options for the app or a subtree; set it with `provideTxExport`. */
|
|
173
330
|
export declare const TX_EXPORT_OPTIONS: InjectionToken<TxExportOptions>;
|
|
331
|
+
/**
|
|
332
|
+
* Sets default export options that every export button and `TxExportService` merges under their own options.
|
|
333
|
+
*/
|
|
174
334
|
export declare function provideTxExport(options: TxExportOptions): Provider;
|
|
335
|
+
/** File extension of every format; `null` for copy and print, which make no file. */
|
|
175
336
|
export declare const TX_EXPORT_EXTENSIONS: Record<TxExportFormat, string | null>;
|
|
337
|
+
/**
|
|
338
|
+
* Merges export options in order, later layers winning; the per-format objects such as `csv` are merged key by key.
|
|
339
|
+
*/
|
|
176
340
|
export declare function mergeExportOptions(...layers: (TxExportOptions | undefined)[]): TxExportOptions;
|
|
341
|
+
/**
|
|
342
|
+
* Loads the Onest font from `@tectra-ng/ui/export-font` for PDF files; it is fetched on the first PDF export.
|
|
343
|
+
*/
|
|
177
344
|
export declare function loadDefaultExportFont(): Promise<TxExportFont>;
|
|
345
|
+
/** Exports rows from code to a file, the clipboard or the printer; the export buttons use it. */
|
|
178
346
|
export declare class TxExportService {
|
|
179
347
|
private document;
|
|
180
348
|
private defaults;
|
|
181
349
|
private locale;
|
|
350
|
+
/** Runs an export and saves, copies or prints the result; resolves to what was done. */
|
|
182
351
|
export<T>(request: TxExportRequest<T>): Promise<TxExportResult>;
|
|
352
|
+
/** Builds the file of a format from a prepared table without saving it. */
|
|
183
353
|
file(format: Exclude<TxExportFormat, 'copy' | 'print'>, table: TxExportTable, options?: TxExportOptions, context?: TxExportTextContext): Promise<{
|
|
184
354
|
blob: Blob;
|
|
185
355
|
filename: string;
|
|
186
356
|
}>;
|
|
357
|
+
/** Gives the locale and the yes and no texts used to write cell values. */
|
|
187
358
|
textContext(options?: TxExportOptions): TxExportTextContext;
|
|
188
359
|
private lang;
|
|
189
360
|
private copy;
|
|
@@ -191,28 +362,47 @@ export declare class TxExportService {
|
|
|
191
362
|
static ɵfac: i0.ɵɵFactoryDeclaration<TxExportService, never>;
|
|
192
363
|
static ɵprov: i0.ɵɵInjectableDeclaration<any>;
|
|
193
364
|
}
|
|
365
|
+
/** Icon name of every export format. */
|
|
194
366
|
export declare const TX_EXPORT_ICONS: Record<TxExportFormat, string>;
|
|
367
|
+
/** Base of the export buttons: the data, fields and options, the run of an export and its state. */
|
|
195
368
|
export declare abstract class TxExportAction<T = TxExportRow> {
|
|
196
369
|
private exporter;
|
|
197
370
|
private defaults;
|
|
198
371
|
private announcer;
|
|
199
372
|
private copiedTimer;
|
|
373
|
+
/** Rows to export; two-way, replaced by the result of `fetchData` */
|
|
200
374
|
readonly data: import("@angular/core").ModelSignal<readonly T[]>;
|
|
375
|
+
/** Columns in order (`TxExportField`): `field` (a key or a path like `team.title`), `title`, `aggregator(value, row, index)`, `type` (`text`, `number`, `date`, `datetime`, `boolean`; guessed from the values), `width` (in characters, all formats), `align` (`start`, `center`, `end`), `format` (Excel number format such as `#,##0.00` or `dd.mm.yyyy`), `formats` (only in these formats). A `number` or `place` field without an aggregator gets the row number */
|
|
201
376
|
readonly fields: import("@angular/core").InputSignal<readonly TxExportField<T>[]>;
|
|
377
|
+
/** `() => Promise<rows | null>` called on click before the export, e.g. to load every page from the server; `null` cancels */
|
|
202
378
|
readonly fetchData: import("@angular/core").InputSignal<TxExportFetch<T> | undefined>;
|
|
379
|
+
/** `TxExportOptions` — `filename`, `title`, `subtitle`, `showDate`, `locale` and one object per format: `csv`, `excel`, `word`, `pdf`, `json`, `html`, `markdown`, `copy`, `print` (see below); merged over `provideTxExport()` */
|
|
203
380
|
readonly options: import("@angular/core").InputSignal<TxExportOptions | undefined>;
|
|
381
|
+
/** File name, with or without the extension; `ExportedData` by default */
|
|
204
382
|
readonly filename: import("@angular/core").InputSignal<string | undefined>;
|
|
383
|
+
/** Title of the PDF, Word, HTML and printed documents and of the Excel file */
|
|
205
384
|
readonly title: import("@angular/core").InputSignal<string | undefined>;
|
|
385
|
+
/** Shows the spinner; the button also spins by itself while an export runs */
|
|
206
386
|
readonly loading: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
|
|
387
|
+
/** Disables the button */
|
|
207
388
|
readonly disabled: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
|
|
389
|
+
/** Text of the button; empty shows an icon-only button named by the tooltip (`tx-export` shows "Export") */
|
|
208
390
|
readonly label: import("@angular/core").InputSignal<string | undefined>;
|
|
391
|
+
/** Own tooltip; defaults to the translated "Export to CSV", "Copy table"… */
|
|
209
392
|
readonly tooltip: import("@angular/core").InputSignal<string | undefined>;
|
|
393
|
+
/** Button severity */
|
|
210
394
|
readonly severity: import("@angular/core").InputSignal<TxButtonSeverity>;
|
|
395
|
+
/** Button variant: `outlined`, `text` or `link` */
|
|
211
396
|
readonly variant: import("@angular/core").InputSignal<TxButtonVariant | undefined>;
|
|
397
|
+
/** Button size */
|
|
212
398
|
readonly size: import("@angular/core").InputSignal<TxButtonSize>;
|
|
399
|
+
/** How `pt` merges with the global pass-through */
|
|
213
400
|
readonly ptOptions: import("@angular/core").InputSignal<TxPassThroughOptions | undefined>;
|
|
401
|
+
/** Removes the tectra styles of the button */
|
|
214
402
|
readonly unstyled: import("@angular/core").InputSignalWithTransform<boolean | undefined, unknown>;
|
|
403
|
+
/** Done: `{ format, filename, rows, data }` (`filename` is `null` for copy and print) */
|
|
215
404
|
readonly exported: import("@angular/core").OutputEmitterRef<TxExportedEvent<T>>;
|
|
405
|
+
/** `fetchData`, the writer or the clipboard threw; the button is ready for the next click */
|
|
216
406
|
readonly failed: import("@angular/core").OutputEmitterRef<unknown>;
|
|
217
407
|
readonly translations: import("@angular/core").Signal<import("@tectra-ng/core/config").TxTranslations>;
|
|
218
408
|
readonly exporting: import("@angular/core").WritableSignal<boolean>;
|
|
@@ -304,7 +494,9 @@ export declare abstract class TxExportAction<T = TxExportRow> {
|
|
|
304
494
|
"failed": "failed";
|
|
305
495
|
}, never, never, true, never>;
|
|
306
496
|
}
|
|
497
|
+
/** Base of the single-format export buttons: the format, icon and tooltip. */
|
|
307
498
|
declare abstract class TxExportButtonBase<T = TxExportRow> extends TxExportAction<T> {
|
|
499
|
+
/** Classes and styles of the parts: `root`, `button` */
|
|
308
500
|
readonly pt: import("@angular/core").InputSignal<Partial<Record<TxExportPart, import("@tectra-ng/core/config").TxPassThroughValue<TxExportButtonBase<T>>>> | undefined>;
|
|
309
501
|
readonly passThrough: import("@angular/core").Signal<Partial<Record<TxExportPart, import("@tectra-ng/core/config").TxPassThroughPart>>>;
|
|
310
502
|
abstract readonly resolvedFormat: () => TxExportFormat;
|
|
@@ -320,7 +512,9 @@ declare abstract class TxExportButtonBase<T = TxExportRow> extends TxExportActio
|
|
|
320
512
|
};
|
|
321
513
|
}, {}, never, never, true, never>;
|
|
322
514
|
}
|
|
515
|
+
/** Icon button that exports to the format given by `format`. */
|
|
323
516
|
export declare class TxExportButton<T = TxExportRow> extends TxExportButtonBase<T> {
|
|
517
|
+
/** `tx-export-button` — `csv`, `excel`, `word`, `pdf`, `json`, `html`, `markdown`, `copy` or `print` */
|
|
324
518
|
readonly format: import("@angular/core").InputSignal<TxExportFormat>;
|
|
325
519
|
readonly resolvedFormat: import("@angular/core").Signal<TxExportFormat>;
|
|
326
520
|
static ɵfac: i0.ɵɵFactoryDeclaration<TxExportButton<any>, never>;
|
|
@@ -332,30 +526,39 @@ export declare class TxExportButton<T = TxExportRow> extends TxExportButtonBase<
|
|
|
332
526
|
};
|
|
333
527
|
}, {}, never, never, true, never>;
|
|
334
528
|
}
|
|
529
|
+
/** Icon button that exports to CSV. */
|
|
335
530
|
export declare class TxExportCsv<T = TxExportRow> extends TxExportButtonBase<T> {
|
|
336
531
|
readonly resolvedFormat: () => "csv";
|
|
337
532
|
static ɵfac: i0.ɵɵFactoryDeclaration<TxExportCsv<any>, never>;
|
|
338
533
|
static ɵcmp: i0.ɵɵComponentDeclaration<TxExportCsv<any>, "tx-export-csv", never, {}, {}, never, never, true, never>;
|
|
339
534
|
}
|
|
535
|
+
/** Icon button that exports to Excel. */
|
|
340
536
|
export declare class TxExportExcel<T = TxExportRow> extends TxExportButtonBase<T> {
|
|
341
537
|
readonly resolvedFormat: () => "excel";
|
|
342
538
|
static ɵfac: i0.ɵɵFactoryDeclaration<TxExportExcel<any>, never>;
|
|
343
539
|
static ɵcmp: i0.ɵɵComponentDeclaration<TxExportExcel<any>, "tx-export-excel", never, {}, {}, never, never, true, never>;
|
|
344
540
|
}
|
|
541
|
+
/** Icon button that exports to Word. */
|
|
345
542
|
export declare class TxExportWord<T = TxExportRow> extends TxExportButtonBase<T> {
|
|
346
543
|
readonly resolvedFormat: () => "word";
|
|
347
544
|
static ɵfac: i0.ɵɵFactoryDeclaration<TxExportWord<any>, never>;
|
|
348
545
|
static ɵcmp: i0.ɵɵComponentDeclaration<TxExportWord<any>, "tx-export-word", never, {}, {}, never, never, true, never>;
|
|
349
546
|
}
|
|
547
|
+
/** Icon button that exports to PDF. */
|
|
350
548
|
export declare class TxExportPdf<T = TxExportRow> extends TxExportButtonBase<T> {
|
|
351
549
|
readonly resolvedFormat: () => "pdf";
|
|
352
550
|
static ɵfac: i0.ɵɵFactoryDeclaration<TxExportPdf<any>, never>;
|
|
353
551
|
static ɵcmp: i0.ɵɵComponentDeclaration<TxExportPdf<any>, "tx-export-pdf", never, {}, {}, never, never, true, never>;
|
|
354
552
|
}
|
|
553
|
+
/** Names of the parts of `tx-export` that `pt` can style. */
|
|
355
554
|
export type TxExportMenuPart = 'root' | 'button';
|
|
555
|
+
/** Every format in the order the `tx-export` menu lists them by default. */
|
|
356
556
|
export declare const TX_EXPORT_FORMATS: readonly TxExportFormat[];
|
|
557
|
+
/** Split button with a menu of export formats; the main button runs the first format. */
|
|
357
558
|
export declare class TxExport<T = TxExportRow> extends TxExportAction<T> {
|
|
559
|
+
/** `tx-export` — formats in the menu, in order; the main button runs the first one */
|
|
358
560
|
readonly formats: import("@angular/core").InputSignal<readonly TxExportFormat[]>;
|
|
561
|
+
/** Classes and styles of the parts: `root`, `button` */
|
|
359
562
|
readonly pt: import("@angular/core").InputSignal<Partial<Record<TxExportMenuPart, import("@tectra-ng/core/config").TxPassThroughValue<TxExport<T>>>> | undefined>;
|
|
360
563
|
readonly passThrough: import("@angular/core").Signal<Partial<Record<TxExportMenuPart, import("@tectra-ng/core/config").TxPassThroughPart>>>;
|
|
361
564
|
readonly mainFormat: import("@angular/core").Signal<TxExportFormat>;
|
|
@@ -376,47 +579,82 @@ export declare class TxExport<T = TxExportRow> extends TxExportAction<T> {
|
|
|
376
579
|
};
|
|
377
580
|
}, {}, never, never, true, never>;
|
|
378
581
|
}
|
|
582
|
+
/** Writes the table as CSV text with the separator, line ending and quoting of the options. */
|
|
379
583
|
export declare function writeCsv(table: TxExportTable, options?: TxExportCsvOptions): string;
|
|
584
|
+
/** Writes the table as tab-separated text, as for the clipboard. */
|
|
380
585
|
export declare function writeTsv(table: TxExportTable, context: TxExportTextContext, header?: boolean): string;
|
|
586
|
+
/** Writes the table as a JSON array of objects keyed by field or title. */
|
|
381
587
|
export declare function writeJson(table: TxExportTable, options?: TxExportJsonOptions): string;
|
|
588
|
+
/** Writes the table as an HTML `<table>` string. */
|
|
382
589
|
export declare function htmlTable(table: TxExportTable, context: TxExportTextContext, header?: boolean): string;
|
|
590
|
+
/** Writes the table as a full HTML page with the title, subtitle and date. */
|
|
383
591
|
export declare function writeHtml(table: TxExportTable, options: (TxExportHtmlOptions & {
|
|
384
592
|
lang?: string;
|
|
385
593
|
page?: string;
|
|
386
594
|
}) | undefined, context: TxExportTextContext, date?: Date): string;
|
|
595
|
+
/** Writes the table as a Markdown table with an optional title. */
|
|
387
596
|
export declare function writeMarkdown(table: TxExportTable, options: TxExportMarkdownOptions | undefined, context: TxExportTextContext): string;
|
|
597
|
+
/** Turns a zero-based column index into a spreadsheet letter: 0 is `A`, 26 is `AA`. */
|
|
388
598
|
export declare function columnName(index: number): string;
|
|
599
|
+
/** Turns a date into an Excel serial number, keeping local time. */
|
|
389
600
|
export declare function excelSerial(date: Date): number;
|
|
601
|
+
/**
|
|
602
|
+
* Cleans a worksheet name: drops characters Excel rejects, cuts it to 31 characters and falls back to `Sheet1`.
|
|
603
|
+
*/
|
|
390
604
|
export declare function sheetName(name: string | undefined): string;
|
|
605
|
+
/** Works out the width in characters of every column from its content within the min and max width. */
|
|
391
606
|
export declare function excelWidths(table: TxExportTable, options?: TxExportExcelOptions): number[];
|
|
607
|
+
/** Builds the XML of the worksheet and its styles for the table. */
|
|
392
608
|
export declare function xlsxParts(table: TxExportTable, options?: TxExportExcelOptions): {
|
|
393
609
|
sheet: string;
|
|
394
610
|
styles: string;
|
|
395
611
|
sheetName: string;
|
|
396
612
|
};
|
|
613
|
+
/** Writes the table as an Excel `.xlsx` file blob. */
|
|
397
614
|
export declare function writeXlsx(table: TxExportTable, options?: TxExportExcelOptions, date?: Date): Promise<Blob>;
|
|
615
|
+
/** Builds the XML body of the Word document for the table. */
|
|
398
616
|
export declare function docxDocument(table: TxExportTable, options: TxExportWordOptions, context: TxExportTextContext, date: Date): string;
|
|
617
|
+
/** Writes the table as a Word `.docx` file blob. */
|
|
399
618
|
export declare function writeDocx(table: TxExportTable, options?: TxExportWordOptions, context?: TxExportTextContext, date?: Date): Promise<Blob>;
|
|
619
|
+
/** A parsed TrueType font: metrics, glyph lookup and a subsetter. */
|
|
400
620
|
interface TxTrueTypeFont {
|
|
621
|
+
/** Font units in one em. */
|
|
401
622
|
readonly unitsPerEm: number;
|
|
623
|
+
/** Height above the baseline in font units. */
|
|
402
624
|
readonly ascent: number;
|
|
625
|
+
/** Depth below the baseline in font units, usually negative. */
|
|
403
626
|
readonly descent: number;
|
|
627
|
+
/** Height of capital letters in font units. */
|
|
404
628
|
readonly capHeight: number;
|
|
629
|
+
/** Bounding box of all glyphs as `[xMin, yMin, xMax, yMax]` in font units. */
|
|
405
630
|
readonly bbox: readonly [number, number, number, number];
|
|
631
|
+
/** Number of glyphs in the font. */
|
|
406
632
|
readonly numGlyphs: number;
|
|
633
|
+
/** Name of the font from its name table; `Font` when it has none. */
|
|
407
634
|
readonly name: string;
|
|
635
|
+
/** Gives the glyph for a Unicode code point; 0 when the font has none. */
|
|
408
636
|
glyphId(codePoint: number): number;
|
|
637
|
+
/** Gives the width of a glyph in font units. */
|
|
409
638
|
advance(glyph: number): number;
|
|
639
|
+
/** Builds a smaller font file that keeps only the given glyphs. */
|
|
410
640
|
subset(glyphs: ReadonlySet<number>): Uint8Array;
|
|
411
641
|
}
|
|
642
|
+
/** Reads a TrueType font file; the result measures glyphs and cuts a smaller font with only the glyphs used. */
|
|
412
643
|
export declare function parseTrueType(input: Uint8Array): TxTrueTypeFont;
|
|
644
|
+
/** Breaks text into lines that fit the width, measured by the given function. */
|
|
413
645
|
export declare function wrapText(text: string, width: number, measure: (text: string) => number): string[];
|
|
646
|
+
/** Writes the table as a PDF file blob, with the glyphs it uses embedded from the font. */
|
|
414
647
|
export declare function writePdf(table: TxExportTable, options: TxExportPdfOptions, font: TxExportFont, context?: TxExportTextContext, date?: Date): Promise<Blob>;
|
|
648
|
+
/** One file in a zip archive. */
|
|
415
649
|
interface TxZipEntry {
|
|
650
|
+
/** Path of the file in the archive. */
|
|
416
651
|
name: string;
|
|
652
|
+
/** Content of the file: bytes, or text written as UTF-8. */
|
|
417
653
|
data: Uint8Array | string;
|
|
418
654
|
}
|
|
655
|
+
/** Computes the CRC-32 checksum of the bytes, as the zip format needs. */
|
|
419
656
|
export declare function crc32(bytes: Uint8Array): number;
|
|
657
|
+
/** Packs the entries into a zip archive, deflated unless `deflate` is `false`. */
|
|
420
658
|
export declare function zip(entries: readonly TxZipEntry[], date?: Date, deflate?: boolean): Promise<Uint8Array>;
|
|
421
659
|
export type { TxTrueTypeFont, TxZipEntry };
|
|
422
660
|
//# sourceMappingURL=tectra-ng-ui-export.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tectra-ng-ui-export.d.ts","names":[],"sources":["../../../../packages/ui/export/src/export.types.ts","../../../../packages/ui/export/src/export.utils.ts","../../../../packages/ui/export/src/export.service.ts","../../../../packages/ui/export/src/export-action.directive.ts","../../../../packages/ui/export/src/export-button.component.ts","../../../../packages/ui/export/src/export-menu.component.ts","../../../../packages/ui/export/src/writers/text.ts","../../../../packages/ui/export/src/writers/xlsx.ts","../../../../packages/ui/export/src/writers/docx.ts","../../../../packages/ui/export/src/writers/truetype.ts","../../../../packages/ui/export/src/writers/pdf.ts","../../../../packages/ui/export/src/writers/zip.ts"],"mappings":"
|
|
1
|
+
{"version":3,"file":"tectra-ng-ui-export.d.ts","names":[],"sources":["../../../../packages/ui/export/src/export.types.ts","../../../../packages/ui/export/src/export.utils.ts","../../../../packages/ui/export/src/export.service.ts","../../../../packages/ui/export/src/export-action.directive.ts","../../../../packages/ui/export/src/export-button.component.ts","../../../../packages/ui/export/src/export-menu.component.ts","../../../../packages/ui/export/src/writers/text.ts","../../../../packages/ui/export/src/writers/xlsx.ts","../../../../packages/ui/export/src/writers/docx.ts","../../../../packages/ui/export/src/writers/truetype.ts","../../../../packages/ui/export/src/writers/pdf.ts","../../../../packages/ui/export/src/writers/zip.ts"],"mappings":";;;;;;YACY,cAAc;;;;YAKd;;YAGA;;YAGA;;YAGA;;YAGA;;YAGA;;iBAGK,cAAc,IAAI;;EAEjC;;EAEA;;EAEA,cAAc,gBAAgB,KAAK,GAAG;;EAEtC,OAAO;;EAEP;;EAEA,QAAQ;;EAER;;EAEA,mBAAmB;;;iBAIJ;;EAEf;;EAEA;;EAEA,MAAM;;EAEN;;EAEA,OAAO;;EAEP;;;iBAIe;;EAEf,SAAS;;EAET;;;iBAIe;;EAEf;;EAEA;;EAEA;;EAEA;;;iBAIe,4BAA4B;;EAE3C,WAAW;;EAEX,cAAc;;EAEd;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;;iBAIe;;EAEf,SAAS,cAAc;;EAEvB,OAAO,cAAc;;;iBAIN;;EAEf;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;;iBAIe;;EAEf;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;;iBAIe,4BAA4B;;EAE3C;;;iBAIe,2BAA2B;;EAE1C,aAAa,QAAQ;;EAErB;;EAEA;;EAEA;;EAEA;;;iBAIe;;EAEf;;EAEA;;;iBAIe,4BAA4B;;EAE3C;;;iBAIe;;EAEf;;EAEA;;;iBAIe;;EAEf;;EAEA;;;iBAIe,6BAA6B;;EAE5C,WAAW;;EAEX,cAAc;;EAEd;;EAEA;;;iBAIe;;EAEf;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA,MAAM;;EAEN,QAAQ;;EAER,OAAO;;EAEP,MAAM;;EAEN,OAAO;;EAEP,OAAO;;EAEP,WAAW;;EAEX,OAAO;;EAEP,QAAQ;;;YAIE,cAAc,IAAI,qBAAqB,iBAAiB;;iBAGnD,gBAAgB,IAAI;;EAEnC,QAAQ;;EAER,eAAe;;EAEf,iBAAiB,cAAc;;EAE/B,UAAU;;;iBAIK;;EAEf,QAAQ;;EAER;;EAEA;;;iBAIe,gBAAgB,IAAI,qBAAqB;;EAExD,eAAe;;;wBC9RD,gBAAgB,cAAc;;wBAQ9B,UAAU,GAAG,iBAAiB,cAAc,MAAM,SAAS,iBAAiB,cAAc;;wBAK1F,aAAa,GAAG,eAAe,KAAK,iBAAiB,cAAc,MAAM,SAAS;;;;wBAQlF,iBAAiB,GAAG,eAAe,KAAK,iBAAiB,cAAc,MAAM,SAAS,iBAAiB;;;;wBA0BvG,UAAU,6BAA6B;;wBAsBvC,OAAO,iBAAiB;;iBAUvB;;EAEf;;EAEA;;EAEA;;;wBAIc,SAAS,gBAAgB,QAAQ,gBAAgB,SAAS;;wBAgB1D,SAAS,gBAAgB,MAAM;;;;wBAW/B,eAAe;;;;wBAOf,QAAQ,gBAAgB,oBAAiB;EAAW;EAAoB;;;wBAQxE,YAAY,yCAAyC;;wBAKrD,cAAc,kBAAkB;;;;wBAOhC,aAAa,UAAU,UAAU,MAAM,MAAM;;wBAe7C,YAAY,UAAU,UAAU,aAAa;;wBAK7C,UAAU;;wBAUV,SAAS,2BAA2B;;qBCzKvC,mBAAiB,eAAA;;;;wBAKd,gBAAgB,SAAS,kBAAkB;;qBAK9C,sBAAsB,OAAO;;;;wBAiB1B,sBAAsB,SAAS,iCAAiC;;;;wBAehE,yBAAyB,QAAQ;;qBAMpC;UACH;UACA;UACA;;EAGF,OAAO,GAAG,SAAS,gBAAgB,KAAK,QAAQ;;EAkBhD,KAAK,QAAQ,QAAQ,mCAAmC,OAAO,eAAe,UAAS,iBAAsB,UAAO,sBAA+B;IAAU,MAAM;IAAM;;;EA2B/K,YAAY,UAAS,kBAAuB;UAKpC;UAIM;UAcA;SA1EH,MAAA,GAAA,qBAAA;;;;qBC/CA,iBAAiB,OAAO;;8BAcf,eAAe,IAAI;UAC/B;UACA;UACA;UACA;;WAEC,8BAAI,qBAAA;;WACJ,gCAAM,qBAAA,cAAA;;WACN,mCAAS,YAAA,cAAA;;WACT,iCAAO,YAAA;;WACP,kCAAQ;;WACR,+BAAK;;WACL,iCAAO;;WACP,kCAAQ;;WACR,+BAAK;;WACL,iCAAO;;WACP,kCAAQ,YAAA;;WACR,iCAAO,YAAA;;WACP,8BAAI,YAAA;;WACJ,mCAAS,YAAA;;WACT,kCAAQ;;WAER,kCAAQ,iBAAA,gBAAA;;WACR,gCAAM;WAEN,sCAAY,wCAAA;WACZ,mCAAS;WACT,gCAAM;WACN,8BAAI;EAEb,YAAY,QAAQ;EAed,IAAI,QAAQ,iBAAiB;UAsB3B;SAnEY,MAAA,GAAA,qBAAA;SAAA,MAAA,GAAA,uBAAA;IAAc;MAAA;MAAA;MAAA;;IAAA;MAAA;MAAA;MAAA;;IAAA;MAAA;MAAA;MAAA;;IAAA;MAAA;MAAA;MAAA;;IAAA;MAAA;MAAA;MAAA;;IAAA;MAAA;MAAA;MAAA;;IAAA;MAAA;MAAA;MAAA;;IAAA;MAAA;MAAA;MAAA;;IAAA;MAAA;MAAA;MAAA;;IAAA;MAAA;MAAA;MAAA;;IAAA;MAAA;MAAA;MAAA;;IAAA;MAAA;MAAA;MAAA;;IAAA;MAAA;MAAA;MAAA;;IAAA;MAAA;MAAA;MAAA;;IAAA;MAAA;MAAA;MAAA;;;IAAA;IAAA;IAAA;;;;uBCYrB,mBAAmB,IAAI,qBAAqB,eAAe;;WAC/D,4BAAE,YAAA,QAAA,OAAA,+CAAA,mBAAA,mBAAA;WACF,qCAAW,OAAA,QAAA,OAAA,+CAAA;oBAEF,sBAAsB;WAE/B,8BAAI;WACJ,yCAAe;WACf,mCAAS;SARL,MAAA,GAAA,qBAAA;SAAA,MAAA,GAAA,uBAAA;IAAkB;MAAA;MAAA;MAAA;;;;;qBAoBpB,eAAe,IAAI,qBAAqB,mBAAmB;;WAC7D,gCAAM,YAAA;WACN,wCAAc,OAAA;SAFZ,MAAA,GAAA,qBAAA;SAAA,MAAA,GAAA,uBAAA;IAAc;MAAA;MAAA;MAAA;;;;;qBAcd,YAAY,IAAI,qBAAqB,mBAAmB;WAC1D;SADE,MAAA,GAAA,qBAAA;SAAA,MAAA,GAAA,uBAAA;;;qBAaA,cAAc,IAAI,qBAAqB,mBAAmB;WAC5D;SADE,MAAA,GAAA,qBAAA;SAAA,MAAA,GAAA,uBAAA;;;qBAaA,aAAa,IAAI,qBAAqB,mBAAmB;WAC3D;SADE,MAAA,GAAA,qBAAA;SAAA,MAAA,GAAA,uBAAA;;;qBAaA,YAAY,IAAI,qBAAqB,mBAAmB;WAC1D;SADE,MAAA,GAAA,qBAAA;SAAA,MAAA,GAAA,uBAAA;;;YCrGD;;qBAaC,4BAA4B;;qBAgC5B,SAAS,IAAI,qBAAqB,eAAe;;WACnD,iCAAO,qBAAA;;WACP,4BAAE,YAAA,QAAA,OAAA,mDAAA,mBAAA,SAAA;WACF,qCAAW,OAAA,QAAA,OAAA,mDAAA;WAEX,oCAAU,OAAA;WACV,kCAAQ;WACR,uCAAa;WACb,+BAAK,OAAA;SARH,MAAA,GAAA,qBAAA;SAAA,MAAA,GAAA,uBAAA;IAAQ;MAAA;MAAA;MAAA;;IAAA;MAAA;MAAA;MAAA;;;;;wBClDL,SAAS,OAAO,eAAe,UAAS;;wBASxC,SAAS,OAAO,eAAe,SAAS,qBAAqB;;wBAQ7D,UAAU,OAAO,eAAe,UAAS;;wBAWzC,UAAU,OAAO,eAAe,SAAS,qBAAqB;;wBAoB9D,UAAU,OAAO,eAAe,UAAS;EAAwB;EAAe;gBAAsB,SAAS,qBAAqB,OAAI;;wBAgBxI,cAAc,OAAO,eAAe,SAAS,qCAA8B,SAAS;;wBC1DpF,WAAW;;wBAOX,YAAY,MAAM;;;;wBAQlB,UAAU;;wBAqEV,YAAY,OAAO,eAAe,UAAS;;wBA6D3C,UAAU,OAAO,eAAe,UAAS;EAA8B;EAAe;EAAgB;;;wBAOhG,UAAU,OAAO,eAAe,UAAS,sBAA2B,OAAI,OAAgB,QAAQ;;wBC3ItG,aAAa,OAAO,eAAe,SAAS,qBAAqB,SAAS,qBAAqB,MAAM;;wBA0D/F,UAAU,OAAO,eAAe,UAAS,qBAA0B,UAAS,qBAAgD,OAAI,OAAgB,QAAQ;;UCjF7J;;WAEN;;WAEA;;WAEA;;WAEA;;WAEA;;WAEA;;WAEA;;EAET,QAAQ;;EAER,QAAQ;;EAER,OAAO,QAAQ,sBAAsB;;;wBAoBvB,cAAc,OAAO,aAAa;;wBCsBlC,SAAS,cAAc,eAAe,UAAU;;wBAyE1C,SACpB,OAAO,eACP,SAAS,oBACT,MAAM,cACN,UAAS,qBACT,OAAI,OACH,QAAQ;;UC3IM;;EAEf;;EAEA,MAAM;;;wBAcQ,MAAM,OAAO;;wBAaP,IAAI,kBAAkB,cAAc,OAAI,MAAe,oBAAiB,QAAQ"}
|