@univerjs/sheets-filter 0.6.4 → 0.6.5

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/lib/es/facade.js CHANGED
@@ -18,7 +18,9 @@ let s = class {
18
18
  * ```typescript
19
19
  * const fWorkbook = univerAPI.getActiveWorkbook();
20
20
  * const fWorksheet = fWorkbook.getActiveSheet();
21
- * const fRange = fWorksheet.getRange('A1:D10');
21
+ *
22
+ * // Set some values of the range C1:F10
23
+ * const fRange = fWorksheet.getRange('C1:F10');
22
24
  * fRange.setValues([
23
25
  * [1, 2, 3, 4],
24
26
  * [2, 3, 4, 5],
@@ -32,7 +34,7 @@ let s = class {
32
34
  * [10, 11, 12, 13],
33
35
  * ]);
34
36
  *
35
- * // Create a filter on the range
37
+ * // Create a filter on the range C1:F10
36
38
  * let fFilter = fRange.createFilter();
37
39
  *
38
40
  * // If the filter already exists, remove it and create a new one
@@ -41,15 +43,17 @@ let s = class {
41
43
  * fFilter = fRange.createFilter();
42
44
  * }
43
45
  *
44
- * // Set the filter criteria of the column A
45
- * fFilter?.setColumnFilterCriteria(0, {
46
+ * // Set the filter criteria of the column C, filter out the rows that are not 1, 5, 9
47
+ * const column = fWorksheet.getRange('C:C').getColumn();
48
+ * fFilter.setColumnFilterCriteria(column, {
46
49
  * colId: 0,
47
50
  * filters: {
48
51
  * filters: ['1', '5', '9'],
49
52
  * },
50
53
  * });
51
54
  *
52
- * console.log(fFilter?.getFilteredOutRows()); // [1, 2, 3, 5, 6, 7, 9]
55
+ * // Get the filtered out rows
56
+ * console.log(fFilter.getFilteredOutRows()); // [1, 2, 3, 5, 6, 7, 9]
53
57
  * ```
54
58
  */
55
59
  getFilteredOutRows() {
@@ -63,7 +67,9 @@ let s = class {
63
67
  * ```typescript
64
68
  * const fWorkbook = univerAPI.getActiveWorkbook();
65
69
  * const fWorksheet = fWorkbook.getActiveSheet();
66
- * const fRange = fWorksheet.getRange('A1:D10');
70
+ *
71
+ * // Set some values of the range C1:F10
72
+ * const fRange = fWorksheet.getRange('C1:F10');
67
73
  * fRange.setValues([
68
74
  * [1, 2, 3, 4],
69
75
  * [2, 3, 4, 5],
@@ -77,7 +83,7 @@ let s = class {
77
83
  * [10, 11, 12, 13],
78
84
  * ]);
79
85
  *
80
- * // Create a filter on the range
86
+ * // Create a filter on the range C1:F10
81
87
  * let fFilter = fRange.createFilter();
82
88
  *
83
89
  * // If the filter already exists, remove it and create a new one
@@ -86,16 +92,18 @@ let s = class {
86
92
  * fFilter = fRange.createFilter();
87
93
  * }
88
94
  *
89
- * // Set the filter criteria of the column A
90
- * fFilter?.setColumnFilterCriteria(0, {
95
+ * // Set the filter criteria of the column C, filter out the rows that are not 1, 5, 9
96
+ * const column = fWorksheet.getRange('C:C').getColumn();
97
+ * fFilter.setColumnFilterCriteria(column, {
91
98
  * colId: 0,
92
99
  * filters: {
93
100
  * filters: ['1', '5', '9'],
94
101
  * },
95
102
  * });
96
103
  *
97
- * console.log(fFilter?.getColumnFilterCriteria(0)); // { colId: 0, filters: { filters: ['1', '5', '9'] } }
98
- * console.log(fFilter?.getColumnFilterCriteria(1)); // undefined
104
+ * // Print the filter criteria of the column C and D
105
+ * console.log(fFilter.getColumnFilterCriteria(column)); // { colId: 0, filters: { filters: ['1', '5', '9'] } }
106
+ * console.log(fFilter.getColumnFilterCriteria(column + 1)); // undefined
99
107
  * ```
100
108
  */
101
109
  getColumnFilterCriteria(i) {
@@ -110,7 +118,9 @@ let s = class {
110
118
  * ```typescript
111
119
  * const fWorkbook = univerAPI.getActiveWorkbook();
112
120
  * const fWorksheet = fWorkbook.getActiveSheet();
113
- * const fRange = fWorksheet.getRange('A1:D10');
121
+ *
122
+ * // Set some values of the range C1:F10
123
+ * const fRange = fWorksheet.getRange('C1:F10');
114
124
  * fRange.setValues([
115
125
  * [1, 2, 3, 4],
116
126
  * [2, 3, 4, 5],
@@ -124,7 +134,7 @@ let s = class {
124
134
  * [10, 11, 12, 13],
125
135
  * ]);
126
136
  *
127
- * // Create a filter on the range
137
+ * // Create a filter on the range C1:F10
128
138
  * let fFilter = fRange.createFilter();
129
139
  *
130
140
  * // If the filter already exists, remove it and create a new one
@@ -133,17 +143,18 @@ let s = class {
133
143
  * fFilter = fRange.createFilter();
134
144
  * }
135
145
  *
136
- * // Set the filter criteria of the column A
137
- * fFilter?.setColumnFilterCriteria(0, {
146
+ * // Set the filter criteria of the column C, filter out the rows that are not 1, 5, 9
147
+ * const column = fWorksheet.getRange('C:C').getColumn();
148
+ * fFilter.setColumnFilterCriteria(column, {
138
149
  * colId: 0,
139
150
  * filters: {
140
151
  * filters: ['1', '5', '9'],
141
152
  * },
142
153
  * });
143
154
  *
144
- * // Clear the filter criteria of the column A after 3 seconds
155
+ * // Clear the filter criteria of the column C after 3 seconds
145
156
  * setTimeout(() => {
146
- * fFilter?.removeColumnFilterCriteria(0);
157
+ * fFilter.removeColumnFilterCriteria(column);
147
158
  * }, 3000);
148
159
  * ```
149
160
  */
@@ -164,7 +175,9 @@ let s = class {
164
175
  * ```typescript
165
176
  * const fWorkbook = univerAPI.getActiveWorkbook();
166
177
  * const fWorksheet = fWorkbook.getActiveSheet();
167
- * const fRange = fWorksheet.getRange('A1:D10');
178
+ *
179
+ * // Set some values of the range C1:F10
180
+ * const fRange = fWorksheet.getRange('C1:F10');
168
181
  * fRange.setValues([
169
182
  * [1, 2, 3, 4],
170
183
  * [2, 3, 4, 5],
@@ -178,7 +191,7 @@ let s = class {
178
191
  * [10, 11, 12, 13],
179
192
  * ]);
180
193
  *
181
- * // Create a filter on the range
194
+ * // Create a filter on the range C1:F10
182
195
  * let fFilter = fRange.createFilter();
183
196
  *
184
197
  * // If the filter already exists, remove it and create a new one
@@ -187,8 +200,9 @@ let s = class {
187
200
  * fFilter = fRange.createFilter();
188
201
  * }
189
202
  *
190
- * // Set the filter criteria of the column A
191
- * fFilter?.setColumnFilterCriteria(0, {
203
+ * // Set the filter criteria of the column C, filter out the rows that are not 1, 5, 9
204
+ * const column = fWorksheet.getRange('C:C').getColumn();
205
+ * fFilter.setColumnFilterCriteria(column, {
192
206
  * colId: 0,
193
207
  * filters: {
194
208
  * filters: ['1', '5', '9'],
@@ -226,7 +240,9 @@ let s = class {
226
240
  * ```typescript
227
241
  * const fWorkbook = univerAPI.getActiveWorkbook();
228
242
  * const fWorksheet = fWorkbook.getActiveSheet();
229
- * const fRange = fWorksheet.getRange('A1:D10');
243
+ *
244
+ * // Set some values of the range C1:F10
245
+ * const fRange = fWorksheet.getRange('C1:F10');
230
246
  * fRange.setValues([
231
247
  * [1, 2, 3, 4],
232
248
  * [2, 3, 4, 5],
@@ -240,7 +256,7 @@ let s = class {
240
256
  * [10, 11, 12, 13],
241
257
  * ]);
242
258
  *
243
- * // Create a filter on the range
259
+ * // Create a filter on the range C1:F10
244
260
  * let fFilter = fRange.createFilter();
245
261
  *
246
262
  * // If the filter already exists, remove it and create a new one
@@ -249,8 +265,9 @@ let s = class {
249
265
  * fFilter = fRange.createFilter();
250
266
  * }
251
267
  *
252
- * // Set the filter criteria of the column A
253
- * fFilter?.setColumnFilterCriteria(0, {
268
+ * // Set the filter criteria of the column C, filter out the rows that are not 1, 5, 9
269
+ * const column = fWorksheet.getRange('C:C').getColumn();
270
+ * fFilter.setColumnFilterCriteria(column, {
254
271
  * colId: 0,
255
272
  * filters: {
256
273
  * filters: ['1', '5', '9'],
@@ -259,7 +276,7 @@ let s = class {
259
276
  *
260
277
  * // Clear the filter criteria of all columns after 3 seconds
261
278
  * setTimeout(() => {
262
- * fFilter?.removeFilterCriteria();
279
+ * fFilter.removeFilterCriteria();
263
280
  * }, 3000);
264
281
  * ```
265
282
  */
@@ -19,7 +19,9 @@ export declare class FFilter {
19
19
  * ```typescript
20
20
  * const fWorkbook = univerAPI.getActiveWorkbook();
21
21
  * const fWorksheet = fWorkbook.getActiveSheet();
22
- * const fRange = fWorksheet.getRange('A1:D10');
22
+ *
23
+ * // Set some values of the range C1:F10
24
+ * const fRange = fWorksheet.getRange('C1:F10');
23
25
  * fRange.setValues([
24
26
  * [1, 2, 3, 4],
25
27
  * [2, 3, 4, 5],
@@ -33,7 +35,7 @@ export declare class FFilter {
33
35
  * [10, 11, 12, 13],
34
36
  * ]);
35
37
  *
36
- * // Create a filter on the range
38
+ * // Create a filter on the range C1:F10
37
39
  * let fFilter = fRange.createFilter();
38
40
  *
39
41
  * // If the filter already exists, remove it and create a new one
@@ -42,15 +44,17 @@ export declare class FFilter {
42
44
  * fFilter = fRange.createFilter();
43
45
  * }
44
46
  *
45
- * // Set the filter criteria of the column A
46
- * fFilter?.setColumnFilterCriteria(0, {
47
+ * // Set the filter criteria of the column C, filter out the rows that are not 1, 5, 9
48
+ * const column = fWorksheet.getRange('C:C').getColumn();
49
+ * fFilter.setColumnFilterCriteria(column, {
47
50
  * colId: 0,
48
51
  * filters: {
49
52
  * filters: ['1', '5', '9'],
50
53
  * },
51
54
  * });
52
55
  *
53
- * console.log(fFilter?.getFilteredOutRows()); // [1, 2, 3, 5, 6, 7, 9]
56
+ * // Get the filtered out rows
57
+ * console.log(fFilter.getFilteredOutRows()); // [1, 2, 3, 5, 6, 7, 9]
54
58
  * ```
55
59
  */
56
60
  getFilteredOutRows(): number[];
@@ -62,7 +66,9 @@ export declare class FFilter {
62
66
  * ```typescript
63
67
  * const fWorkbook = univerAPI.getActiveWorkbook();
64
68
  * const fWorksheet = fWorkbook.getActiveSheet();
65
- * const fRange = fWorksheet.getRange('A1:D10');
69
+ *
70
+ * // Set some values of the range C1:F10
71
+ * const fRange = fWorksheet.getRange('C1:F10');
66
72
  * fRange.setValues([
67
73
  * [1, 2, 3, 4],
68
74
  * [2, 3, 4, 5],
@@ -76,7 +82,7 @@ export declare class FFilter {
76
82
  * [10, 11, 12, 13],
77
83
  * ]);
78
84
  *
79
- * // Create a filter on the range
85
+ * // Create a filter on the range C1:F10
80
86
  * let fFilter = fRange.createFilter();
81
87
  *
82
88
  * // If the filter already exists, remove it and create a new one
@@ -85,16 +91,18 @@ export declare class FFilter {
85
91
  * fFilter = fRange.createFilter();
86
92
  * }
87
93
  *
88
- * // Set the filter criteria of the column A
89
- * fFilter?.setColumnFilterCriteria(0, {
94
+ * // Set the filter criteria of the column C, filter out the rows that are not 1, 5, 9
95
+ * const column = fWorksheet.getRange('C:C').getColumn();
96
+ * fFilter.setColumnFilterCriteria(column, {
90
97
  * colId: 0,
91
98
  * filters: {
92
99
  * filters: ['1', '5', '9'],
93
100
  * },
94
101
  * });
95
102
  *
96
- * console.log(fFilter?.getColumnFilterCriteria(0)); // { colId: 0, filters: { filters: ['1', '5', '9'] } }
97
- * console.log(fFilter?.getColumnFilterCriteria(1)); // undefined
103
+ * // Print the filter criteria of the column C and D
104
+ * console.log(fFilter.getColumnFilterCriteria(column)); // { colId: 0, filters: { filters: ['1', '5', '9'] } }
105
+ * console.log(fFilter.getColumnFilterCriteria(column + 1)); // undefined
98
106
  * ```
99
107
  */
100
108
  getColumnFilterCriteria(column: number): Nullable<IFilterColumn>;
@@ -106,7 +114,9 @@ export declare class FFilter {
106
114
  * ```typescript
107
115
  * const fWorkbook = univerAPI.getActiveWorkbook();
108
116
  * const fWorksheet = fWorkbook.getActiveSheet();
109
- * const fRange = fWorksheet.getRange('A1:D10');
117
+ *
118
+ * // Set some values of the range C1:F10
119
+ * const fRange = fWorksheet.getRange('C1:F10');
110
120
  * fRange.setValues([
111
121
  * [1, 2, 3, 4],
112
122
  * [2, 3, 4, 5],
@@ -120,7 +130,7 @@ export declare class FFilter {
120
130
  * [10, 11, 12, 13],
121
131
  * ]);
122
132
  *
123
- * // Create a filter on the range
133
+ * // Create a filter on the range C1:F10
124
134
  * let fFilter = fRange.createFilter();
125
135
  *
126
136
  * // If the filter already exists, remove it and create a new one
@@ -129,17 +139,18 @@ export declare class FFilter {
129
139
  * fFilter = fRange.createFilter();
130
140
  * }
131
141
  *
132
- * // Set the filter criteria of the column A
133
- * fFilter?.setColumnFilterCriteria(0, {
142
+ * // Set the filter criteria of the column C, filter out the rows that are not 1, 5, 9
143
+ * const column = fWorksheet.getRange('C:C').getColumn();
144
+ * fFilter.setColumnFilterCriteria(column, {
134
145
  * colId: 0,
135
146
  * filters: {
136
147
  * filters: ['1', '5', '9'],
137
148
  * },
138
149
  * });
139
150
  *
140
- * // Clear the filter criteria of the column A after 3 seconds
151
+ * // Clear the filter criteria of the column C after 3 seconds
141
152
  * setTimeout(() => {
142
- * fFilter?.removeColumnFilterCriteria(0);
153
+ * fFilter.removeColumnFilterCriteria(column);
143
154
  * }, 3000);
144
155
  * ```
145
156
  */
@@ -153,7 +164,9 @@ export declare class FFilter {
153
164
  * ```typescript
154
165
  * const fWorkbook = univerAPI.getActiveWorkbook();
155
166
  * const fWorksheet = fWorkbook.getActiveSheet();
156
- * const fRange = fWorksheet.getRange('A1:D10');
167
+ *
168
+ * // Set some values of the range C1:F10
169
+ * const fRange = fWorksheet.getRange('C1:F10');
157
170
  * fRange.setValues([
158
171
  * [1, 2, 3, 4],
159
172
  * [2, 3, 4, 5],
@@ -167,7 +180,7 @@ export declare class FFilter {
167
180
  * [10, 11, 12, 13],
168
181
  * ]);
169
182
  *
170
- * // Create a filter on the range
183
+ * // Create a filter on the range C1:F10
171
184
  * let fFilter = fRange.createFilter();
172
185
  *
173
186
  * // If the filter already exists, remove it and create a new one
@@ -176,8 +189,9 @@ export declare class FFilter {
176
189
  * fFilter = fRange.createFilter();
177
190
  * }
178
191
  *
179
- * // Set the filter criteria of the column A
180
- * fFilter?.setColumnFilterCriteria(0, {
192
+ * // Set the filter criteria of the column C, filter out the rows that are not 1, 5, 9
193
+ * const column = fWorksheet.getRange('C:C').getColumn();
194
+ * fFilter.setColumnFilterCriteria(column, {
181
195
  * colId: 0,
182
196
  * filters: {
183
197
  * filters: ['1', '5', '9'],
@@ -205,7 +219,9 @@ export declare class FFilter {
205
219
  * ```typescript
206
220
  * const fWorkbook = univerAPI.getActiveWorkbook();
207
221
  * const fWorksheet = fWorkbook.getActiveSheet();
208
- * const fRange = fWorksheet.getRange('A1:D10');
222
+ *
223
+ * // Set some values of the range C1:F10
224
+ * const fRange = fWorksheet.getRange('C1:F10');
209
225
  * fRange.setValues([
210
226
  * [1, 2, 3, 4],
211
227
  * [2, 3, 4, 5],
@@ -219,7 +235,7 @@ export declare class FFilter {
219
235
  * [10, 11, 12, 13],
220
236
  * ]);
221
237
  *
222
- * // Create a filter on the range
238
+ * // Create a filter on the range C1:F10
223
239
  * let fFilter = fRange.createFilter();
224
240
  *
225
241
  * // If the filter already exists, remove it and create a new one
@@ -228,8 +244,9 @@ export declare class FFilter {
228
244
  * fFilter = fRange.createFilter();
229
245
  * }
230
246
  *
231
- * // Set the filter criteria of the column A
232
- * fFilter?.setColumnFilterCriteria(0, {
247
+ * // Set the filter criteria of the column C, filter out the rows that are not 1, 5, 9
248
+ * const column = fWorksheet.getRange('C:C').getColumn();
249
+ * fFilter.setColumnFilterCriteria(column, {
233
250
  * colId: 0,
234
251
  * filters: {
235
252
  * filters: ['1', '5', '9'],
@@ -238,7 +255,7 @@ export declare class FFilter {
238
255
  *
239
256
  * // Clear the filter criteria of all columns after 3 seconds
240
257
  * setTimeout(() => {
241
- * fFilter?.removeFilterCriteria();
258
+ * fFilter.removeFilterCriteria();
242
259
  * }, 3000);
243
260
  * ```
244
261
  */
@@ -19,7 +19,7 @@ export interface IFRangeFilter {
19
19
  * fWorksheet.getFilter().remove();
20
20
  * fFilter = fRange.createFilter();
21
21
  * }
22
- * console.log(fFilter);
22
+ * console.log(fFilter, fFilter.getRange().getA1Notation());
23
23
  * ```
24
24
  */
25
25
  createFilter(this: FRange): FFilter | null;
@@ -38,7 +38,7 @@ export interface IFRangeFilter {
38
38
  * if (!fFilter) {
39
39
  * fFilter = fRange.createFilter();
40
40
  * }
41
- * console.log(fFilter);
41
+ * console.log(fFilter, fFilter.getRange().getA1Notation());
42
42
  * ```
43
43
  */
44
44
  getFilter(): FFilter | null;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@univerjs/sheets-filter",
3
- "version": "0.6.4",
3
+ "version": "0.6.5",
4
4
  "private": false,
5
5
  "description": "A library for filtering data in Univer Sheet",
6
6
  "author": "DreamNum <developer@univer.ai>",
@@ -51,16 +51,16 @@
51
51
  "rxjs": ">=7.0.0"
52
52
  },
53
53
  "dependencies": {
54
- "@univerjs/engine-formula": "0.6.4",
55
- "@univerjs/sheets": "0.6.4",
56
- "@univerjs/core": "0.6.4"
54
+ "@univerjs/core": "0.6.5",
55
+ "@univerjs/engine-formula": "0.6.5",
56
+ "@univerjs/sheets": "0.6.5"
57
57
  },
58
58
  "devDependencies": {
59
59
  "rxjs": "^7.8.1",
60
60
  "typescript": "^5.8.2",
61
- "vite": "^6.2.0",
62
- "vitest": "^3.0.7",
63
- "@univerjs-infra/shared": "0.6.4"
61
+ "vite": "^6.2.1",
62
+ "vitest": "^3.0.8",
63
+ "@univerjs-infra/shared": "0.6.5"
64
64
  },
65
65
  "scripts": {
66
66
  "test": "vitest run",