@univerjs-pro/engine-pivot 0.4.2 → 0.5.0-alpha.0

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.
@@ -1,624 +0,0 @@
1
- /**
2
- *Enum for pivot table subtotal types.
3
- @readonly
4
- @enum {number}
5
- */
6
- export declare enum PivotSubtotalTypeEnum {
7
- /**
8
- *- the average of the values
9
- */
10
- average = 1,
11
- /**
12
- *- the count of the values
13
- */
14
- count = 2,
15
- /**
16
- *- the count of the numbers in the values
17
- */
18
- countNums = 3,
19
- /**
20
- *- the maximum value in the values
21
- */
22
- max = 4,
23
- /**
24
- *- the minimum value in the values
25
- */
26
- min = 5,
27
- /**
28
- *- the product of the values
29
- */
30
- product = 6,
31
- /**
32
- *- the standard deviation of the values
33
- */
34
- stdDev = 7,
35
- /**
36
- *- the population standard deviation of the values
37
- */
38
- stdDevp = 8,
39
- /**
40
- *- the sum of the values
41
- */
42
- sum = 9,
43
- /**
44
- *- the variance of the values
45
- */
46
- var = 10,
47
- /**
48
- *- the population variance of the values
49
- */
50
- varp = 11
51
- }
52
- /**
53
- * Enum for pivot table show as types.
54
- * @readonly
55
- * @enum {number}
56
- */
57
- export declare enum PivotShowAsTypeEnum {
58
- /**
59
- * - the normal value
60
- */
61
- normal = 1,
62
- /**
63
- * - the value as a percentage of the column total
64
- */
65
- percentOfColumnTotal = 2,
66
- /**
67
- * - the value as a percentage of the row total
68
- */
69
- percentOfRowTotal = 3,
70
- /**
71
- * - the value as a percentage of the grand total
72
- */
73
- percentOfGrandTotal = 4,
74
- /**
75
- * - the value as a percentage of the parent column total
76
- */
77
- percentOfParentColumnTotal = 5,
78
- /**
79
- * - the value as a percentage of the parent row total
80
- */
81
- percentOfParentRowTotal = 6,
82
- /**
83
- * - the value as a percentage of the parent grand total
84
- */
85
- percentOfParentGrandTotal = 7,
86
- /**
87
- * - the index of the value
88
- */
89
- index = 8,
90
- /**
91
- * - the difference from the value
92
- */
93
- differenceFrom = 9,
94
- /**
95
- * - the percentage difference from the value
96
- */
97
- percentDifferenceFrom = 10,
98
- /**
99
- * - the running total of the value
100
- */
101
- runningTotal = 11,
102
- /**
103
- * - the percentage running total of the value
104
- */
105
- percentRunningTotal = 12,
106
- /**
107
- *- the percentage of the value
108
- */
109
- percentOf = 13,
110
- /**
111
- * - the percentage of the parent value
112
- */
113
- percentOfParent = 14
114
- }
115
- /**
116
- * Enum for pivot table error types.
117
- * @description those error types almost occur in the pivot table show data as calculation.
118
- */
119
- export declare enum PivotErrorTypeEnum {
120
- /**
121
- * #DIV/0! - the divide by zero error
122
- */
123
- Div0 = 1,
124
- /**
125
- * #N/A - the not available error
126
- */
127
- NotNumber = 2,
128
- /**
129
- * #NAME! - The error occurs when a function is used incorrectly in a formula.
130
- */
131
- NotFunction = 3,
132
- /**
133
- * #NAME? error, The error occurs a function not defined in the workbook.
134
- */
135
- NotName = 4,
136
- /**
137
- * #REF! - the reference error , The error occurs when a cell reference is not valid.
138
- */
139
- BadReference = 5
140
- }
141
- /**
142
- * Enum for pivot table data field types.
143
- * @readonly
144
- * @enum {number}
145
- */
146
- export declare enum PivotFilterTypeEnum {
147
- /**
148
- * the label filter
149
- */
150
- CustomFilter = 1,
151
- /**
152
- * - the value filter
153
- */
154
- ValueFilter = 2,
155
- /**
156
- *- the manual filter
157
- */
158
- ManualFilter = 3
159
- }
160
- /**
161
- * Enum for pivot table field types.
162
- * @description those field types are used in the pivot table or pivot chart.
163
- * @readonly
164
- * @typedef {number} PivotTableFieldTypeEnum
165
- * @property {number} Column - the label field position in the pivot table column area
166
- * @property {number} Row - the label field position in the pivot table row area
167
- * @property {number} Value - the value field position in the pivot table
168
- * @property {number} Filter - the filter field position in the pivot table, it called the page field in Excel
169
- * @property {number} Hidden - the hidden field, it is not shown in the pivot table, but when a slice is created, it will be relation to the slice.
170
- */
171
- export declare enum PivotTableFiledAreaEnum {
172
- /**
173
- * Column - the column field
174
- */
175
- Column = 1,
176
- /**
177
- * Row - the row field
178
- */
179
- Row = 2,
180
- /**
181
- * Value - the value field
182
- */
183
- Value = 3,
184
- /**
185
- * Filter - the filter field
186
- */
187
- Filter = 4,
188
- /**
189
- * Hidden - the hidden field, it is not shown in the pivot table, but when a slice is created, it will be relation to the slice.
190
- */
191
- Hidden = 5
192
- }
193
- /**
194
- * Enum for pivot table value field position types. in the pivot table, the value field can be placed in the column or row field.
195
- * @readonly
196
- * @enum {number}
197
- */
198
- export declare enum PivotTableValuePositionEnum {
199
- /**
200
- * - the value field not exist in the column or row field
201
- */
202
- None = -1,
203
- /**
204
- * - the value field position in the column field
205
- */
206
- Column = 1,
207
- /**
208
- * - the value field position in the row field
209
- */
210
- Row = 2
211
- }
212
- /**
213
- * Enum for pivot table data field types.
214
- * @readonly
215
- * @enum {number}
216
- */
217
- export declare enum PivotDataFieldDataTypeEnum {
218
- /**
219
- *the string data type
220
- */
221
- text = 1,
222
- /**
223
- * the number data type
224
- */
225
- number = 2,
226
- /**
227
- * the boolean data type
228
- */
229
- boolean = 3,
230
- /**
231
- * the date data type
232
- */
233
- date = 4,
234
- /**
235
- * the blank data type
236
- */
237
- blank = 5
238
- }
239
- /**
240
- * Represents the sort types for pivot data fields.
241
- */
242
- export declare enum PivotDataFieldSortTypeEnum {
243
- /**
244
- * Sorts by the value of the data field.
245
- */
246
- value = 1,
247
- /**
248
- * Sorts by the field name of the data field.
249
- */
250
- field = 2
251
- }
252
- /**
253
- * Enum for pivot table data field sort types.
254
- * @readonly
255
- * @enum {number}
256
- * @property {number} ascending - the ascending sort
257
- * @property {number} descending - the descending sort
258
- * @property {number} manual - the manual sort
259
- */
260
- export declare enum PivotDataFieldSortOperatorEnum {
261
- /**
262
- * - the ascending sort
263
- */
264
- ascending = 1,
265
- /**
266
- * - the descending sort
267
- */
268
- descending = 2
269
- }
270
- /**
271
- * Enum for IST_PivotFilter Operator
272
- * @enum {number}
273
- */
274
- export declare enum ST_PivotFilterOperatorEnum {
275
- /**
276
- * Filter by caption that begins with a specific value
277
- * @type {number}
278
- */
279
- captionBeginsWith = 1,
280
- /**
281
- * Filter by caption that is between two values
282
- * @type {number}
283
- */
284
- captionBetween = 2,
285
- /**
286
- * Filter by caption that contains a specific value
287
- * @type {number}
288
- */
289
- captionContains = 3,
290
- /**
291
- * Filter by caption that ends with a specific value
292
- * @type {number}
293
- */
294
- captionEndsWith = 4,
295
- /**
296
- * Filter by caption that is equal to a specific value
297
- * @type {number}
298
- */
299
- captionEqual = 5,
300
- /**
301
- * Filter by caption that is greater than a specific value
302
- * @type {number}
303
- */
304
- captionGreaterThan = 6,
305
- /**
306
- * Filter by caption that is greater than or equal to a specific value
307
- * @type {number}
308
- */
309
- captionGreaterThanOrEqual = 7,
310
- /**
311
- * Filter by caption that is less than a specific value
312
- * @type {number}
313
- */
314
- captionLessThan = 8,
315
- /**
316
- * Filter by caption that is less than or equal to a specific value
317
- * @type {number}
318
- */
319
- captionLessThanOrEqual = 9,
320
- /**
321
- * Filter by caption that does not begin with a specific value
322
- * @type {number}
323
- */
324
- captionNotBeginsWith = 10,
325
- /**
326
- * Filter by caption that is not between two values
327
- * @type {number}
328
- */
329
- captionNotBetween = 11,
330
- /**
331
- * Filter by caption that does not contain a specific value
332
- * @type {number}
333
- */
334
- captionNotContains = 12,
335
- /**
336
- * Filter by caption that does not end with a specific value
337
- * @type {number}
338
- */
339
- captionNotEndsWith = 13,
340
- /**
341
- * Filter by caption that is not equal to a specific value
342
- * @type {number}
343
- */
344
- captionNotEqual = 14,
345
- /**
346
- * Filter by count
347
- * @type {number}
348
- */
349
- count = 15,
350
- /**
351
- * Filter by date that is between two values
352
- * @type {number}
353
- */
354
- dateBetween = 16,
355
- /**
356
- * Filter by date that is equal to a specific value
357
- * @type {number}
358
- */
359
- dateEqual = 17,
360
- /**
361
- * Filter by date that is newer than a specific value
362
- * @type {number}
363
- */
364
- dateNewerThan = 18,
365
- /**
366
- * Filter by date that is newer than or equal to a specific value
367
- * @type {number}
368
- */
369
- dateNewerThanOrEqual = 19,
370
- /**
371
- * Filter by date that is not between two values
372
- * @type {number}
373
- */
374
- dateNotBetween = 20,
375
- /**
376
- * Filter by date that is not equal to a specific value
377
- * @type {number}
378
- */
379
- dateNotEqual = 21,
380
- /**
381
- * Filter by date that is older than a specific value
382
- * @type {number}
383
- */
384
- dateOlderThan = 22,
385
- /**
386
- * Filter by date that is older than or equal to a specific value
387
- * @type {number}
388
- */
389
- dateOlderThanOrEqual = 23,
390
- /**
391
- * Filter by last month
392
- * @type {number}
393
- */
394
- lastMonth = 24,
395
- /**
396
- * Filter by last quarter
397
- * @type {number}
398
- */
399
- lastQuarter = 25,
400
- /**
401
- * Filter by last week
402
- * @type {number}
403
- */
404
- lastWeek = 26,
405
- /**
406
- * Filter by last year
407
- * @type {number}
408
- */
409
- lastYear = 27,
410
- /**
411
- * Filter by dates in January
412
- * @type {number}
413
- */
414
- M1 = 28,
415
- /**
416
- * Filter by dates in October
417
- * @type {number}
418
- */
419
- M10 = 29,
420
- /**
421
- * Filter by dates in November
422
- * @type {number}
423
- */
424
- M11 = 30,
425
- /**
426
- * Filter by dates in December
427
- * @type {number}
428
- */
429
- M12 = 31,
430
- /**
431
- * Filter by dates in February
432
- * @type {number}
433
- */
434
- M2 = 32,
435
- /**
436
- * Filter by dates in March
437
- * @type {number}
438
- */
439
- M3 = 33,
440
- /**
441
- * Filter by dates in April
442
- * @type {number}
443
- */
444
- M4 = 34,
445
- /**
446
- * Filter by dates in May
447
- * @type {number}
448
- */
449
- M5 = 35,
450
- /**
451
- * Filter by dates in June
452
- * @type {number}
453
- */
454
- M6 = 36,
455
- /**
456
- * Filter by dates in July
457
- * @type {number}
458
- */
459
- M7 = 37,
460
- /**
461
- * Filter by dates in August
462
- * @type {number}
463
- */
464
- M8 = 38,
465
- /**
466
- * Filter by dates in September
467
- * @type {number}
468
- */
469
- M9 = 39,
470
- /**
471
- * Filter by next month
472
- * @type {number}
473
- */
474
- nextMonth = 40,
475
- /**
476
- * Filter by next quarter
477
- * @type {number}
478
- */
479
- nextQuarter = 41,
480
- /**
481
- * Filter by next week
482
- * @type {number}
483
- */
484
- nextWeek = 42,
485
- /**
486
- * Filter by next year
487
- * @type {number}
488
- */
489
- nextYear = 43,
490
- /**
491
- * Filter by percent
492
- * @type {number}
493
- */
494
- percent = 44,
495
- /**
496
- * Filter by first quarter
497
- * @type {number}
498
- */
499
- Q1 = 45,
500
- /**
501
- * Filter by second quarter
502
- * @type {number}
503
- */
504
- Q2 = 46,
505
- /**
506
- * Filter by third quarter
507
- * @type {number}
508
- */
509
- Q3 = 47,
510
- /**
511
- * Filter by fourth quarter
512
- * @type {number}
513
- */
514
- Q4 = 48,
515
- /**
516
- * Filter by sum
517
- * @type {number}
518
- */
519
- sum = 49,
520
- /**
521
- * Filter by this month
522
- * @type {number}
523
- */
524
- thisMonth = 50,
525
- /**
526
- * Filter by this quarter
527
- * @type {number}
528
- */
529
- thisQuarter = 51,
530
- /**
531
- * Filter by this week
532
- * @type {number}
533
- */
534
- thisWeek = 52,
535
- /**
536
- * Filter by this year
537
- * @type {number}
538
- */
539
- thisYear = 53,
540
- /**
541
- * Filter by today
542
- * @type {number}
543
- */
544
- today = 54,
545
- /**
546
- * Filter by tomorrow
547
- * @type {number}
548
- */
549
- tomorrow = 55,
550
- /**
551
- * Filter by unknown
552
- * @type {number}
553
- */
554
- unknown = 56,
555
- /**
556
- * Filter by value that is between two values
557
- * @type {number}
558
- */
559
- valueBetween = 57,
560
- /**
561
- * Filter by value that is equal to a specific value
562
- * @type {number}
563
- */
564
- valueEqual = 58,
565
- /**
566
- * Filter by value that is greater than a specific value
567
- * @type {number}
568
- */
569
- valueGreaterThan = 59,
570
- /**
571
- * Filter by value that is greater than or equal to a specific value
572
- * @type {number}
573
- */
574
- valueGreaterThanOrEqual = 60,
575
- /**
576
- * Filter by value that is less than a specific value
577
- * @type {number}
578
- */
579
- valueLessThan = 61,
580
- /**
581
- * Filter by value that is less than or equal to a specific value
582
- * @type {number}
583
- */
584
- valueLessThanOrEqual = 62,
585
- /**
586
- * Filter by value that is not between two values
587
- * @type {number}
588
- */
589
- valueNotBetween = 63,
590
- /**
591
- * Filter by value that is not equal to a specific value
592
- * @type {number}
593
- */
594
- valueNotEqual = 64,
595
- /**
596
- * Filter by year-to-date
597
- * @type {number}
598
- */
599
- yearToDate = 65,
600
- /**
601
- * Filter by yesterday
602
- * @type {number}
603
- */
604
- yesterday = 66
605
- }
606
- /**
607
- * Enum for pivot table layout types.
608
- * @readonly
609
- * @enum {number}
610
- */
611
- export declare enum PivotLayoutTypeEnum {
612
- /**
613
- * @property {number} compact - the compact layout
614
- */
615
- compact = 1,
616
- /**
617
- * @property {number} outline - the outline layout
618
- */
619
- outline = 2,
620
- /**
621
- * @property {number} tabular - the tabular layout
622
- */
623
- tabular = 3
624
- }
@@ -1,5 +0,0 @@
1
- export * from './enum';
2
- export * from './interface';
3
- export * from './json-types';
4
- export * from './layout-type';
5
- export * from './summary-type';