@univerjs-pro/docs-column 1.0.0-alpha.1 → 1.0.0-alpha.2
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 -4
- package/lib/cjs/facade.js +1 -1
- package/lib/cjs/index.js +1 -1
- package/lib/es/facade.js +1 -1
- package/lib/es/index.js +1 -1
- package/lib/facade.js +1 -1
- package/lib/index.js +1 -1
- package/lib/types/commands/column-mutation.d.ts +2 -2
- package/lib/types/commands/column-structure.command.d.ts +2 -1
- package/lib/types/common/column-types.d.ts +4 -8
- package/lib/types/common/document-skeleton-iterators.d.ts +4 -1
- package/lib/types/config/config.d.ts +5 -0
- package/lib/types/facade/f-document-column-group.d.ts +100 -32
- package/lib/types/facade/f-document-column.d.ts +31 -19
- package/lib/types/facade/f-document.d.ts +31 -38
- package/lib/types/facade/f-enum.d.ts +16 -15
- package/lib/types/facade/types.d.ts +2 -1
- package/lib/types/index.d.ts +13 -10
- package/lib/types/plugin.d.ts +15 -0
- package/lib/umd/facade.js +1 -1
- package/lib/umd/index.js +1 -1
- package/package.json +6 -5
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { ICustomColumnGroup, IDocsColumnGroupOffsetRange } from '@univerjs-pro/docs-column';
|
|
2
|
-
import type {
|
|
1
|
+
import type { ColumnPosition, ICustomColumnGroup, IDocsColumnGroupOffsetRange } from '@univerjs-pro/docs-column';
|
|
2
|
+
import type { Injector } from '@univerjs/core';
|
|
3
3
|
import type { FDocument } from '@univerjs/docs/facade';
|
|
4
4
|
import type { IDocsColumnDescription } from './types';
|
|
5
5
|
import { FDocumentColumn } from './f-document-column';
|
|
@@ -11,27 +11,34 @@ import { FDocumentColumn } from './f-document-column';
|
|
|
11
11
|
* so undo/redo and collaboration receive the same document changes as UI operations.
|
|
12
12
|
* @example
|
|
13
13
|
* ```ts
|
|
14
|
-
* import '@univerjs/docs/facade';
|
|
15
|
-
* import '@univerjs-pro/docs-column/facade';
|
|
16
|
-
*
|
|
17
14
|
* const fDocument = univerAPI.getActiveDocument();
|
|
18
|
-
* const group = fDocument?.getColumnGroup('column-group-1');
|
|
19
15
|
*
|
|
16
|
+
* const groups = fDocument.getColumnGroups();
|
|
17
|
+
* console.log(groups.map((group) => group.describe()));
|
|
18
|
+
*
|
|
19
|
+
* const group = fDocument.findColumnGroupByText('Launch');
|
|
20
20
|
* console.log(group?.describe());
|
|
21
|
+
*
|
|
21
22
|
* group?.setWidthRatios([1.2, 1, 0.8]);
|
|
22
23
|
* ```
|
|
23
24
|
*/
|
|
24
25
|
export declare class FDocumentColumnGroup {
|
|
25
26
|
private readonly _document;
|
|
26
27
|
private readonly _columnGroupId;
|
|
27
|
-
private readonly
|
|
28
|
-
constructor(_document: FDocument, _columnGroupId: string,
|
|
28
|
+
private readonly _injector;
|
|
29
|
+
constructor(_document: FDocument, _columnGroupId: string, _injector: Injector);
|
|
29
30
|
/**
|
|
30
31
|
* Returns the column group id.
|
|
31
32
|
* @returns {string} The persisted column group id.
|
|
32
33
|
* @example
|
|
33
34
|
* ```ts
|
|
34
|
-
*
|
|
35
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
36
|
+
* const groups = fDocument.getColumnGroups();
|
|
37
|
+
*
|
|
38
|
+
* if (groups.length > 0) {
|
|
39
|
+
* const group = groups[0];
|
|
40
|
+
* console.log(group.getId());
|
|
41
|
+
* }
|
|
35
42
|
* ```
|
|
36
43
|
*/
|
|
37
44
|
getId(): string;
|
|
@@ -40,22 +47,29 @@ export declare class FDocumentColumnGroup {
|
|
|
40
47
|
* @returns {ICustomColumnGroup | undefined} The group config, or `undefined` if the group is missing.
|
|
41
48
|
* @example
|
|
42
49
|
* ```ts
|
|
43
|
-
*
|
|
50
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
51
|
+
* const groups = fDocument.getColumnGroups();
|
|
52
|
+
*
|
|
53
|
+
* if (groups.length > 0) {
|
|
54
|
+
* const group = groups[0];
|
|
55
|
+
* console.log(group.getConfig());
|
|
56
|
+
* }
|
|
44
57
|
* ```
|
|
45
58
|
*/
|
|
46
59
|
getConfig(): ICustomColumnGroup | undefined;
|
|
47
|
-
/**
|
|
48
|
-
* @deprecated Use `getConfig()` instead. Column layout config now lives directly on `body.columnGroups`.
|
|
49
|
-
*/
|
|
50
|
-
getSource(): ICustomColumnGroup | undefined;
|
|
51
60
|
/**
|
|
52
61
|
* Returns the structural range for this column group.
|
|
53
62
|
* The group range includes the column group start and end structural tokens.
|
|
54
63
|
* @returns {IDocsColumnGroupOffsetRange | null} The parsed group range, or `null` if the group is missing.
|
|
55
64
|
* @example
|
|
56
65
|
* ```ts
|
|
57
|
-
* const
|
|
58
|
-
*
|
|
66
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
67
|
+
* const groups = fDocument.getColumnGroups();
|
|
68
|
+
*
|
|
69
|
+
* if (groups.length > 0) {
|
|
70
|
+
* const group = groups[0];
|
|
71
|
+
* console.log(group.getRange());
|
|
72
|
+
* }
|
|
59
73
|
* ```
|
|
60
74
|
*/
|
|
61
75
|
getRange(): IDocsColumnGroupOffsetRange | null;
|
|
@@ -64,7 +78,13 @@ export declare class FDocumentColumnGroup {
|
|
|
64
78
|
* @returns {number} The column count, or `0` if the group is missing.
|
|
65
79
|
* @example
|
|
66
80
|
* ```ts
|
|
67
|
-
*
|
|
81
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
82
|
+
* const groups = fDocument.getColumnGroups();
|
|
83
|
+
*
|
|
84
|
+
* if (groups.length > 0) {
|
|
85
|
+
* const group = groups[0];
|
|
86
|
+
* console.log(group.getColumnCount());
|
|
87
|
+
* }
|
|
68
88
|
* ```
|
|
69
89
|
*/
|
|
70
90
|
getColumnCount(): number;
|
|
@@ -73,8 +93,14 @@ export declare class FDocumentColumnGroup {
|
|
|
73
93
|
* @returns {FDocumentColumn[]} Column wrappers, or an empty array when the group is missing.
|
|
74
94
|
* @example
|
|
75
95
|
* ```ts
|
|
76
|
-
* const
|
|
77
|
-
*
|
|
96
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
97
|
+
* const groups = fDocument.getColumnGroups();
|
|
98
|
+
*
|
|
99
|
+
* if (groups.length > 0) {
|
|
100
|
+
* const group = groups[0];
|
|
101
|
+
* const columns = group.getColumns();
|
|
102
|
+
* columns.forEach((column) => console.log(column.getText()));
|
|
103
|
+
* }
|
|
78
104
|
* ```
|
|
79
105
|
*/
|
|
80
106
|
getColumns(): FDocumentColumn[];
|
|
@@ -84,8 +110,18 @@ export declare class FDocumentColumnGroup {
|
|
|
84
110
|
* @returns {FDocumentColumn | null} The column wrapper, or `null` if no column matches.
|
|
85
111
|
* @example
|
|
86
112
|
* ```ts
|
|
87
|
-
* const
|
|
88
|
-
* const
|
|
113
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
114
|
+
* const groups = fDocument.getColumnGroups();
|
|
115
|
+
*
|
|
116
|
+
* if (groups.length > 0) {
|
|
117
|
+
* const group = groups[0];
|
|
118
|
+
*
|
|
119
|
+
* const columnWithIndex = group.getColumn(0);
|
|
120
|
+
* console.log(columnWithIndex?.getText());
|
|
121
|
+
*
|
|
122
|
+
* const columnWithId = group.getColumn('right-column');
|
|
123
|
+
* console.log(columnWithId?.getText());
|
|
124
|
+
* }
|
|
89
125
|
* ```
|
|
90
126
|
*/
|
|
91
127
|
getColumn(indexOrId: number | string): FDocumentColumn | null;
|
|
@@ -94,7 +130,13 @@ export declare class FDocumentColumnGroup {
|
|
|
94
130
|
* @returns {number[]} The width ratios from the column group config.
|
|
95
131
|
* @example
|
|
96
132
|
* ```ts
|
|
97
|
-
*
|
|
133
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
134
|
+
* const groups = fDocument.getColumnGroups();
|
|
135
|
+
*
|
|
136
|
+
* if (groups.length > 0) {
|
|
137
|
+
* const group = groups[0];
|
|
138
|
+
* console.log(group.getWidthRatios());
|
|
139
|
+
* }
|
|
98
140
|
* ```
|
|
99
141
|
*/
|
|
100
142
|
getWidthRatios(): number[];
|
|
@@ -103,8 +145,13 @@ export declare class FDocumentColumnGroup {
|
|
|
103
145
|
* @returns {IDocsColumnDescription} Id, layout config, column ratios, and sample column text.
|
|
104
146
|
* @example
|
|
105
147
|
* ```ts
|
|
106
|
-
* const
|
|
107
|
-
*
|
|
148
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
149
|
+
* const groups = fDocument.getColumnGroups();
|
|
150
|
+
*
|
|
151
|
+
* if (groups.length > 0) {
|
|
152
|
+
* const group = groups[0];
|
|
153
|
+
* console.log(group.describe());
|
|
154
|
+
* }
|
|
108
155
|
* ```
|
|
109
156
|
*/
|
|
110
157
|
describe(): IDocsColumnDescription;
|
|
@@ -115,6 +162,8 @@ export declare class FDocumentColumnGroup {
|
|
|
115
162
|
* @returns {boolean} `true` if the mutation was committed.
|
|
116
163
|
* @example
|
|
117
164
|
* ```ts
|
|
165
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
166
|
+
* const group = fDocument.findColumnGroupByText('Launch');
|
|
118
167
|
* group.setWidthRatios([1.2, 1, 0.8]);
|
|
119
168
|
* ```
|
|
120
169
|
*/
|
|
@@ -122,16 +171,28 @@ export declare class FDocumentColumnGroup {
|
|
|
122
171
|
/**
|
|
123
172
|
* Adds an empty column to the left or right of an existing column.
|
|
124
173
|
* @param {string} targetColumnId Existing column id used as the insertion anchor.
|
|
125
|
-
* @param {
|
|
174
|
+
* @param {ColumnPosition} position Whether the new column is inserted to the left or right of the target column.
|
|
126
175
|
* @param {string} [columnId] Optional id for the inserted column. A random id is generated when omitted.
|
|
127
176
|
* @returns {FDocumentColumn | null} The inserted column wrapper, or `null` if the mutation failed.
|
|
128
177
|
* @example
|
|
129
178
|
* ```ts
|
|
130
|
-
* const
|
|
131
|
-
*
|
|
179
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
180
|
+
* const group = fDocument.findColumnGroupByText('Launch');
|
|
181
|
+
* const columns = group.getColumns();
|
|
182
|
+
*
|
|
183
|
+
* // Add a new column to the left of the last column in the group.
|
|
184
|
+
* if (columns.length > 0) {
|
|
185
|
+
* const rightColumn = group.getColumn(columns.length - 1);
|
|
186
|
+
* const inserted = group.addColumn(
|
|
187
|
+
* rightColumn.getId(),
|
|
188
|
+
* univerAPI.Enum.DocsColumnPositionEnum.LEFT,
|
|
189
|
+
* 'new-column'
|
|
190
|
+
* );
|
|
191
|
+
* console.log(inserted?.getInsertOffset());
|
|
192
|
+
* }
|
|
132
193
|
* ```
|
|
133
194
|
*/
|
|
134
|
-
addColumn(targetColumnId: string, position:
|
|
195
|
+
addColumn(targetColumnId: string, position: ColumnPosition, columnId?: string): FDocumentColumn | null;
|
|
135
196
|
/**
|
|
136
197
|
* Deletes a column from this group.
|
|
137
198
|
* Column groups must keep at least two columns, so deleting from a two-column group returns `false`.
|
|
@@ -139,7 +200,12 @@ export declare class FDocumentColumnGroup {
|
|
|
139
200
|
* @returns {boolean} `true` if the mutation was committed.
|
|
140
201
|
* @example
|
|
141
202
|
* ```ts
|
|
142
|
-
*
|
|
203
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
204
|
+
* const group = fDocument.findColumnGroupByText('Launch');
|
|
205
|
+
* const columns = group.getColumns();
|
|
206
|
+
*
|
|
207
|
+
* // Delete the first column in the group.
|
|
208
|
+
* group.deleteColumn(columns[0].getId());
|
|
143
209
|
* ```
|
|
144
210
|
*/
|
|
145
211
|
deleteColumn(columnId: string): boolean;
|
|
@@ -148,10 +214,12 @@ export declare class FDocumentColumnGroup {
|
|
|
148
214
|
* @returns {boolean} `true` if the mutation was committed.
|
|
149
215
|
* @example
|
|
150
216
|
* ```ts
|
|
151
|
-
*
|
|
217
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
218
|
+
* const group = fDocument.findColumnGroupByText('Launch');
|
|
219
|
+
* const removed = group.remove();
|
|
220
|
+
* console.log(removed);
|
|
152
221
|
* ```
|
|
153
222
|
*/
|
|
154
|
-
|
|
155
|
-
private _getDocumentData;
|
|
223
|
+
remove(): boolean;
|
|
156
224
|
private _createFDocumentColumn;
|
|
157
225
|
}
|
|
@@ -8,12 +8,12 @@ import type { IDocsColumnContentRange } from './types';
|
|
|
8
8
|
* is called, so it stays useful after edits insert content before the column group.
|
|
9
9
|
* @example
|
|
10
10
|
* ```ts
|
|
11
|
-
* import '@univerjs/docs/facade';
|
|
12
|
-
* import '@univerjs-pro/docs-column/facade';
|
|
13
|
-
*
|
|
14
11
|
* const fDocument = univerAPI.getActiveDocument();
|
|
15
|
-
* const column = fDocument?.getColumnGroup('column-group-1')?.getColumn(0);
|
|
16
12
|
*
|
|
13
|
+
* const group = fDocument.findColumnGroupByText('Launch');
|
|
14
|
+
* console.log(group?.describe());
|
|
15
|
+
*
|
|
16
|
+
* const column = group?.getColumn(0);
|
|
17
17
|
* console.log(column?.getText());
|
|
18
18
|
* console.log(column?.getInsertOffset());
|
|
19
19
|
* ```
|
|
@@ -28,7 +28,9 @@ export declare class FDocumentColumn {
|
|
|
28
28
|
* @returns {string} The persisted column id.
|
|
29
29
|
* @example
|
|
30
30
|
* ```ts
|
|
31
|
-
* const
|
|
31
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
32
|
+
* const group = fDocument.findColumnGroupByText('Launch');
|
|
33
|
+
* const column = group?.getColumn(0);
|
|
32
34
|
* console.log(column?.getId());
|
|
33
35
|
* ```
|
|
34
36
|
*/
|
|
@@ -38,7 +40,9 @@ export declare class FDocumentColumn {
|
|
|
38
40
|
* @returns {string} The persisted column group id.
|
|
39
41
|
* @example
|
|
40
42
|
* ```ts
|
|
41
|
-
* const
|
|
43
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
44
|
+
* const group = fDocument.findColumnGroupByText('Launch');
|
|
45
|
+
* const column = group?.getColumn(0);
|
|
42
46
|
* console.log(column?.getColumnGroupId());
|
|
43
47
|
* ```
|
|
44
48
|
*/
|
|
@@ -48,7 +52,10 @@ export declare class FDocumentColumn {
|
|
|
48
52
|
* @returns {number} The column index, or `-1` when the column no longer exists.
|
|
49
53
|
* @example
|
|
50
54
|
* ```ts
|
|
51
|
-
* const
|
|
55
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
56
|
+
* const group = fDocument.findColumnGroupByText('Launch');
|
|
57
|
+
* const column = group?.getColumn(0);
|
|
58
|
+
* console.log(column?.getIndex());
|
|
52
59
|
* ```
|
|
53
60
|
*/
|
|
54
61
|
getIndex(): number;
|
|
@@ -58,8 +65,10 @@ export declare class FDocumentColumn {
|
|
|
58
65
|
* @returns {IDocsColumnOffsetRange | null} The column range, or `null` if the column no longer exists.
|
|
59
66
|
* @example
|
|
60
67
|
* ```ts
|
|
61
|
-
* const
|
|
62
|
-
*
|
|
68
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
69
|
+
* const group = fDocument.findColumnGroupByText('Launch');
|
|
70
|
+
* const column = group?.getColumn(0);
|
|
71
|
+
* console.log(column?.getRange());
|
|
63
72
|
* ```
|
|
64
73
|
*/
|
|
65
74
|
getRange(): IDocsColumnOffsetRange | null;
|
|
@@ -72,10 +81,10 @@ export declare class FDocumentColumn {
|
|
|
72
81
|
* @returns {IDocsColumnContentRange | null} The editable range, or `null` if the column no longer exists.
|
|
73
82
|
* @example
|
|
74
83
|
* ```ts
|
|
75
|
-
* const
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
*
|
|
84
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
85
|
+
* const group = fDocument.findColumnGroupByText('Launch');
|
|
86
|
+
* const column = group?.getColumn(0);
|
|
87
|
+
* console.log(column?.getContentRange());
|
|
79
88
|
* ```
|
|
80
89
|
*/
|
|
81
90
|
getContentRange(): IDocsColumnContentRange | null;
|
|
@@ -88,17 +97,18 @@ export declare class FDocumentColumn {
|
|
|
88
97
|
* @returns {number | null} The insertion offset, or `null` if the column no longer exists.
|
|
89
98
|
* @example
|
|
90
99
|
* ```ts
|
|
91
|
-
* import '@univerjs-pro/docs-table/facade';
|
|
92
|
-
*
|
|
93
100
|
* const fDocument = univerAPI.getActiveDocument();
|
|
94
|
-
* const
|
|
101
|
+
* const group = fDocument.findColumnGroupByText('Launch');
|
|
102
|
+
* const thirdColumn = group?.getColumn(2);
|
|
95
103
|
* const offset = thirdColumn?.getInsertOffset();
|
|
96
104
|
*
|
|
97
105
|
* if (offset != null) {
|
|
98
106
|
* fDocument?.insertTableFromData([
|
|
99
107
|
* ['Metric', 'Now', 'Next'],
|
|
100
108
|
* ['Adoption', '68%', '80%'],
|
|
101
|
-
* ], {
|
|
109
|
+
* ], {
|
|
110
|
+
* offset
|
|
111
|
+
* });
|
|
102
112
|
* }
|
|
103
113
|
* ```
|
|
104
114
|
*/
|
|
@@ -109,9 +119,11 @@ export declare class FDocumentColumn {
|
|
|
109
119
|
* @returns {string} The column text, or an empty string if the column no longer exists.
|
|
110
120
|
* @example
|
|
111
121
|
* ```ts
|
|
112
|
-
*
|
|
122
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
123
|
+
* const group = fDocument.findColumnGroupByText('Launch');
|
|
124
|
+
* const column = group?.getColumn(0);
|
|
125
|
+
* console.log(column?.getText());
|
|
113
126
|
* ```
|
|
114
127
|
*/
|
|
115
128
|
getText(): string;
|
|
116
|
-
private _getDocumentData;
|
|
117
129
|
}
|
|
@@ -3,16 +3,13 @@ import { FDocument } from '@univerjs/docs/facade';
|
|
|
3
3
|
import { FDocumentColumnGroup } from './f-document-column-group';
|
|
4
4
|
export interface IFDocumentColumnMixin {
|
|
5
5
|
/**
|
|
6
|
-
* Returns all column groups in document
|
|
6
|
+
* Returns all column groups in this document.
|
|
7
7
|
* @returns {FDocumentColumnGroup[]} Column group wrappers, or an empty array when the document has no column groups.
|
|
8
8
|
* @example
|
|
9
9
|
* ```ts
|
|
10
|
-
* import '@univerjs/docs/facade';
|
|
11
|
-
* import '@univerjs-pro/docs-column/facade';
|
|
12
|
-
*
|
|
13
10
|
* const fDocument = univerAPI.getActiveDocument();
|
|
14
|
-
* const groups = fDocument
|
|
15
|
-
* console.log(groups
|
|
11
|
+
* const groups = fDocument.getColumnGroups();
|
|
12
|
+
* console.log(groups.map((group) => group.describe()));
|
|
16
13
|
* ```
|
|
17
14
|
*/
|
|
18
15
|
getColumnGroups(): FDocumentColumnGroup[];
|
|
@@ -22,8 +19,9 @@ export interface IFDocumentColumnMixin {
|
|
|
22
19
|
* @returns {FDocumentColumnGroup | null} The column group wrapper, or `null` if no group has the id.
|
|
23
20
|
* @example
|
|
24
21
|
* ```ts
|
|
25
|
-
* const
|
|
26
|
-
*
|
|
22
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
23
|
+
* const group = fDocument.getColumnGroup('column-group-1');
|
|
24
|
+
* console.log(group?.describe());
|
|
27
25
|
* ```
|
|
28
26
|
*/
|
|
29
27
|
getColumnGroup(columnGroupId: string): FDocumentColumnGroup | null;
|
|
@@ -33,10 +31,24 @@ export interface IFDocumentColumnMixin {
|
|
|
33
31
|
* @returns {FDocumentColumnGroup | null} The containing column group, or `null` when the offset is outside all groups.
|
|
34
32
|
* @example
|
|
35
33
|
* ```ts
|
|
36
|
-
* const
|
|
34
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
35
|
+
* const group = fDocument.getColumnGroupAt(128);
|
|
36
|
+
* console.log(group?.describe());
|
|
37
37
|
* ```
|
|
38
38
|
*/
|
|
39
39
|
getColumnGroupAt(offset: number): FDocumentColumnGroup | null;
|
|
40
|
+
/**
|
|
41
|
+
* Finds the first column group that contains a column with matching text.
|
|
42
|
+
* @param {string} text Plain text to search inside columns.
|
|
43
|
+
* @returns {FDocumentColumnGroup | null} The first matching column group, or `null` when no group contains the text.
|
|
44
|
+
* @example
|
|
45
|
+
* ```ts
|
|
46
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
47
|
+
* const group = fDocument.findColumnGroupByText('Launch');
|
|
48
|
+
* console.log(group?.describe());
|
|
49
|
+
* ```
|
|
50
|
+
*/
|
|
51
|
+
findColumnGroupByText(text: string): FDocumentColumnGroup | null;
|
|
40
52
|
/**
|
|
41
53
|
* Finds column groups by text or by id.
|
|
42
54
|
* @param {string | IDocsColumnFindQuery} query Plain text to search inside columns, or a structured query.
|
|
@@ -44,9 +56,9 @@ export interface IFDocumentColumnMixin {
|
|
|
44
56
|
* @example
|
|
45
57
|
* ```ts
|
|
46
58
|
* const fDocument = univerAPI.getActiveDocument();
|
|
47
|
-
* const
|
|
48
|
-
* const
|
|
49
|
-
* console.log(
|
|
59
|
+
* const groupsWithText = fDocument.findColumnGroups('Launch');
|
|
60
|
+
* const groupsWithId = fDocument.findColumnGroups({ columnGroupId: 'column-group-1' });
|
|
61
|
+
* console.log(groupsWithText, groupsWithId);
|
|
50
62
|
* ```
|
|
51
63
|
*/
|
|
52
64
|
findColumnGroups(query: string | IDocsColumnFindQuery): FDocumentColumnGroup[];
|
|
@@ -62,12 +74,7 @@ export interface IFDocumentColumnMixin {
|
|
|
62
74
|
* @returns {FDocumentColumnGroup | null} The inserted column group wrapper, or `null` if insertion failed or the document is not modern.
|
|
63
75
|
* @example
|
|
64
76
|
* ```ts
|
|
65
|
-
* import '@univerjs/docs/facade';
|
|
66
|
-
* import '@univerjs-pro/docs-column/facade';
|
|
67
|
-
* import '@univerjs-pro/docs-table/facade';
|
|
68
|
-
*
|
|
69
77
|
* const fDocument = univerAPI.getActiveDocument();
|
|
70
|
-
* if (!fDocument) throw new Error('No active document');
|
|
71
78
|
*
|
|
72
79
|
* const group = fDocument.insertColumnGroup(3, {
|
|
73
80
|
* gap: 18,
|
|
@@ -78,18 +85,12 @@ export interface IFDocumentColumnMixin {
|
|
|
78
85
|
*
|
|
79
86
|
* const leftOffset = left?.getInsertOffset();
|
|
80
87
|
* if (leftOffset != null) {
|
|
81
|
-
* fDocument.insertText('Editorial brief\rUse columns for compact narrative layout.'
|
|
82
|
-
* startOffset: leftOffset,
|
|
83
|
-
* endOffset: leftOffset,
|
|
84
|
-
* });
|
|
88
|
+
* fDocument.insertText(leftOffset, 'Editorial brief\rUse columns for compact narrative layout.');
|
|
85
89
|
* }
|
|
86
90
|
*
|
|
87
91
|
* const middleOffset = middle?.getInsertOffset();
|
|
88
92
|
* if (middleOffset != null) {
|
|
89
|
-
* fDocument.insertText('Production checklist\rDrag content into this column.'
|
|
90
|
-
* startOffset: middleOffset,
|
|
91
|
-
* endOffset: middleOffset,
|
|
92
|
-
* });
|
|
93
|
+
* fDocument.insertText(middleOffset, 'Production checklist\rDrag content into this column.');
|
|
93
94
|
* }
|
|
94
95
|
*
|
|
95
96
|
* const rightOffset = right?.getInsertOffset();
|
|
@@ -98,32 +99,24 @@ export interface IFDocumentColumnMixin {
|
|
|
98
99
|
* ['Metric', 'Now', 'Next'],
|
|
99
100
|
* ['Adoption', '68%', '80%'],
|
|
100
101
|
* ['Quality', 'A-', 'A'],
|
|
101
|
-
* ], {
|
|
102
|
+
* ], {
|
|
103
|
+
* offset: rightOffset,
|
|
104
|
+
* headerRowCount: 1
|
|
105
|
+
* });
|
|
102
106
|
* }
|
|
103
107
|
*
|
|
104
108
|
* console.log(group?.describe());
|
|
105
109
|
* ```
|
|
106
110
|
*/
|
|
107
111
|
insertColumnGroup(columnCount: number, options?: IDocsColumnInsertFacadeOptions): FDocumentColumnGroup | null;
|
|
108
|
-
/**
|
|
109
|
-
* Deletes a column group by id.
|
|
110
|
-
* @param {string} columnGroupId The column group id.
|
|
111
|
-
* @returns {boolean} `true` if the group was deleted.
|
|
112
|
-
* @example
|
|
113
|
-
* ```ts
|
|
114
|
-
* const success = univerAPI.getActiveDocument()?.deleteColumnGroup('column-group-1');
|
|
115
|
-
* console.log(success);
|
|
116
|
-
* ```
|
|
117
|
-
*/
|
|
118
|
-
deleteColumnGroup(columnGroupId: string): boolean;
|
|
119
112
|
}
|
|
120
113
|
export declare class FDocumentColumnMixin extends FDocument implements IFDocumentColumnMixin {
|
|
121
114
|
getColumnGroups(): FDocumentColumnGroup[];
|
|
122
115
|
getColumnGroup(columnGroupId: string): FDocumentColumnGroup | null;
|
|
123
116
|
getColumnGroupAt(offset: number): FDocumentColumnGroup | null;
|
|
117
|
+
findColumnGroupByText(text: string): FDocumentColumnGroup | null;
|
|
124
118
|
findColumnGroups(query: string | IDocsColumnFindQuery): FDocumentColumnGroup[];
|
|
125
119
|
insertColumnGroup(columnCount: number, options?: IDocsColumnInsertFacadeOptions): FDocumentColumnGroup | null;
|
|
126
|
-
deleteColumnGroup(columnGroupId: string): boolean;
|
|
127
120
|
private _getColumnGroups;
|
|
128
121
|
private _createFDocumentColumnGroup;
|
|
129
122
|
}
|
|
@@ -1,31 +1,32 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ColumnPosition } from '@univerjs-pro/docs-column';
|
|
2
2
|
import { FEnum } from '@univerjs/core/facade';
|
|
3
3
|
/**
|
|
4
4
|
* @ignore
|
|
5
5
|
*/
|
|
6
6
|
export interface IFDocumentColumnEnumMixin {
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
9
|
-
*
|
|
8
|
+
* Docs column position enum.
|
|
10
9
|
* @example
|
|
11
10
|
* ```ts
|
|
12
|
-
* const
|
|
13
|
-
*
|
|
14
|
-
|
|
15
|
-
ColumnLayoutType: typeof ColumnLayoutType;
|
|
16
|
-
/**
|
|
17
|
-
* Represents docs column responsive behavior.
|
|
11
|
+
* const fDocument = univerAPI.getActiveDocument();
|
|
12
|
+
* const group = fDocument.findColumnGroupByText('Launch');
|
|
13
|
+
* const columns = group.getColumns();
|
|
18
14
|
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
15
|
+
* if (columns.length > 0) {
|
|
16
|
+
* const rightColumn = group.getColumn(columns.length - 1);
|
|
17
|
+
* const inserted = group.addColumn(
|
|
18
|
+
* rightColumn.getId(),
|
|
19
|
+
* univerAPI.Enum.DocsColumnPositionEnum.LEFT,
|
|
20
|
+
* 'new-column'
|
|
21
|
+
* );
|
|
22
|
+
* console.log(inserted?.getInsertOffset());
|
|
23
|
+
* }
|
|
22
24
|
* ```
|
|
23
25
|
*/
|
|
24
|
-
|
|
26
|
+
DocsColumnPositionEnum: typeof ColumnPosition;
|
|
25
27
|
}
|
|
26
28
|
export declare class FDocumentColumnEnumMixin extends FEnum implements IFDocumentColumnEnumMixin {
|
|
27
|
-
get
|
|
28
|
-
get ColumnResponsiveType(): typeof ColumnResponsiveType;
|
|
29
|
+
get DocsColumnPositionEnum(): typeof ColumnPosition;
|
|
29
30
|
}
|
|
30
31
|
declare module '@univerjs/core/facade' {
|
|
31
32
|
interface FEnum extends IFDocumentColumnEnumMixin {
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { ICustomColumnGroup } from '@univerjs-pro/docs-column';
|
|
2
|
+
import type { ColumnLayoutType, ColumnResponsiveType } from '@univerjs/core';
|
|
2
3
|
export interface IDocsColumnFindQuery {
|
|
3
4
|
/** Matches a specific column group id stored in `documentData.body.columnGroups`. */
|
|
4
5
|
columnGroupId?: string;
|
package/lib/types/index.d.ts
CHANGED
|
@@ -1,28 +1,31 @@
|
|
|
1
1
|
import './types/core-augment';
|
|
2
|
-
export { AddDocColumnCommand, DeleteDocColumnCommand, DeleteDocColumnGroupCommand, NormalizeDocColumnGroupCommand, ResizeDocColumnGroupCommand } from './commands/column-structure.command';
|
|
3
|
-
export type { IAddDocColumnCommandParams, IDeleteDocColumnCommandParams, IDeleteDocColumnGroupCommandParams, INormalizeDocColumnGroupCommandParams, IResizeDocColumnGroupCommandParams } from './commands/column-structure.command';
|
|
4
|
-
export { canResolveDocsColumnInsertOffset, InsertDocColumnGroupCommand, normalizeDocsColumnInsertOffset } from './commands/insert-doc-column-group.command';
|
|
2
|
+
export { AddDocColumnCommand, DeleteDocColumnCommand, DeleteDocColumnGroupCommand, NormalizeDocColumnGroupCommand, ResizeDocColumnGroupCommand, } from './commands/column-structure.command';
|
|
3
|
+
export type { IAddDocColumnCommandParams, IDeleteDocColumnCommandParams, IDeleteDocColumnGroupCommandParams, INormalizeDocColumnGroupCommandParams, IResizeDocColumnGroupCommandParams, } from './commands/column-structure.command';
|
|
4
|
+
export { canResolveDocsColumnInsertOffset, InsertDocColumnGroupCommand, normalizeDocsColumnInsertOffset, } from './commands/insert-doc-column-group.command';
|
|
5
5
|
export type { IInsertDocColumnGroupCommandParams } from './commands/insert-doc-column-group.command';
|
|
6
6
|
export { DOCS_COLUMN_MAX_COLUMN_COUNT } from './common/column-constraints';
|
|
7
7
|
export { calculateColumnLayout } from './common/column-layout';
|
|
8
|
-
export type { IDocsColumnLayoutColumn, IDocsColumnLayoutOptions, IDocsColumnLayoutResult } from './common/column-layout';
|
|
9
|
-
export { buildDeleteColumnActions, buildDeleteColumnGroupActions, buildInsertColumnActions, buildResizeColumnGroupActions } from './common/column-operations';
|
|
10
|
-
export type { IDocsColumnDeleteColumnOptions, IDocsColumnDeleteColumnResult, IDocsColumnDeleteGroupOptions, IDocsColumnDeleteGroupResult, IDocsColumnInsertColumnOptions, IDocsColumnInsertColumnResult, IDocsColumnResizeOptions, IDocsColumnResizeResult } from './common/column-operations';
|
|
8
|
+
export type { IDocsColumnLayoutColumn, IDocsColumnLayoutOptions, IDocsColumnLayoutResult, } from './common/column-layout';
|
|
9
|
+
export { buildDeleteColumnActions, buildDeleteColumnGroupActions, buildInsertColumnActions, buildResizeColumnGroupActions, } from './common/column-operations';
|
|
10
|
+
export type { IDocsColumnDeleteColumnOptions, IDocsColumnDeleteColumnResult, IDocsColumnDeleteGroupOptions, IDocsColumnDeleteGroupResult, IDocsColumnInsertColumnOptions, IDocsColumnInsertColumnResult, IDocsColumnResizeOptions, IDocsColumnResizeResult, } from './common/column-operations';
|
|
11
11
|
export { getColumnGroupRangeById, getColumnRange as getDocsColumnRange } from './common/column-range';
|
|
12
12
|
export type { IDocsColumnGroupOffsetRange, IDocsColumnOffsetRange } from './common/column-range';
|
|
13
13
|
export { calculateResizeDragWidthRatios } from './common/column-resize-drag';
|
|
14
14
|
export type { IDocsColumnResizeDragOptions } from './common/column-resize-drag';
|
|
15
|
-
export { ColumnDataStreamTreeTokenType,
|
|
15
|
+
export { ColumnDataStreamTreeTokenType, ColumnPosition } from './common/column-types';
|
|
16
16
|
export type { IColumn, IColumnGroup, ICustomColumnGroup } from './common/column-types';
|
|
17
17
|
export { documentSkeletonLineIterator, documentSkeletonTableIterator } from './common/document-skeleton-iterators';
|
|
18
|
-
export type { IDocumentSkeletonLineContext, IDocumentSkeletonLineIteratorOptions, IDocumentSkeletonTableCellGeometry, IDocumentSkeletonTableContext, IDocumentSkeletonTableIteratorOptions } from './common/document-skeleton-iterators';
|
|
18
|
+
export type { IDocumentSkeletonLineContext, IDocumentSkeletonLineIteratorOptions, IDocumentSkeletonTableCellGeometry, IDocumentSkeletonTableContext, IDocumentSkeletonTableIteratorOptions, } from './common/document-skeleton-iterators';
|
|
19
19
|
export { downgradeColumnGroupsToTables } from './common/downgrade-to-table';
|
|
20
20
|
export type { IDocsColumnDowngradeOptions, IDocsColumnDowngradeResult } from './common/downgrade-to-table';
|
|
21
|
-
export { canMoveRangeToColumnContent, isColumnStructuralOffset, isOffsetInsideColumnContent } from './common/drop-target';
|
|
21
|
+
export { canMoveRangeToColumnContent, isColumnStructuralOffset, isOffsetInsideColumnContent, } from './common/drop-target';
|
|
22
22
|
export type { IDocsColumnMoveRange } from './common/drop-target';
|
|
23
23
|
export { normalizeEmptyColumnsAfterMove } from './common/empty-column-after-move';
|
|
24
|
-
export type { IDocsColumnMoveRange as IDocsColumnEmptyColumnMoveRange, IDocsColumnNormalizeEmptyColumnsOptions, IDocsColumnNormalizeEmptyColumnsResult } from './common/empty-column-after-move';
|
|
24
|
+
export type { IDocsColumnMoveRange as IDocsColumnEmptyColumnMoveRange, IDocsColumnNormalizeEmptyColumnsOptions, IDocsColumnNormalizeEmptyColumnsResult, } from './common/empty-column-after-move';
|
|
25
25
|
export { buildInsertColumnGroupActions, canInsertColumnGroup } from './common/insert-column-group';
|
|
26
26
|
export type { IDocsColumnInsertOptions, IDocsColumnInsertResult } from './common/insert-column-group';
|
|
27
27
|
export { normalizeColumnGroups } from './common/normalize-column-groups';
|
|
28
28
|
export type { IDocsColumnNormalizeResult } from './common/normalize-column-groups';
|
|
29
|
+
export { DOCS_COLUMN_PLUGIN_CONFIG_KEY } from './config/config';
|
|
30
|
+
export type { IUniverDocsColumnConfig } from './config/config';
|
|
31
|
+
export { DOCS_COLUMN_PLUGIN, UniverDocsColumnPlugin } from './plugin';
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { IUniverDocsColumnConfig } from './config/config';
|
|
2
|
+
import { ICommandService, IConfigService, Injector, Plugin, UniverInstanceType } from '@univerjs/core';
|
|
3
|
+
export declare const DOCS_COLUMN_PLUGIN = "DOCS_COLUMN_PLUGIN";
|
|
4
|
+
export declare class UniverDocsColumnPlugin extends Plugin {
|
|
5
|
+
private readonly _config;
|
|
6
|
+
readonly _injector: Injector;
|
|
7
|
+
private readonly _configService;
|
|
8
|
+
private readonly _commandService;
|
|
9
|
+
static pluginName: string;
|
|
10
|
+
static packageName: string;
|
|
11
|
+
static version: string;
|
|
12
|
+
static type: UniverInstanceType;
|
|
13
|
+
constructor(_config: Partial<IUniverDocsColumnConfig> | undefined, _injector: Injector, _configService: IConfigService, _commandService: ICommandService);
|
|
14
|
+
onStarting(): void;
|
|
15
|
+
}
|