@qrvey/utils 1.2.9-1 → 1.2.9-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.
Files changed (24) hide show
  1. package/README.md +585 -585
  2. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderSorting.d.ts +11 -9
  3. package/dist/cjs/globalization/interfaces/dashboard/II18nDashboard.d.ts +2 -0
  4. package/dist/cjs/globalization/interfaces/dashboard/II18nDashboardEmptyState.d.ts +5 -0
  5. package/dist/cjs/globalization/interfaces/dashboard/II18nDashboardEmptyState.js +2 -0
  6. package/dist/cjs/globalization/interfaces/dashboard/index.d.ts +1 -0
  7. package/dist/cjs/globalization/interfaces/dashboard/index.js +1 -0
  8. package/dist/cjs/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL_OPTIONS.js +11 -9
  9. package/dist/cjs/globalization/labels/dashboard/I18N_DASHBOARD.js +12 -7
  10. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderSorting.d.ts +11 -9
  11. package/dist/globalization/interfaces/dashboard/II18nDashboard.d.ts +2 -0
  12. package/dist/globalization/interfaces/dashboard/II18nDashboardEmptyState.d.ts +5 -0
  13. package/dist/globalization/interfaces/dashboard/II18nDashboardEmptyState.js +1 -0
  14. package/dist/globalization/interfaces/dashboard/index.d.ts +1 -0
  15. package/dist/globalization/interfaces/dashboard/index.js +1 -0
  16. package/dist/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL_OPTIONS.js +11 -9
  17. package/dist/globalization/labels/dashboard/I18N_DASHBOARD.js +12 -7
  18. package/package.json +1 -1
  19. package/src/globalization/interfaces/chart_builder/II18nChartBuilderSorting.ts +11 -9
  20. package/src/globalization/interfaces/dashboard/II18nDashboard.ts +2 -0
  21. package/src/globalization/interfaces/dashboard/II18nDashboardEmptyState.ts +5 -0
  22. package/src/globalization/interfaces/dashboard/index.ts +1 -0
  23. package/src/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL_OPTIONS.ts +12 -9
  24. package/src/globalization/labels/dashboard/I18N_DASHBOARD.ts +12 -7
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-1*
1
+ # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-2*
2
2
 
3
3
  > Helper, Utils for all Qrvey Projects
4
4
 
@@ -80,12 +80,12 @@ Get a text and evaluate if it matchs with a token box label.
80
80
 
81
81
 
82
82
 
83
- ### dist/dates/adapters/mdyDateToDate.js
83
+ ### dist/filters/adapters/FDToFlatUI.js
84
84
 
85
85
 
86
- #### mdyDateToDate(monthYearDate, time)
86
+ #### FDToFlatUI(filterData, datasetsInfo)
87
87
 
88
- Transforms String Date from a [mm/dd/yyyy] format to Date object.
88
+ Generates a Flattened UI filter structure from Filter Data structure.
89
89
 
90
90
 
91
91
 
@@ -94,8 +94,8 @@ Transforms String Date from a [mm/dd/yyyy] format to Date object.
94
94
 
95
95
  | Name | Type | Description | |
96
96
  | ---- | ---- | ----------- | -------- |
97
- | monthYearDate | | String of [mm/dd/yyyy] date |   |
98
- | time | | Flag to parse the object date to milliseconds. |   |
97
+ | filterData | | The filter data object. |   |
98
+ | datasetsInfo | | Collection of datasets information |   |
99
99
 
100
100
 
101
101
 
@@ -103,17 +103,13 @@ Transforms String Date from a [mm/dd/yyyy] format to Date object.
103
103
  ##### Returns
104
104
 
105
105
 
106
- - The date object or the date in milliseconds
107
-
108
-
109
-
106
+ - a flattened UI filters array
110
107
 
111
- ### dist/dates/adapters/monthYearToDate.js
112
108
 
113
109
 
114
- #### monthYearToDate(monthYearDate, time)
110
+ #### FD21ToFlatUI(scopes, datasetsInfo)
115
111
 
116
- Transforms String Date from a [Month Year] format to Date object.
112
+ Generates a Filter Builder Structure from the Filter Data structure v2.1
117
113
 
118
114
 
119
115
 
@@ -122,8 +118,8 @@ Transforms String Date from a [Month Year] format to Date object.
122
118
 
123
119
  | Name | Type | Description | |
124
120
  | ---- | ---- | ----------- | -------- |
125
- | monthYearDate | | String of [Month Year] date |   |
126
- | time | | Flag to parse the object date to milliseconds. |   |
121
+ | scopes | | The filter scope section |   |
122
+ | datasetsInfo | | Collection of datasets information |   |
127
123
 
128
124
 
129
125
 
@@ -131,17 +127,17 @@ Transforms String Date from a [Month Year] format to Date object.
131
127
  ##### Returns
132
128
 
133
129
 
134
- - The date object or the date in milliseconds
130
+ - a flattened UI filters array
135
131
 
136
132
 
137
133
 
138
134
 
139
- ### dist/dates/adapters/quarterYearToDate.js
135
+ ### dist/filters/adapters/FDToLogic.js
140
136
 
141
137
 
142
- #### quarterYearToDate(quarterYearDate, time)
138
+ #### FDToLogic(filterData)
143
139
 
144
- Transforms String Date from a [Quarter Year] format to Date object.
140
+ Generates a Filter Logic structure from Filter Data structure.
145
141
 
146
142
 
147
143
 
@@ -150,8 +146,7 @@ Transforms String Date from a [Quarter Year] format to Date object.
150
146
 
151
147
  | Name | Type | Description | |
152
148
  | ---- | ---- | ----------- | -------- |
153
- | quarterYearDate | | String of [Quarter Year] date |   |
154
- | time | | Flag to parse the object date to milliseconds. |   |
149
+ | filterData | | The filter data object. |   |
155
150
 
156
151
 
157
152
 
@@ -159,17 +154,13 @@ Transforms String Date from a [Quarter Year] format to Date object.
159
154
  ##### Returns
160
155
 
161
156
 
162
- - The date object or the date in milliseconds
163
-
164
-
165
-
157
+ - a filter logic array
166
158
 
167
- ### dist/dates/adapters/weekYearToDate.js
168
159
 
169
160
 
170
- #### weekYearToDate(date, time)
161
+ #### getLogicBodyFromFD21(filterData)
171
162
 
172
- Transforms String Date from a [Week Year] format to Date object.
163
+ Gets the logic body
173
164
 
174
165
 
175
166
 
@@ -178,8 +169,7 @@ Transforms String Date from a [Week Year] format to Date object.
178
169
 
179
170
  | Name | Type | Description | |
180
171
  | ---- | ---- | ----------- | -------- |
181
- | date | | String of [Week Year] date |   |
182
- | time | | Flag to parse the object date to milliseconds. |   |
172
+ | filterData | | The filter data object |   |
183
173
 
184
174
 
185
175
 
@@ -187,17 +177,17 @@ Transforms String Date from a [Week Year] format to Date object.
187
177
  ##### Returns
188
178
 
189
179
 
190
- - The date object or the date in milliseconds
180
+ - a filter logic array
191
181
 
192
182
 
193
183
 
194
184
 
195
- ### dist/dates/adapters/yearToDate.js
185
+ ### dist/filters/adapters/FDToUI.js
196
186
 
197
187
 
198
- #### yearToDate(yearDate, time)
188
+ #### FDToUI(filterData, datasetsInfo)
199
189
 
200
- Transforms String Date from a [Year] format to Date object.
190
+ Generates a UI filter structure from Filter Data structure.
201
191
 
202
192
 
203
193
 
@@ -206,8 +196,8 @@ Transforms String Date from a [Year] format to Date object.
206
196
 
207
197
  | Name | Type | Description | |
208
198
  | ---- | ---- | ----------- | -------- |
209
- | yearDate | | String of [Year] date |   |
210
- | time | | Flag to parse the object date to milliseconds. |   |
199
+ | filterData | | The filter data object. |   |
200
+ | datasetsInfo | | Collection of datasets information |   |
211
201
 
212
202
 
213
203
 
@@ -215,17 +205,13 @@ Transforms String Date from a [Year] format to Date object.
215
205
  ##### Returns
216
206
 
217
207
 
218
- - The date object or the date in milliseconds
219
-
220
-
221
-
208
+ - a UI Filters structure
222
209
 
223
- ### dist/dates/helpers/getDateFormatByProperty.js
224
210
 
225
211
 
226
- #### getDateFormatByProperty(property)
212
+ #### FD21ToUI(scopes, section, version, datasetsInfo)
227
213
 
228
- Gets the date format by the given property
214
+ Generates a UI filter Structure from the Filter Data structure v2.1
229
215
 
230
216
 
231
217
 
@@ -234,7 +220,10 @@ Gets the date format by the given property
234
220
 
235
221
  | Name | Type | Description | |
236
222
  | ---- | ---- | ----------- | -------- |
237
- | property | | The Column Property |   |
223
+ | scopes | | The filter scope section |   |
224
+ | section | | The filter section. |   |
225
+ | version | | The version of the filter structure |   |
226
+ | datasetsInfo | | Collection of datasets information |   |
238
227
 
239
228
 
240
229
 
@@ -242,17 +231,17 @@ Gets the date format by the given property
242
231
  ##### Returns
243
232
 
244
233
 
245
- - The date format
234
+ - a UI filter Structure
246
235
 
247
236
 
248
237
 
249
238
 
250
- ### dist/dates/helpers/getDateByDateFormat.js
239
+ ### dist/filters/adapters/UIToFD.js
251
240
 
252
241
 
253
- #### getDateByDateFormat(date, format, time)
242
+ #### UIToFD(filterData)
254
243
 
255
- Gets a Date Object instance by a Date format
244
+ Generates a Filter Data Structure structure from UI Filter Data structure.
256
245
 
257
246
 
258
247
 
@@ -261,9 +250,7 @@ Gets a Date Object instance by a Date format
261
250
 
262
251
  | Name | Type | Description | |
263
252
  | ---- | ---- | ----------- | -------- |
264
- | date | | String with a formatted date |   |
265
- | format | | The date format |   |
266
- | time | | flag to convert the formatted date to miliseconds |   |
253
+ | filterData | | The UI filter data object. |   |
267
254
 
268
255
 
269
256
 
@@ -271,17 +258,13 @@ Gets a Date Object instance by a Date format
271
258
  ##### Returns
272
259
 
273
260
 
274
- - a Date object, milisecond time or the same value if date format does not match.
275
-
276
-
277
-
261
+ - a Filter Data structure
278
262
 
279
- ### dist/dates/helpers/getDateFormatRegularExpressionInArray.js
280
263
 
281
264
 
282
- #### getDateFormatRegularExpressionInArray(dateFormat)
265
+ #### UI21ToFD(uFilterData, version)
283
266
 
284
- Gets an array of regular expressions by the given date format
267
+ Builds the Fitler Data structure from UI filter data
285
268
 
286
269
 
287
270
 
@@ -290,7 +273,8 @@ Gets an array of regular expressions by the given date format
290
273
 
291
274
  | Name | Type | Description | |
292
275
  | ---- | ---- | ----------- | -------- |
293
- | dateFormat | | the date format |   |
276
+ | uFilterData | | The UI filter Data object |   |
277
+ | version | | the version of the structure |   |
294
278
 
295
279
 
296
280
 
@@ -298,17 +282,17 @@ Gets an array of regular expressions by the given date format
298
282
  ##### Returns
299
283
 
300
284
 
301
- - an array of regular expressions
285
+ -
302
286
 
303
287
 
304
288
 
305
289
 
306
- ### dist/dates/helpers/getSeparatorByDateFormat.js
290
+ ### dist/filters/adapters/UIToFlatUI.js
307
291
 
308
292
 
309
- #### getSeparatorByDateFormat(format)
293
+ #### UIToFlatUI(filterData, datasetsInfo)
310
294
 
311
- Gets the separator of the date format
295
+ Generates a Flattened UI filter structure from UI Filter Data structure.
312
296
 
313
297
 
314
298
 
@@ -317,7 +301,8 @@ Gets the separator of the date format
317
301
 
318
302
  | Name | Type | Description | |
319
303
  | ---- | ---- | ----------- | -------- |
320
- | format | | the date format |   |
304
+ | filterData | | The UI filter data object. |   |
305
+ | datasetsInfo | | Collection of datasets information. Optional for updating the datasets info |   |
321
306
 
322
307
 
323
308
 
@@ -325,18 +310,13 @@ Gets the separator of the date format
325
310
  ##### Returns
326
311
 
327
312
 
328
- - a separator string
329
-
330
-
331
-
313
+ - a flattened UI filters array
332
314
 
333
- ### dist/dates/helpers/getWeek.js
334
315
 
335
316
 
336
- #### getWeek(date)
317
+ #### UI21ToFlatUI(scopes)
337
318
 
338
- Gets the week number of the year
339
- Additionally, the month and the year
319
+ Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
340
320
 
341
321
 
342
322
 
@@ -345,7 +325,7 @@ Additionally, the month and the year
345
325
 
346
326
  | Name | Type | Description | |
347
327
  | ---- | ---- | ----------- | -------- |
348
- | date | | the date object |   |
328
+ | scopes | | The filter scope section |   |
349
329
 
350
330
 
351
331
 
@@ -353,20 +333,18 @@ Additionally, the month and the year
353
333
  ##### Returns
354
334
 
355
335
 
356
- - an object with the week, month and year.
336
+ - a flattened UI filters array
357
337
 
358
338
 
359
339
 
360
340
 
361
- ### dist/dates/helpers/validateDate.js
341
+ ### dist/filters/adapters/adaptDateGroupingProperty.js
362
342
 
363
343
 
364
- #### validateDate(date, format)
344
+ #### adaptDateGroupingProperty(property)
365
345
 
366
- Validate a string date depending on giving format
367
- - If the string is a token label, the function lets it pass.
368
- - Otherwise depends of the format
369
- - Some escenarios the string is a mix of token labels and dates
346
+ [TODO: For 2022, eliminate this adapter]
347
+ Get the new property base on the old date grouping properties
370
348
 
371
349
 
372
350
 
@@ -375,8 +353,7 @@ Validate a string date depending on giving format
375
353
 
376
354
  | Name | Type | Description | |
377
355
  | ---- | ---- | ----------- | -------- |
378
- | date | | String of date |   |
379
- | format | | String of the format to validate |   |
356
+ | property | | |   |
380
357
 
381
358
 
382
359
 
@@ -384,17 +361,18 @@ Validate a string date depending on giving format
384
361
  ##### Returns
385
362
 
386
363
 
387
- - True if it is valid or not. Undefined if date is undefined
364
+ -
388
365
 
389
366
 
390
367
 
391
368
 
392
- ### dist/dates/helpers/validateDateByDateFormat.js
369
+ ### dist/filters/adapters/adaptFilterValues.js
393
370
 
394
371
 
395
- #### validateDateByDateFormat(date, dateForma)
372
+ #### adaptFilterValues(filter)
396
373
 
397
- Validates the given string as Date by its date format.
374
+ [TODO: For 2022, eliminate this adapter]
375
+ Gets an adapted filter value array. Validates the enabled property and sets
398
376
 
399
377
 
400
378
 
@@ -403,8 +381,7 @@ Validates the given string as Date by its date format.
403
381
 
404
382
  | Name | Type | Description | |
405
383
  | ---- | ---- | ----------- | -------- |
406
- | date | | a string to validate as date form |   |
407
- | dateForma | | the format of the date to validate the string |   |
384
+ | filter | | The filter |   |
408
385
 
409
386
 
410
387
 
@@ -412,17 +389,17 @@ Validates the given string as Date by its date format.
412
389
  ##### Returns
413
390
 
414
391
 
415
- - true: the string is a valida date
392
+ - A new value array with the filled properties.
416
393
 
417
394
 
418
395
 
419
396
 
420
- ### dist/dates/range/getDateRange.js
397
+ ### dist/filters/adapters/flatUIToFD.js
421
398
 
422
399
 
423
- #### getDateRange(value, dateGroupLabel, withTime)
400
+ #### flatUIToFD(uFilters, version)
424
401
 
425
- Get date range object from a string date value
402
+ Generates a filter data structure from the flatttened UI filters.
426
403
 
427
404
 
428
405
 
@@ -431,90 +408,78 @@ Get date range object from a string date value
431
408
 
432
409
  | Name | Type | Description | |
433
410
  | ---- | ---- | ----------- | -------- |
434
- | value | `String` | string date value |   |
435
- | dateGroupLabel | `String` | could be 'YEAR', 'QUARTER', 'MONTH' or 'DAY'. Deafult is 'DAY' |   |
436
- | withTime | `Boolean` | determines if the date range will include time. Default is true |   |
411
+ | uFilters | | Array of flattened filters from UI |   |
412
+ | version | | Tag for the version of the filter data structure |   |
437
413
 
438
414
 
439
415
 
440
416
 
441
- ##### Examples
417
+ ##### Returns
442
418
 
443
- ```javascript
444
- // 1) Year:
445
- getDateRange('2020', 'YEAR');
446
- // Will return:
447
- {
448
- from: '01/01/2020 00:00:00',
449
- to: '12/31/2020 23:59:59'
450
- }
451
419
 
452
- // 2) Quarter:
453
- getDateRange('Q3 2020', 'QUARTER');
454
- // Will return:
455
- {
456
- from: '07/01/2020 00:00:00',
457
- to: '09/30/2020 23:59:59'
458
- }
420
+ - a Filter Data.
459
421
 
460
- // 3) Month:
461
- getDateRange('Oct 2020', 'MONTH');
462
- // Will return:
463
- {
464
- from: '10/01/2020 00:00:00',
465
- to: '10/31/2020 23:59:59'
466
- }
467
- ```
468
422
 
469
423
 
470
- ##### Returns
424
+ #### buildScopes(fbFilters)
471
425
 
426
+ Gets an array of scopes structure for the filter data. The scopes is organized by scope types and scope IDs
427
+ Also, adds and organizes filters by datasets
472
428
 
473
- - `Object` an object with the date range with two string date properties: from and to
474
429
 
475
430
 
476
431
 
432
+ ##### Parameters
477
433
 
478
- ### dist/dates/relative/Adapter.js
434
+ | Name | Type | Description | |
435
+ | ---- | ---- | ----------- | -------- |
436
+ | fbFilters | | Array of flat filters from UI |   |
479
437
 
480
438
 
481
- #### value()
482
439
 
483
- Resolves statement and returns statement value
484
440
 
441
+ ##### Returns
485
442
 
486
443
 
444
+ - an array of scopes structure.
487
445
 
488
446
 
489
447
 
490
- ##### Returns
448
+ #### buildScope(uFilter)
491
449
 
450
+ Gets an scope structure for the filter data
492
451
 
493
- - `AbsoluteRange` `string`
494
452
 
495
453
 
496
454
 
497
- #### valueAsAnchor()
455
+ ##### Parameters
498
456
 
499
- Resolves statement as an anchor
457
+ | Name | Type | Description | |
458
+ | ---- | ---- | ----------- | -------- |
459
+ | uFilter | | UI structure filter |   |
500
460
 
501
461
 
502
462
 
503
463
 
464
+ ##### Returns
504
465
 
505
466
 
506
- ##### Returns
467
+ - an scope structure
507
468
 
508
469
 
509
- - `string`
510
470
 
471
+ #### buildDataset(uFilter)
472
+
473
+ Gets an dataset structure for the filter data
511
474
 
512
475
 
513
- #### _statementToRange() *private method*
514
476
 
515
- Convert verbal statement to range value
516
477
 
478
+ ##### Parameters
517
479
 
480
+ | Name | Type | Description | |
481
+ | ---- | ---- | ----------- | -------- |
482
+ | uFilter | | a UI structure filter |   |
518
483
 
519
484
 
520
485
 
@@ -522,61 +487,69 @@ Convert verbal statement to range value
522
487
  ##### Returns
523
488
 
524
489
 
525
- - `AbsoluteRange`
490
+ - an dataset structure
526
491
 
527
492
 
528
493
 
529
- #### _resolveAsThis() *private method*
494
+ #### buildFilter(uFilter)
530
495
 
531
- Apply 'this' cursor logic to statement
496
+ Gets an filter structure for the filter data
532
497
 
533
498
 
534
499
 
535
500
 
501
+ ##### Parameters
536
502
 
503
+ | Name | Type | Description | |
504
+ | ---- | ---- | ----------- | -------- |
505
+ | uFilter | | a UI structure filter |   |
537
506
 
538
- ##### Returns
539
507
 
540
508
 
541
- - `AbsoluteStatement`
542
509
 
510
+ ##### Returns
543
511
 
544
512
 
545
- #### _resolveAsTheLast() *private method*
513
+ - an filter structure
546
514
 
547
- Apply 'the last' cursor logic to statement
548
515
 
549
516
 
550
517
 
518
+ ### dist/filters/adapters/adaptFilterData.js
551
519
 
552
520
 
521
+ #### adaptFilterData(filterData, getUIFilterData, datasetsInfo)
553
522
 
554
- ##### Returns
523
+ Checks and adapts the v2.0 Filter Data Structure to the v2.1
555
524
 
556
525
 
557
- - `AbsoluteStatement`
558
526
 
559
527
 
528
+ ##### Parameters
560
529
 
561
- #### _resolveAsTheNext() *private method*
530
+ | Name | Type | Description | |
531
+ | ---- | ---- | ----------- | -------- |
532
+ | filterData | | The filter data structure. Accepts both v2.1 or v2.0 |   |
533
+ | getUIFilterData | | Flag to get a Filter Data (False) or the UI Filter Data (True) |   |
534
+ | datasetsInfo | | Collection of datasets information. If getUIFilterData is true, the datasetsInfo should be mandatory |   |
562
535
 
563
- Apply 'the next' cursor logic to statement
564
536
 
565
537
 
566
538
 
539
+ ##### Returns
567
540
 
568
541
 
542
+ - A new filter data structure v2.1
569
543
 
570
- ##### Returns
571
544
 
572
545
 
573
- - `AbsoluteStatement`
574
546
 
547
+ ### dist/filters/adapters/flatUIToLogic.js
575
548
 
576
549
 
577
- #### replaceNowToken(value, now)
550
+ #### flatUIToLogic(uFilter)
578
551
 
579
- Replace '@now' token inside a string
552
+ Generates a Logic structure from flattened UI filters
580
553
 
581
554
 
582
555
 
@@ -585,8 +558,7 @@ Replace '@now' token inside a string
585
558
 
586
559
  | Name | Type | Description | |
587
560
  | ---- | ---- | ----------- | -------- |
588
- | value | `string` | |   |
589
- | now | `Date` | |   |
561
+ | uFilter | | Array of flat filters from UI |   |
590
562
 
591
563
 
592
564
 
@@ -594,60 +566,44 @@ Replace '@now' token inside a string
594
566
  ##### Returns
595
567
 
596
568
 
597
- - `string`
569
+ - The logic structure
598
570
 
599
571
 
600
572
 
601
- #### convertRelativeToAbsolute(args)
602
573
 
603
- Returns a range object (date) from a group of statement params
574
+ ### dist/filters/adapters/flatUIToOldLogic.js
604
575
 
605
576
 
577
+ #### flatUIToOldLogic(uFilters)
606
578
 
579
+ Generates a Logic structure from flattened UI filters
607
580
 
608
- ##### Parameters
609
581
 
610
- | Name | Type | Description | |
611
- | ---- | ---- | ----------- | -------- |
612
- | args | `RelativeToAbsoluteStruct` | |   |
613
582
 
614
583
 
584
+ ##### Parameters
615
585
 
586
+ | Name | Type | Description | |
587
+ | ---- | ---- | ----------- | -------- |
588
+ | uFilters | | Array of flat filters from UI |   |
616
589
 
617
- ##### Examples
618
590
 
619
- ```javascript
620
- pivot = '2021-03-03T12:30:40'
621
- unit = month
622
- steps = 2
623
- setTo = END
624
- resolverAsCalendar: true
625
- => Returns '2021-05-31T23:59:59'
626
- ```
627
- ```javascript
628
- pivot = '2021-03-03T12:30:40'
629
- unit = month
630
- steps = -2
631
- setTo = START
632
- resolverAsCalendar: false
633
- => Returns '2021-01-03T00:00:00'
634
- ```
635
591
 
636
592
 
637
593
  ##### Returns
638
594
 
639
595
 
640
- - `string`
596
+ - The logic structure
641
597
 
642
598
 
643
599
 
644
600
 
645
- ### dist/dates/relative/relative.js
601
+ ### dist/filters/adapters/flatUIToUI.js
646
602
 
647
603
 
648
- #### resolveRelative(statements, clock)
604
+ #### flatUIToUI(uFilters, version)
649
605
 
650
- Resolve a list of relative statements according to operator
606
+ Generates a UI filter data structure from the flatttened UI filters.
651
607
 
652
608
 
653
609
 
@@ -656,46 +612,32 @@ Resolve a list of relative statements according to operator
656
612
 
657
613
  | Name | Type | Description | |
658
614
  | ---- | ---- | ----------- | -------- |
659
- | statements | `Array.<RelativeStatement>` `Array.<string>` | - Raw statements/values | &nbsp; |
660
- | clock | `Date` | - Clock/time reference for relative date resolution | &nbsp; |
661
-
662
-
663
-
664
-
665
- ##### Examples
615
+ | uFilters | | Array of flattened filters from UI | &nbsp; |
616
+ | version | | Tag for the version of the filter data structure | &nbsp; |
666
617
 
667
- ```javascript
668
- Input:
669
- {
670
- "cursor": "the_next",
671
- "unit": "year",
672
- "number": 1,
673
- "includeCurrent": false,
674
- "isCalendarDate": false,
675
- "anchor": "03/05/2021"
676
- }
677
618
 
678
- Output:
679
- { gte: "03/06/2021 00:00:00", lte: "03/05/2022 23:59:59" }
680
- ```
681
619
 
682
620
 
683
621
  ##### Returns
684
622
 
685
623
 
686
- - `Array.&lt;AbsoluteRange&gt;` `Array.&lt;string&gt;`
687
-
624
+ - a UI Filter Data.
688
625
 
689
626
 
690
627
 
691
- ### dist/filters/classes/FilterInputErrorHandler.js
628
+ #### buildScopes(fbFilters)
692
629
 
630
+ Gets an array of scopes structure for the UI filter data. The scopes is organized by scope types and scope IDs
631
+ Also, adds and organizes filters by datasets
693
632
 
694
- #### new FilterInputErrorHandler()
695
633
 
696
634
 
697
635
 
636
+ ##### Parameters
698
637
 
638
+ | Name | Type | Description | |
639
+ | ---- | ---- | ----------- | -------- |
640
+ | fbFilters | | Array of flat filters from UI | &nbsp; |
699
641
 
700
642
 
701
643
 
@@ -703,17 +645,13 @@ Output:
703
645
  ##### Returns
704
646
 
705
647
 
706
- - `Void`
707
-
708
-
709
-
648
+ - an array of scopes structure.
710
649
 
711
- ### dist/filters/adapters/FDToFlatUI.js
712
650
 
713
651
 
714
- #### FDToFlatUI(filterData, datasetsInfo)
652
+ #### buildScope(uFilter)
715
653
 
716
- Generates a Flattened UI filter structure from Filter Data structure.
654
+ Gets an scope structure for the UI filter data
717
655
 
718
656
 
719
657
 
@@ -722,8 +660,7 @@ Generates a Flattened UI filter structure from Filter Data structure.
722
660
 
723
661
  | Name | Type | Description | |
724
662
  | ---- | ---- | ----------- | -------- |
725
- | filterData | | The filter data object. | &nbsp; |
726
- | datasetsInfo | | Collection of datasets information | &nbsp; |
663
+ | uFilter | | UI structure filter | &nbsp; |
727
664
 
728
665
 
729
666
 
@@ -731,13 +668,13 @@ Generates a Flattened UI filter structure from Filter Data structure.
731
668
  ##### Returns
732
669
 
733
670
 
734
- - a flattened UI filters array
671
+ - an scope structure
735
672
 
736
673
 
737
674
 
738
- #### FD21ToFlatUI(scopes, datasetsInfo)
675
+ #### buildDataset(uFilter)
739
676
 
740
- Generates a Filter Builder Structure from the Filter Data structure v2.1
677
+ Gets an dataset structure for the UI filter data
741
678
 
742
679
 
743
680
 
@@ -746,8 +683,7 @@ Generates a Filter Builder Structure from the Filter Data structure v2.1
746
683
 
747
684
  | Name | Type | Description | |
748
685
  | ---- | ---- | ----------- | -------- |
749
- | scopes | | The filter scope section | &nbsp; |
750
- | datasetsInfo | | Collection of datasets information | &nbsp; |
686
+ | uFilter | | a UI structure filter | &nbsp; |
751
687
 
752
688
 
753
689
 
@@ -755,17 +691,13 @@ Generates a Filter Builder Structure from the Filter Data structure v2.1
755
691
  ##### Returns
756
692
 
757
693
 
758
- - a flattened UI filters array
759
-
760
-
761
-
694
+ - an dataset structure
762
695
 
763
- ### dist/filters/adapters/FDToLogic.js
764
696
 
765
697
 
766
- #### FDToLogic(filterData)
698
+ #### buildFilter(uFilter)
767
699
 
768
- Generates a Filter Logic structure from Filter Data structure.
700
+ Gets an filter structure for the UI filter data
769
701
 
770
702
 
771
703
 
@@ -774,7 +706,7 @@ Generates a Filter Logic structure from Filter Data structure.
774
706
 
775
707
  | Name | Type | Description | |
776
708
  | ---- | ---- | ----------- | -------- |
777
- | filterData | | The filter data object. | &nbsp; |
709
+ | uFilter | | a UI structure filter | &nbsp; |
778
710
 
779
711
 
780
712
 
@@ -782,13 +714,17 @@ Generates a Filter Logic structure from Filter Data structure.
782
714
  ##### Returns
783
715
 
784
716
 
785
- - a filter logic array
717
+ - an filter structure
786
718
 
787
719
 
788
720
 
789
- #### getLogicBodyFromFD21(filterData)
790
721
 
791
- Gets the logic body
722
+ ### dist/filters/adapters/logicToFD.js
723
+
724
+
725
+ #### logicToFD(filterData, version)
726
+
727
+ Generates a filter data structure from the old logic structure (v2.0).
792
728
 
793
729
 
794
730
 
@@ -797,7 +733,8 @@ Gets the logic body
797
733
 
798
734
  | Name | Type | Description | |
799
735
  | ---- | ---- | ----------- | -------- |
800
- | filterData | | The filter data object | &nbsp; |
736
+ | filterData | | The old filter data structure with logic (v2.0) | &nbsp; |
737
+ | version | | Tag for the version of the filter data structure | &nbsp; |
801
738
 
802
739
 
803
740
 
@@ -805,17 +742,17 @@ Gets the logic body
805
742
  ##### Returns
806
743
 
807
744
 
808
- - a filter logic array
745
+ - a Filter Data.
809
746
 
810
747
 
811
748
 
812
749
 
813
- ### dist/filters/adapters/FDToUI.js
750
+ ### dist/filters/adapters/logicToFlatUI.js
814
751
 
815
752
 
816
- #### FDToUI(filterData, datasetsInfo)
753
+ #### logicToFlatUI(logics)
817
754
 
818
- Generates a UI filter structure from Filter Data structure.
755
+ Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
819
756
 
820
757
 
821
758
 
@@ -824,8 +761,7 @@ Generates a UI filter structure from Filter Data structure.
824
761
 
825
762
  | Name | Type | Description | |
826
763
  | ---- | ---- | ----------- | -------- |
827
- | filterData | | The filter data object. | &nbsp; |
828
- | datasetsInfo | | Collection of datasets information | &nbsp; |
764
+ | logics | | The old logic structure (v2.0) | &nbsp; |
829
765
 
830
766
 
831
767
 
@@ -833,13 +769,13 @@ Generates a UI filter structure from Filter Data structure.
833
769
  ##### Returns
834
770
 
835
771
 
836
- - a UI Filters structure
772
+ - The Flattened UI Filters array
837
773
 
838
774
 
839
775
 
840
- #### FD21ToUI(scopes, section, version, datasetsInfo)
776
+ #### getFilter(filters, filter, getIndex)
841
777
 
842
- Generates a UI filter Structure from the Filter Data structure v2.1
778
+ Get the filter or the index of the given array, validating an old filter structure.
843
779
 
844
780
 
845
781
 
@@ -848,10 +784,9 @@ Generates a UI filter Structure from the Filter Data structure v2.1
848
784
 
849
785
  | Name | Type | Description | |
850
786
  | ---- | ---- | ----------- | -------- |
851
- | scopes | | The filter scope section | &nbsp; |
852
- | section | | The filter section. | &nbsp; |
853
- | version | | The version of the filter structure | &nbsp; |
854
- | datasetsInfo | | Collection of datasets information | &nbsp; |
787
+ | filters | | The array of UI filters | &nbsp; |
788
+ | filter | | The old logic structure filter | &nbsp; |
789
+ | getIndex | | Determines if the index or returns the UI filter object | &nbsp; |
855
790
 
856
791
 
857
792
 
@@ -859,17 +794,13 @@ Generates a UI filter Structure from the Filter Data structure v2.1
859
794
  ##### Returns
860
795
 
861
796
 
862
- - a UI filter Structure
863
-
864
-
865
-
797
+ - the index or the UI filter object
866
798
 
867
- ### dist/filters/adapters/UIToFD.js
868
799
 
869
800
 
870
- #### UIToFD(filterData)
801
+ #### refineRankingValues(values, uiValues)
871
802
 
872
- Generates a Filter Data Structure structure from UI Filter Data structure.
803
+ Refines the values of the Ranking column type.
873
804
 
874
805
 
875
806
 
@@ -878,7 +809,8 @@ Generates a Filter Data Structure structure from UI Filter Data structure.
878
809
 
879
810
  | Name | Type | Description | |
880
811
  | ---- | ---- | ----------- | -------- |
881
- | filterData | | The UI filter data object. | &nbsp; |
812
+ | values | | the Array of Ranking values | &nbsp; |
813
+ | uiValues | | Object with additional info about the values of the filter. | &nbsp; |
882
814
 
883
815
 
884
816
 
@@ -886,13 +818,17 @@ Generates a Filter Data Structure structure from UI Filter Data structure.
886
818
  ##### Returns
887
819
 
888
820
 
889
- - a Filter Data structure
821
+ - the array of Ranking values
890
822
 
891
823
 
892
824
 
893
- #### UI21ToFD(uFilterData, version)
894
825
 
895
- Builds the Fitler Data structure from UI filter data
826
+ ### dist/filters/adapters/logicToUI.js
827
+
828
+
829
+ #### logicToUI(uFilters, datasetsInfo)
830
+
831
+ Generates a UI filter structure from the old logic structure (v2.0).
896
832
 
897
833
 
898
834
 
@@ -901,8 +837,8 @@ Builds the Fitler Data structure from UI filter data
901
837
 
902
838
  | Name | Type | Description | |
903
839
  | ---- | ---- | ----------- | -------- |
904
- | uFilterData | | The UI filter Data object | &nbsp; |
905
- | version | | the version of the structure | &nbsp; |
840
+ | uFilters | | Array of filters from old logic structure | &nbsp; |
841
+ | datasetsInfo | | Collection of datasets information | &nbsp; |
906
842
 
907
843
 
908
844
 
@@ -910,17 +846,17 @@ Builds the Fitler Data structure from UI filter data
910
846
  ##### Returns
911
847
 
912
848
 
913
- -
849
+ - a UI Filter Data.
914
850
 
915
851
 
916
852
 
917
853
 
918
- ### dist/filters/adapters/UIToFlatUI.js
854
+ ### dist/filters/adapters/transformFilters.js
919
855
 
920
856
 
921
- #### UIToFlatUI(filterData, datasetsInfo)
857
+ #### transformFilters(oldFiltersObj, section)
922
858
 
923
- Generates a Flattened UI filter structure from UI Filter Data structure.
859
+ Transform the old filters structure into the new one
924
860
 
925
861
 
926
862
 
@@ -929,50 +865,77 @@ Generates a Flattened UI filter structure from UI Filter Data structure.
929
865
 
930
866
  | Name | Type | Description | |
931
867
  | ---- | ---- | ----------- | -------- |
932
- | filterData | | The UI filter data object. | &nbsp; |
933
- | datasetsInfo | | Collection of datasets information. Optional for updating the datasets info | &nbsp; |
868
+ | oldFiltersObj | `Object` | an object with the old filters structure | &nbsp; |
869
+ | section | `String` | could be 'ANALYZE', 'PB', 'UM' or any other value. Deafult is 'ANYWHERE' | &nbsp; |
934
870
 
935
871
 
936
872
 
937
873
 
938
- ##### Returns
874
+ ##### Examples
939
875
 
876
+ ```javascript
940
877
 
941
- - a flattened UI filters array
878
+ const oldPreferenceFilters = {
879
+ "WWXHAULtR-_-xYOQAdpqT__ENABLED": true,
880
+ "WWXHAULtR-_-xYOQAdpqT__ALL--ENABLED": true,
881
+ "WWXHAULtR-_-xYOQAdpqT__COLLAPSED": false,
882
+ "WWXHAULtR-_-xYOQAdpqT__LABEL": "GLOBAL",
883
+ "WWXHAULtR-_-xYOQAdpqT-_-AK4M8UV2": {
884
+ "formulaId": null,
885
+ "panelId": null,
886
+ "values": [
887
+ {
888
+ "EQUALS": [
889
+ {
890
+ "id": "AK4M8UV2a0",
891
+ "value": "A",
892
+ "enabled": true,
893
+ "imageUrl": null
894
+ },
895
+ {
896
+ "id": "AK4M8UV2a1",
897
+ "value": "B",
898
+ "enabled": true,
899
+ "imageUrl": null
900
+ }
901
+ ]
902
+ }
903
+ ],
904
+ "bucketId": null,
905
+ "text": "MC",
906
+ "title": "MC",
907
+ "type": "SINGLE_CHOICE",
908
+ "qid": "AK4M8UV2",
909
+ "dataset": {
910
+ "sourceid": "xYOQAdpqT",
911
+ "name": "Form All Questions",
912
+ "qrveyid": "xYOQAdpqT",
913
+ "text": "Form All Questions",
914
+ "linkid": 0
915
+ },
916
+ "enabled": true,
917
+ "linked": null
918
+ }
919
+ };
942
920
 
921
+ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
922
+ ```
943
923
 
944
924
 
945
- #### UI21ToFlatUI(scopes)
925
+ ##### Returns
946
926
 
947
- Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
948
927
 
928
+ - `Object` an object with the new filters structure
949
929
 
950
930
 
951
931
 
952
- ##### Parameters
953
932
 
954
- | Name | Type | Description | |
955
- | ---- | ---- | ----------- | -------- |
956
- | scopes | | The filter scope section | &nbsp; |
933
+ ### dist/filters/helpers/applyHierarchyForAggFilters.js
957
934
 
958
935
 
936
+ #### applyHierarchyForAggFilters(chartSettings, scopes, currentScope)
959
937
 
960
-
961
- ##### Returns
962
-
963
-
964
- - a flattened UI filters array
965
-
966
-
967
-
968
-
969
- ### dist/filters/adapters/adaptDateGroupingProperty.js
970
-
971
-
972
- #### adaptDateGroupingProperty(property)
973
-
974
- [TODO: For 2022, eliminate this adapter]
975
- Get the new property base on the old date grouping properties
938
+ [TODO: Make a proper description for this function]
976
939
 
977
940
 
978
941
 
@@ -981,7 +944,9 @@ Get the new property base on the old date grouping properties
981
944
 
982
945
  | Name | Type | Description | |
983
946
  | ---- | ---- | ----------- | -------- |
984
- | property | | | &nbsp; |
947
+ | chartSettings | | Chart Settings for the Filter Builder | &nbsp; |
948
+ | scopes | | | &nbsp; |
949
+ | currentScope | | | &nbsp; |
985
950
 
986
951
 
987
952
 
@@ -994,12 +959,12 @@ Get the new property base on the old date grouping properties
994
959
 
995
960
 
996
961
 
997
- ### dist/filters/adapters/adaptFilterData.js
962
+ ### dist/filters/helpers/getAvailableScopes.js
998
963
 
999
964
 
1000
- #### adaptFilterData(filterData, getUIFilterData, datasetsInfo)
965
+ #### getAvailableScopes(config)
1001
966
 
1002
- Checks and adapts the v2.0 Filter Data Structure to the v2.1
967
+ Gets Scopes/Scope IDs by given IDs
1003
968
 
1004
969
 
1005
970
 
@@ -1008,9 +973,7 @@ Checks and adapts the v2.0 Filter Data Structure to the v2.1
1008
973
 
1009
974
  | Name | Type | Description | |
1010
975
  | ---- | ---- | ----------- | -------- |
1011
- | filterData | | The filter data structure. Accepts both v2.1 or v2.0 | &nbsp; |
1012
- | getUIFilterData | | Flag to get a Filter Data (False) or the UI Filter Data (True) | &nbsp; |
1013
- | datasetsInfo | | Collection of datasets information. If getUIFilterData is true, the datasetsInfo should be mandatory | &nbsp; |
976
+ | config | | given Differnts IDs in order set a available scope | &nbsp; |
1014
977
 
1015
978
 
1016
979
 
@@ -1018,18 +981,17 @@ Checks and adapts the v2.0 Filter Data Structure to the v2.1
1018
981
  ##### Returns
1019
982
 
1020
983
 
1021
- - A new filter data structure v2.1
984
+ - a Scopes/Scope IDs array
1022
985
 
1023
986
 
1024
987
 
1025
988
 
1026
- ### dist/filters/adapters/adaptFilterValues.js
989
+ ### dist/filters/helpers/getAvailableScopesIDsByConfig.js
1027
990
 
1028
991
 
1029
- #### adaptFilterValues(filter)
992
+ #### getAvailableScopesIDsByConfig(config)
1030
993
 
1031
- [TODO: For 2022, eliminate this adapter]
1032
- Gets an adapted filter value array. Validates the enabled property and sets
994
+ Gets the Scopes IDS for the Available Scope function by any config
1033
995
 
1034
996
 
1035
997
 
@@ -1038,7 +1000,7 @@ Gets an adapted filter value array. Validates the enabled property and sets
1038
1000
 
1039
1001
  | Name | Type | Description | |
1040
1002
  | ---- | ---- | ----------- | -------- |
1041
- | filter | | The filter | &nbsp; |
1003
+ | config | | any config | &nbsp; |
1042
1004
 
1043
1005
 
1044
1006
 
@@ -1046,17 +1008,17 @@ Gets an adapted filter value array. Validates the enabled property and sets
1046
1008
  ##### Returns
1047
1009
 
1048
1010
 
1049
- - A new value array with the filled properties.
1011
+ - a Available Scope IDS config
1050
1012
 
1051
1013
 
1052
1014
 
1053
1015
 
1054
- ### dist/filters/adapters/flatUIToFD.js
1016
+ ### dist/filters/helpers/getScopesByHierarchy.js
1055
1017
 
1056
1018
 
1057
- #### flatUIToFD(uFilters, version)
1019
+ #### getScopesByHierarchy(scopes, currentScope)
1058
1020
 
1059
- Generates a filter data structure from the flatttened UI filters.
1021
+ [TODO: Make a description for this]
1060
1022
 
1061
1023
 
1062
1024
 
@@ -1065,8 +1027,8 @@ Generates a filter data structure from the flatttened UI filters.
1065
1027
 
1066
1028
  | Name | Type | Description | |
1067
1029
  | ---- | ---- | ----------- | -------- |
1068
- | uFilters | | Array of flattened filters from UI | &nbsp; |
1069
- | version | | Tag for the version of the filter data structure | &nbsp; |
1030
+ | scopes | | the collection of Scopes/Scope IDs | &nbsp; |
1031
+ | currentScope | | Current scope type | &nbsp; |
1070
1032
 
1071
1033
 
1072
1034
 
@@ -1074,23 +1036,19 @@ Generates a filter data structure from the flatttened UI filters.
1074
1036
  ##### Returns
1075
1037
 
1076
1038
 
1077
- - a Filter Data.
1039
+ - A new array of Scopes/Scope IDs
1078
1040
 
1079
1041
 
1080
1042
 
1081
- #### buildScopes(fbFilters)
1082
1043
 
1083
- Gets an array of scopes structure for the filter data. The scopes is organized by scope types and scope IDs
1084
- Also, adds and organizes filters by datasets
1044
+ ### dist/filters/classes/FilterInputErrorHandler.js
1085
1045
 
1086
1046
 
1047
+ #### new FilterInputErrorHandler()
1048
+
1087
1049
 
1088
1050
 
1089
- ##### Parameters
1090
1051
 
1091
- | Name | Type | Description | |
1092
- | ---- | ---- | ----------- | -------- |
1093
- | fbFilters | | Array of flat filters from UI | &nbsp; |
1094
1052
 
1095
1053
 
1096
1054
 
@@ -1098,13 +1056,17 @@ Also, adds and organizes filters by datasets
1098
1056
  ##### Returns
1099
1057
 
1100
1058
 
1101
- - an array of scopes structure.
1059
+ - `Void`
1102
1060
 
1103
1061
 
1104
1062
 
1105
- #### buildScope(uFilter)
1106
1063
 
1107
- Gets an scope structure for the filter data
1064
+ ### dist/dates/adapters/mdyDateToDate.js
1065
+
1066
+
1067
+ #### mdyDateToDate(monthYearDate, time)
1068
+
1069
+ Transforms String Date from a [mm/dd/yyyy] format to Date object.
1108
1070
 
1109
1071
 
1110
1072
 
@@ -1113,7 +1075,8 @@ Gets an scope structure for the filter data
1113
1075
 
1114
1076
  | Name | Type | Description | |
1115
1077
  | ---- | ---- | ----------- | -------- |
1116
- | uFilter | | UI structure filter | &nbsp; |
1078
+ | monthYearDate | | String of [mm/dd/yyyy] date | &nbsp; |
1079
+ | time | | Flag to parse the object date to milliseconds. | &nbsp; |
1117
1080
 
1118
1081
 
1119
1082
 
@@ -1121,13 +1084,17 @@ Gets an scope structure for the filter data
1121
1084
  ##### Returns
1122
1085
 
1123
1086
 
1124
- - an scope structure
1087
+ - The date object or the date in milliseconds
1125
1088
 
1126
1089
 
1127
1090
 
1128
- #### buildDataset(uFilter)
1129
1091
 
1130
- Gets an dataset structure for the filter data
1092
+ ### dist/dates/adapters/monthYearToDate.js
1093
+
1094
+
1095
+ #### monthYearToDate(monthYearDate, time)
1096
+
1097
+ Transforms String Date from a [Month Year] format to Date object.
1131
1098
 
1132
1099
 
1133
1100
 
@@ -1136,7 +1103,8 @@ Gets an dataset structure for the filter data
1136
1103
 
1137
1104
  | Name | Type | Description | |
1138
1105
  | ---- | ---- | ----------- | -------- |
1139
- | uFilter | | a UI structure filter | &nbsp; |
1106
+ | monthYearDate | | String of [Month Year] date | &nbsp; |
1107
+ | time | | Flag to parse the object date to milliseconds. | &nbsp; |
1140
1108
 
1141
1109
 
1142
1110
 
@@ -1144,13 +1112,17 @@ Gets an dataset structure for the filter data
1144
1112
  ##### Returns
1145
1113
 
1146
1114
 
1147
- - an dataset structure
1115
+ - The date object or the date in milliseconds
1148
1116
 
1149
1117
 
1150
1118
 
1151
- #### buildFilter(uFilter)
1152
1119
 
1153
- Gets an filter structure for the filter data
1120
+ ### dist/dates/adapters/quarterYearToDate.js
1121
+
1122
+
1123
+ #### quarterYearToDate(quarterYearDate, time)
1124
+
1125
+ Transforms String Date from a [Quarter Year] format to Date object.
1154
1126
 
1155
1127
 
1156
1128
 
@@ -1159,7 +1131,8 @@ Gets an filter structure for the filter data
1159
1131
 
1160
1132
  | Name | Type | Description | |
1161
1133
  | ---- | ---- | ----------- | -------- |
1162
- | uFilter | | a UI structure filter | &nbsp; |
1134
+ | quarterYearDate | | String of [Quarter Year] date | &nbsp; |
1135
+ | time | | Flag to parse the object date to milliseconds. | &nbsp; |
1163
1136
 
1164
1137
 
1165
1138
 
@@ -1167,17 +1140,17 @@ Gets an filter structure for the filter data
1167
1140
  ##### Returns
1168
1141
 
1169
1142
 
1170
- - an filter structure
1143
+ - The date object or the date in milliseconds
1171
1144
 
1172
1145
 
1173
1146
 
1174
1147
 
1175
- ### dist/filters/adapters/flatUIToLogic.js
1148
+ ### dist/dates/adapters/weekYearToDate.js
1176
1149
 
1177
1150
 
1178
- #### flatUIToLogic(uFilter)
1151
+ #### weekYearToDate(date, time)
1179
1152
 
1180
- Generates a Logic structure from flattened UI filters
1153
+ Transforms String Date from a [Week Year] format to Date object.
1181
1154
 
1182
1155
 
1183
1156
 
@@ -1186,7 +1159,8 @@ Generates a Logic structure from flattened UI filters
1186
1159
 
1187
1160
  | Name | Type | Description | |
1188
1161
  | ---- | ---- | ----------- | -------- |
1189
- | uFilter | | Array of flat filters from UI | &nbsp; |
1162
+ | date | | String of [Week Year] date | &nbsp; |
1163
+ | time | | Flag to parse the object date to milliseconds. | &nbsp; |
1190
1164
 
1191
1165
 
1192
1166
 
@@ -1194,17 +1168,17 @@ Generates a Logic structure from flattened UI filters
1194
1168
  ##### Returns
1195
1169
 
1196
1170
 
1197
- - The logic structure
1171
+ - The date object or the date in milliseconds
1198
1172
 
1199
1173
 
1200
1174
 
1201
1175
 
1202
- ### dist/filters/adapters/flatUIToOldLogic.js
1176
+ ### dist/dates/adapters/yearToDate.js
1203
1177
 
1204
1178
 
1205
- #### flatUIToOldLogic(uFilters)
1179
+ #### yearToDate(yearDate, time)
1206
1180
 
1207
- Generates a Logic structure from flattened UI filters
1181
+ Transforms String Date from a [Year] format to Date object.
1208
1182
 
1209
1183
 
1210
1184
 
@@ -1213,7 +1187,8 @@ Generates a Logic structure from flattened UI filters
1213
1187
 
1214
1188
  | Name | Type | Description | |
1215
1189
  | ---- | ---- | ----------- | -------- |
1216
- | uFilters | | Array of flat filters from UI | &nbsp; |
1190
+ | yearDate | | String of [Year] date | &nbsp; |
1191
+ | time | | Flag to parse the object date to milliseconds. | &nbsp; |
1217
1192
 
1218
1193
 
1219
1194
 
@@ -1221,17 +1196,17 @@ Generates a Logic structure from flattened UI filters
1221
1196
  ##### Returns
1222
1197
 
1223
1198
 
1224
- - The logic structure
1199
+ - The date object or the date in milliseconds
1225
1200
 
1226
1201
 
1227
1202
 
1228
1203
 
1229
- ### dist/filters/adapters/flatUIToUI.js
1204
+ ### dist/dates/helpers/getDateByDateFormat.js
1230
1205
 
1231
1206
 
1232
- #### flatUIToUI(uFilters, version)
1207
+ #### getDateByDateFormat(date, format, time)
1233
1208
 
1234
- Generates a UI filter data structure from the flatttened UI filters.
1209
+ Gets a Date Object instance by a Date format
1235
1210
 
1236
1211
 
1237
1212
 
@@ -1240,8 +1215,9 @@ Generates a UI filter data structure from the flatttened UI filters.
1240
1215
 
1241
1216
  | Name | Type | Description | |
1242
1217
  | ---- | ---- | ----------- | -------- |
1243
- | uFilters | | Array of flattened filters from UI | &nbsp; |
1244
- | version | | Tag for the version of the filter data structure | &nbsp; |
1218
+ | date | | String with a formatted date | &nbsp; |
1219
+ | format | | The date format | &nbsp; |
1220
+ | time | | flag to convert the formatted date to miliseconds | &nbsp; |
1245
1221
 
1246
1222
 
1247
1223
 
@@ -1249,14 +1225,17 @@ Generates a UI filter data structure from the flatttened UI filters.
1249
1225
  ##### Returns
1250
1226
 
1251
1227
 
1252
- - a UI Filter Data.
1228
+ - a Date object, milisecond time or the same value if date format does not match.
1253
1229
 
1254
1230
 
1255
1231
 
1256
- #### buildScopes(fbFilters)
1257
1232
 
1258
- Gets an array of scopes structure for the UI filter data. The scopes is organized by scope types and scope IDs
1259
- Also, adds and organizes filters by datasets
1233
+ ### dist/dates/helpers/getDateFormatByProperty.js
1234
+
1235
+
1236
+ #### getDateFormatByProperty(property)
1237
+
1238
+ Gets the date format by the given property
1260
1239
 
1261
1240
 
1262
1241
 
@@ -1265,7 +1244,7 @@ Also, adds and organizes filters by datasets
1265
1244
 
1266
1245
  | Name | Type | Description | |
1267
1246
  | ---- | ---- | ----------- | -------- |
1268
- | fbFilters | | Array of flat filters from UI | &nbsp; |
1247
+ | property | | The Column Property | &nbsp; |
1269
1248
 
1270
1249
 
1271
1250
 
@@ -1273,13 +1252,17 @@ Also, adds and organizes filters by datasets
1273
1252
  ##### Returns
1274
1253
 
1275
1254
 
1276
- - an array of scopes structure.
1255
+ - The date format
1277
1256
 
1278
1257
 
1279
1258
 
1280
- #### buildScope(uFilter)
1281
1259
 
1282
- Gets an scope structure for the UI filter data
1260
+ ### dist/dates/helpers/getDateFormatRegularExpressionInArray.js
1261
+
1262
+
1263
+ #### getDateFormatRegularExpressionInArray(dateFormat)
1264
+
1265
+ Gets an array of regular expressions by the given date format
1283
1266
 
1284
1267
 
1285
1268
 
@@ -1288,7 +1271,7 @@ Gets an scope structure for the UI filter data
1288
1271
 
1289
1272
  | Name | Type | Description | |
1290
1273
  | ---- | ---- | ----------- | -------- |
1291
- | uFilter | | UI structure filter | &nbsp; |
1274
+ | dateFormat | | the date format | &nbsp; |
1292
1275
 
1293
1276
 
1294
1277
 
@@ -1296,13 +1279,17 @@ Gets an scope structure for the UI filter data
1296
1279
  ##### Returns
1297
1280
 
1298
1281
 
1299
- - an scope structure
1282
+ - an array of regular expressions
1300
1283
 
1301
1284
 
1302
1285
 
1303
- #### buildDataset(uFilter)
1304
1286
 
1305
- Gets an dataset structure for the UI filter data
1287
+ ### dist/dates/helpers/getSeparatorByDateFormat.js
1288
+
1289
+
1290
+ #### getSeparatorByDateFormat(format)
1291
+
1292
+ Gets the separator of the date format
1306
1293
 
1307
1294
 
1308
1295
 
@@ -1311,7 +1298,7 @@ Gets an dataset structure for the UI filter data
1311
1298
 
1312
1299
  | Name | Type | Description | |
1313
1300
  | ---- | ---- | ----------- | -------- |
1314
- | uFilter | | a UI structure filter | &nbsp; |
1301
+ | format | | the date format | &nbsp; |
1315
1302
 
1316
1303
 
1317
1304
 
@@ -1319,13 +1306,18 @@ Gets an dataset structure for the UI filter data
1319
1306
  ##### Returns
1320
1307
 
1321
1308
 
1322
- - an dataset structure
1309
+ - a separator string
1323
1310
 
1324
1311
 
1325
1312
 
1326
- #### buildFilter(uFilter)
1327
1313
 
1328
- Gets an filter structure for the UI filter data
1314
+ ### dist/dates/helpers/getWeek.js
1315
+
1316
+
1317
+ #### getWeek(date)
1318
+
1319
+ Gets the week number of the year
1320
+ Additionally, the month and the year
1329
1321
 
1330
1322
 
1331
1323
 
@@ -1334,7 +1326,7 @@ Gets an filter structure for the UI filter data
1334
1326
 
1335
1327
  | Name | Type | Description | |
1336
1328
  | ---- | ---- | ----------- | -------- |
1337
- | uFilter | | a UI structure filter | &nbsp; |
1329
+ | date | | the date object | &nbsp; |
1338
1330
 
1339
1331
 
1340
1332
 
@@ -1342,17 +1334,20 @@ Gets an filter structure for the UI filter data
1342
1334
  ##### Returns
1343
1335
 
1344
1336
 
1345
- - an filter structure
1337
+ - an object with the week, month and year.
1346
1338
 
1347
1339
 
1348
1340
 
1349
1341
 
1350
- ### dist/filters/adapters/logicToFD.js
1342
+ ### dist/dates/helpers/validateDate.js
1351
1343
 
1352
1344
 
1353
- #### logicToFD(filterData, version)
1345
+ #### validateDate(date, format)
1354
1346
 
1355
- Generates a filter data structure from the old logic structure (v2.0).
1347
+ Validate a string date depending on giving format
1348
+ - If the string is a token label, the function lets it pass.
1349
+ - Otherwise depends of the format
1350
+ - Some escenarios the string is a mix of token labels and dates
1356
1351
 
1357
1352
 
1358
1353
 
@@ -1361,8 +1356,8 @@ Generates a filter data structure from the old logic structure (v2.0).
1361
1356
 
1362
1357
  | Name | Type | Description | |
1363
1358
  | ---- | ---- | ----------- | -------- |
1364
- | filterData | | The old filter data structure with logic (v2.0) | &nbsp; |
1365
- | version | | Tag for the version of the filter data structure | &nbsp; |
1359
+ | date | | String of date | &nbsp; |
1360
+ | format | | String of the format to validate | &nbsp; |
1366
1361
 
1367
1362
 
1368
1363
 
@@ -1370,17 +1365,17 @@ Generates a filter data structure from the old logic structure (v2.0).
1370
1365
  ##### Returns
1371
1366
 
1372
1367
 
1373
- - a Filter Data.
1368
+ - True if it is valid or not. Undefined if date is undefined
1374
1369
 
1375
1370
 
1376
1371
 
1377
1372
 
1378
- ### dist/filters/adapters/logicToFlatUI.js
1373
+ ### dist/dates/helpers/validateDateByDateFormat.js
1379
1374
 
1380
1375
 
1381
- #### logicToFlatUI(logics)
1376
+ #### validateDateByDateFormat(date, dateForma)
1382
1377
 
1383
- Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
1378
+ Validates the given string as Date by its date format.
1384
1379
 
1385
1380
 
1386
1381
 
@@ -1389,7 +1384,8 @@ Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
1389
1384
 
1390
1385
  | Name | Type | Description | |
1391
1386
  | ---- | ---- | ----------- | -------- |
1392
- | logics | | The old logic structure (v2.0) | &nbsp; |
1387
+ | date | | a string to validate as date form | &nbsp; |
1388
+ | dateForma | | the format of the date to validate the string | &nbsp; |
1393
1389
 
1394
1390
 
1395
1391
 
@@ -1397,13 +1393,17 @@ Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
1397
1393
  ##### Returns
1398
1394
 
1399
1395
 
1400
- - The Flattened UI Filters array
1396
+ - true: the string is a valida date
1401
1397
 
1402
1398
 
1403
1399
 
1404
- #### getFilter(filters, filter, getIndex)
1405
1400
 
1406
- Get the filter or the index of the given array, validating an old filter structure.
1401
+ ### dist/dates/range/getDateRange.js
1402
+
1403
+
1404
+ #### getDateRange(value, dateGroupLabel, withTime)
1405
+
1406
+ Get date range object from a string date value
1407
1407
 
1408
1408
 
1409
1409
 
@@ -1412,61 +1412,74 @@ Get the filter or the index of the given array, validating an old filter structu
1412
1412
 
1413
1413
  | Name | Type | Description | |
1414
1414
  | ---- | ---- | ----------- | -------- |
1415
- | filters | | The array of UI filters | &nbsp; |
1416
- | filter | | The old logic structure filter | &nbsp; |
1417
- | getIndex | | Determines if the index or returns the UI filter object | &nbsp; |
1418
-
1415
+ | value | `String` | string date value | &nbsp; |
1416
+ | dateGroupLabel | `String` | could be 'YEAR', 'QUARTER', 'MONTH' or 'DAY'. Deafult is 'DAY' | &nbsp; |
1417
+ | withTime | `Boolean` | determines if the date range will include time. Default is true | &nbsp; |
1419
1418
 
1420
1419
 
1421
1420
 
1422
- ##### Returns
1423
1421
 
1422
+ ##### Examples
1424
1423
 
1425
- - the index or the UI filter object
1424
+ ```javascript
1425
+ // 1) Year:
1426
+ getDateRange('2020', 'YEAR');
1427
+ // Will return:
1428
+ {
1429
+ from: '01/01/2020 00:00:00',
1430
+ to: '12/31/2020 23:59:59'
1431
+ }
1426
1432
 
1433
+ // 2) Quarter:
1434
+ getDateRange('Q3 2020', 'QUARTER');
1435
+ // Will return:
1436
+ {
1437
+ from: '07/01/2020 00:00:00',
1438
+ to: '09/30/2020 23:59:59'
1439
+ }
1427
1440
 
1441
+ // 3) Month:
1442
+ getDateRange('Oct 2020', 'MONTH');
1443
+ // Will return:
1444
+ {
1445
+ from: '10/01/2020 00:00:00',
1446
+ to: '10/31/2020 23:59:59'
1447
+ }
1448
+ ```
1428
1449
 
1429
- #### refineRankingValues(values, uiValues)
1430
1450
 
1431
- Refines the values of the Ranking column type.
1451
+ ##### Returns
1432
1452
 
1433
1453
 
1454
+ - `Object` an object with the date range with two string date properties: from and to
1434
1455
 
1435
1456
 
1436
- ##### Parameters
1437
1457
 
1438
- | Name | Type | Description | |
1439
- | ---- | ---- | ----------- | -------- |
1440
- | values | | the Array of Ranking values | &nbsp; |
1441
- | uiValues | | Object with additional info about the values of the filter. | &nbsp; |
1442
1458
 
1459
+ ### dist/dates/relative/Adapter.js
1443
1460
 
1444
1461
 
1462
+ #### value()
1445
1463
 
1446
- ##### Returns
1464
+ Resolves statement and returns statement value
1447
1465
 
1448
1466
 
1449
- - the array of Ranking values
1450
1467
 
1451
1468
 
1452
1469
 
1453
1470
 
1454
- ### dist/filters/adapters/logicToUI.js
1471
+ ##### Returns
1455
1472
 
1456
1473
 
1457
- #### logicToUI(uFilters, datasetsInfo)
1474
+ - `AbsoluteRange` `string`
1458
1475
 
1459
- Generates a UI filter structure from the old logic structure (v2.0).
1460
1476
 
1461
1477
 
1478
+ #### valueAsAnchor()
1462
1479
 
1480
+ Resolves statement as an anchor
1463
1481
 
1464
- ##### Parameters
1465
1482
 
1466
- | Name | Type | Description | |
1467
- | ---- | ---- | ----------- | -------- |
1468
- | uFilters | | Array of filters from old logic structure | &nbsp; |
1469
- | datasetsInfo | | Collection of datasets information | &nbsp; |
1470
1483
 
1471
1484
 
1472
1485
 
@@ -1474,125 +1487,77 @@ Generates a UI filter structure from the old logic structure (v2.0).
1474
1487
  ##### Returns
1475
1488
 
1476
1489
 
1477
- - a UI Filter Data.
1490
+ - `string`
1478
1491
 
1479
1492
 
1480
1493
 
1494
+ #### _statementToRange() *private method*
1481
1495
 
1482
- ### dist/filters/adapters/transformFilters.js
1496
+ Convert verbal statement to range value
1483
1497
 
1484
1498
 
1485
- #### transformFilters(oldFiltersObj, section)
1486
1499
 
1487
- Transform the old filters structure into the new one
1488
1500
 
1489
1501
 
1490
1502
 
1503
+ ##### Returns
1491
1504
 
1492
- ##### Parameters
1493
1505
 
1494
- | Name | Type | Description | |
1495
- | ---- | ---- | ----------- | -------- |
1496
- | oldFiltersObj | `Object` | an object with the old filters structure | &nbsp; |
1497
- | section | `String` | could be 'ANALYZE', 'PB', 'UM' or any other value. Deafult is 'ANYWHERE' | &nbsp; |
1506
+ - `AbsoluteRange`
1498
1507
 
1499
1508
 
1500
1509
 
1510
+ #### _resolveAsThis() *private method*
1511
+
1512
+ Apply 'this' cursor logic to statement
1501
1513
 
1502
- ##### Examples
1503
1514
 
1504
- ```javascript
1505
1515
 
1506
- const oldPreferenceFilters = {
1507
- "WWXHAULtR-_-xYOQAdpqT__ENABLED": true,
1508
- "WWXHAULtR-_-xYOQAdpqT__ALL--ENABLED": true,
1509
- "WWXHAULtR-_-xYOQAdpqT__COLLAPSED": false,
1510
- "WWXHAULtR-_-xYOQAdpqT__LABEL": "GLOBAL",
1511
- "WWXHAULtR-_-xYOQAdpqT-_-AK4M8UV2": {
1512
- "formulaId": null,
1513
- "panelId": null,
1514
- "values": [
1515
- {
1516
- "EQUALS": [
1517
- {
1518
- "id": "AK4M8UV2a0",
1519
- "value": "A",
1520
- "enabled": true,
1521
- "imageUrl": null
1522
- },
1523
- {
1524
- "id": "AK4M8UV2a1",
1525
- "value": "B",
1526
- "enabled": true,
1527
- "imageUrl": null
1528
- }
1529
- ]
1530
- }
1531
- ],
1532
- "bucketId": null,
1533
- "text": "MC",
1534
- "title": "MC",
1535
- "type": "SINGLE_CHOICE",
1536
- "qid": "AK4M8UV2",
1537
- "dataset": {
1538
- "sourceid": "xYOQAdpqT",
1539
- "name": "Form All Questions",
1540
- "qrveyid": "xYOQAdpqT",
1541
- "text": "Form All Questions",
1542
- "linkid": 0
1543
- },
1544
- "enabled": true,
1545
- "linked": null
1546
- }
1547
- };
1548
1516
 
1549
- const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
1550
- ```
1551
1517
 
1552
1518
 
1553
1519
  ##### Returns
1554
1520
 
1555
1521
 
1556
- - `Object` an object with the new filters structure
1522
+ - `AbsoluteStatement`
1557
1523
 
1558
1524
 
1559
1525
 
1526
+ #### _resolveAsTheLast() *private method*
1560
1527
 
1561
- ### dist/filters/helpers/applyHierarchyForAggFilters.js
1528
+ Apply 'the last' cursor logic to statement
1562
1529
 
1563
1530
 
1564
- #### applyHierarchyForAggFilters(chartSettings, scopes, currentScope)
1565
1531
 
1566
- [TODO: Make a proper description for this function]
1567
1532
 
1568
1533
 
1569
1534
 
1535
+ ##### Returns
1570
1536
 
1571
- ##### Parameters
1572
1537
 
1573
- | Name | Type | Description | |
1574
- | ---- | ---- | ----------- | -------- |
1575
- | chartSettings | | Chart Settings for the Filter Builder | &nbsp; |
1576
- | scopes | | | &nbsp; |
1577
- | currentScope | | | &nbsp; |
1538
+ - `AbsoluteStatement`
1578
1539
 
1579
1540
 
1580
1541
 
1542
+ #### _resolveAsTheNext() *private method*
1581
1543
 
1582
- ##### Returns
1544
+ Apply 'the next' cursor logic to statement
1583
1545
 
1584
1546
 
1585
- -
1586
1547
 
1587
1548
 
1588
1549
 
1589
1550
 
1590
- ### dist/filters/helpers/getAvailableScopes.js
1551
+ ##### Returns
1591
1552
 
1592
1553
 
1593
- #### getAvailableScopes(config)
1554
+ - `AbsoluteStatement`
1594
1555
 
1595
- Gets Scopes/Scope IDs by given IDs
1556
+
1557
+
1558
+ #### replaceNowToken(value, now)
1559
+
1560
+ Replace '@now' token inside a string
1596
1561
 
1597
1562
 
1598
1563
 
@@ -1601,7 +1566,8 @@ Gets Scopes/Scope IDs by given IDs
1601
1566
 
1602
1567
  | Name | Type | Description | |
1603
1568
  | ---- | ---- | ----------- | -------- |
1604
- | config | | given Differnts IDs in order set a available scope | &nbsp; |
1569
+ | value | `string` | | &nbsp; |
1570
+ | now | `Date` | | &nbsp; |
1605
1571
 
1606
1572
 
1607
1573
 
@@ -1609,17 +1575,13 @@ Gets Scopes/Scope IDs by given IDs
1609
1575
  ##### Returns
1610
1576
 
1611
1577
 
1612
- - a Scopes/Scope IDs array
1613
-
1614
-
1615
-
1578
+ - `string`
1616
1579
 
1617
- ### dist/filters/helpers/getAvailableScopesIDsByConfig.js
1618
1580
 
1619
1581
 
1620
- #### getAvailableScopesIDsByConfig(config)
1582
+ #### convertRelativeToAbsolute(args)
1621
1583
 
1622
- Gets the Scopes IDS for the Available Scope function by any config
1584
+ Returns a range object (date) from a group of statement params
1623
1585
 
1624
1586
 
1625
1587
 
@@ -1628,25 +1590,45 @@ Gets the Scopes IDS for the Available Scope function by any config
1628
1590
 
1629
1591
  | Name | Type | Description | |
1630
1592
  | ---- | ---- | ----------- | -------- |
1631
- | config | | any config | &nbsp; |
1593
+ | args | `RelativeToAbsoluteStruct` | | &nbsp; |
1594
+
1632
1595
 
1633
1596
 
1634
1597
 
1598
+ ##### Examples
1599
+
1600
+ ```javascript
1601
+ pivot = '2021-03-03T12:30:40'
1602
+ unit = month
1603
+ steps = 2
1604
+ setTo = END
1605
+ resolverAsCalendar: true
1606
+ => Returns '2021-05-31T23:59:59'
1607
+ ```
1608
+ ```javascript
1609
+ pivot = '2021-03-03T12:30:40'
1610
+ unit = month
1611
+ steps = -2
1612
+ setTo = START
1613
+ resolverAsCalendar: false
1614
+ => Returns '2021-01-03T00:00:00'
1615
+ ```
1616
+
1635
1617
 
1636
1618
  ##### Returns
1637
1619
 
1638
1620
 
1639
- - a Available Scope IDS config
1621
+ - `string`
1640
1622
 
1641
1623
 
1642
1624
 
1643
1625
 
1644
- ### dist/filters/helpers/getScopesByHierarchy.js
1626
+ ### dist/dates/relative/relative.js
1645
1627
 
1646
1628
 
1647
- #### getScopesByHierarchy(scopes, currentScope)
1629
+ #### resolveRelative(statements, clock)
1648
1630
 
1649
- [TODO: Make a description for this]
1631
+ Resolve a list of relative statements according to operator
1650
1632
 
1651
1633
 
1652
1634
 
@@ -1655,16 +1637,34 @@ Gets the Scopes IDS for the Available Scope function by any config
1655
1637
 
1656
1638
  | Name | Type | Description | |
1657
1639
  | ---- | ---- | ----------- | -------- |
1658
- | scopes | | the collection of Scopes/Scope IDs | &nbsp; |
1659
- | currentScope | | Current scope type | &nbsp; |
1640
+ | statements | `Array.<RelativeStatement>` `Array.<string>` | - Raw statements/values | &nbsp; |
1641
+ | clock | `Date` | - Clock/time reference for relative date resolution | &nbsp; |
1642
+
1643
+
1660
1644
 
1661
1645
 
1646
+ ##### Examples
1647
+
1648
+ ```javascript
1649
+ Input:
1650
+ {
1651
+ "cursor": "the_next",
1652
+ "unit": "year",
1653
+ "number": 1,
1654
+ "includeCurrent": false,
1655
+ "isCalendarDate": false,
1656
+ "anchor": "03/05/2021"
1657
+ }
1658
+
1659
+ Output:
1660
+ { gte: "03/06/2021 00:00:00", lte: "03/05/2022 23:59:59" }
1661
+ ```
1662
1662
 
1663
1663
 
1664
1664
  ##### Returns
1665
1665
 
1666
1666
 
1667
- - A new array of Scopes/Scope IDs
1667
+ - `Array.&lt;AbsoluteRange&gt;` `Array.&lt;string&gt;`
1668
1668
 
1669
1669
 
1670
1670
 
@@ -2592,88 +2592,6 @@ serialize object to url param
2592
2592
 
2593
2593
 
2594
2594
 
2595
- ### dist/services/api/getAllQrveys.api.js
2596
-
2597
-
2598
- #### getAllQrveys(config, params)
2599
-
2600
- POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
2601
-
2602
-
2603
-
2604
-
2605
- ##### Parameters
2606
-
2607
- | Name | Type | Description | |
2608
- | ---- | ---- | ----------- | -------- |
2609
- | config | | Configuration | &nbsp; |
2610
- | params | | Object for getting precise data | &nbsp; |
2611
-
2612
-
2613
-
2614
-
2615
- ##### Returns
2616
-
2617
-
2618
- - `Void`
2619
-
2620
-
2621
-
2622
-
2623
- ### dist/services/api/getAllDatasets.api.js
2624
-
2625
-
2626
- #### getAllDatasets(qrveyids)
2627
-
2628
- Get a dataset list from a collection of Qrvey IDs
2629
-
2630
-
2631
-
2632
-
2633
- ##### Parameters
2634
-
2635
- | Name | Type | Description | |
2636
- | ---- | ---- | ----------- | -------- |
2637
- | qrveyids | | Collection of Qrvey IDs | &nbsp; |
2638
-
2639
-
2640
-
2641
-
2642
- ##### Returns
2643
-
2644
-
2645
- - a promise
2646
-
2647
-
2648
-
2649
-
2650
- ### dist/services/api/getDatasetColumns.api.js
2651
-
2652
-
2653
- #### getDatasetColumns(qrveyid)
2654
-
2655
- Get a dataset by Qrvey ID
2656
-
2657
-
2658
-
2659
-
2660
- ##### Parameters
2661
-
2662
- | Name | Type | Description | |
2663
- | ---- | ---- | ----------- | -------- |
2664
- | qrveyid | | The Qrvey ID | &nbsp; |
2665
-
2666
-
2667
-
2668
-
2669
- ##### Returns
2670
-
2671
-
2672
- - a promise
2673
-
2674
-
2675
-
2676
-
2677
2595
  ### dist/qrvey/helpers/getColumnsLabel.js
2678
2596
 
2679
2597
 
@@ -2785,12 +2703,12 @@ try to find this string as a variable on Windows object
2785
2703
 
2786
2704
 
2787
2705
 
2788
- ### dist/typescript/decorators/Debounce.js
2706
+ ### dist/services/api/getAllDatasets.api.js
2789
2707
 
2790
2708
 
2791
- #### Debounce(time)
2709
+ #### getAllDatasets(qrveyids)
2792
2710
 
2793
- (Method Decorator) Debounce Class Method
2711
+ Get a dataset list from a collection of Qrvey IDs
2794
2712
 
2795
2713
 
2796
2714
 
@@ -2799,7 +2717,7 @@ try to find this string as a variable on Windows object
2799
2717
 
2800
2718
  | Name | Type | Description | |
2801
2719
  | ---- | ---- | ----------- | -------- |
2802
- | time | | (optional) deafult 500 | &nbsp; |
2720
+ | qrveyids | | Collection of Qrvey IDs | &nbsp; |
2803
2721
 
2804
2722
 
2805
2723
 
@@ -2807,17 +2725,17 @@ try to find this string as a variable on Windows object
2807
2725
  ##### Returns
2808
2726
 
2809
2727
 
2810
- - `Void`
2728
+ - a promise
2811
2729
 
2812
2730
 
2813
2731
 
2814
2732
 
2815
- ### dist/typescript/decorators/Throttled.js
2733
+ ### dist/services/api/getAllQrveys.api.js
2816
2734
 
2817
2735
 
2818
- #### Throttled(time)
2736
+ #### getAllQrveys(config, params)
2819
2737
 
2820
- (Method Decorator) Throttled Class Method
2738
+ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
2821
2739
 
2822
2740
 
2823
2741
 
@@ -2826,7 +2744,8 @@ try to find this string as a variable on Windows object
2826
2744
 
2827
2745
  | Name | Type | Description | |
2828
2746
  | ---- | ---- | ----------- | -------- |
2829
- | time | | (optional) deafult 500 | &nbsp; |
2747
+ | config | | Configuration | &nbsp; |
2748
+ | params | | Object for getting precise data | &nbsp; |
2830
2749
 
2831
2750
 
2832
2751
 
@@ -2839,12 +2758,12 @@ try to find this string as a variable on Windows object
2839
2758
 
2840
2759
 
2841
2760
 
2842
- ### dist/dates/relative/helpers/formatStatement.js
2761
+ ### dist/services/api/getDatasetColumns.api.js
2843
2762
 
2844
2763
 
2845
- #### formatStatement(statement)
2764
+ #### getDatasetColumns(qrveyid)
2846
2765
 
2847
- Build a proper relative date statement type
2766
+ Get a dataset by Qrvey ID
2848
2767
 
2849
2768
 
2850
2769
 
@@ -2853,7 +2772,7 @@ Build a proper relative date statement type
2853
2772
 
2854
2773
  | Name | Type | Description | |
2855
2774
  | ---- | ---- | ----------- | -------- |
2856
- | statement | `RelativeStatement` | | &nbsp; |
2775
+ | qrveyid | | The Qrvey ID | &nbsp; |
2857
2776
 
2858
2777
 
2859
2778
 
@@ -2861,17 +2780,17 @@ Build a proper relative date statement type
2861
2780
  ##### Returns
2862
2781
 
2863
2782
 
2864
- - `RelativeStatement`
2783
+ - a promise
2865
2784
 
2866
2785
 
2867
2786
 
2868
2787
 
2869
- ### dist/dates/relative/helpers/getStatementCase.js
2788
+ ### dist/typescript/decorators/Debounce.js
2870
2789
 
2871
2790
 
2872
- #### getStatementCase(includeCurrent, isCalendarDate)
2791
+ #### Debounce(time)
2873
2792
 
2874
- Returns a number/constant that identifies a relative date case
2793
+ (Method Decorator) Debounce Class Method
2875
2794
 
2876
2795
 
2877
2796
 
@@ -2880,8 +2799,7 @@ Returns a number/constant that identifies a relative date case
2880
2799
 
2881
2800
  | Name | Type | Description | |
2882
2801
  | ---- | ---- | ----------- | -------- |
2883
- | includeCurrent | `boolean` | | &nbsp; |
2884
- | isCalendarDate | `boolean` | | &nbsp; |
2802
+ | time | | (optional) deafult 500 | &nbsp; |
2885
2803
 
2886
2804
 
2887
2805
 
@@ -2889,17 +2807,17 @@ Returns a number/constant that identifies a relative date case
2889
2807
  ##### Returns
2890
2808
 
2891
2809
 
2892
- - `number`
2810
+ - `Void`
2893
2811
 
2894
2812
 
2895
2813
 
2896
2814
 
2897
- ### dist/dates/relative/helpers/parseDate.js
2815
+ ### dist/typescript/decorators/Throttled.js
2898
2816
 
2899
2817
 
2900
- #### parseDate(date)
2818
+ #### Throttled(time)
2901
2819
 
2902
- Parses a string date and returns a dayjs date
2820
+ (Method Decorator) Throttled Class Method
2903
2821
 
2904
2822
 
2905
2823
 
@@ -2908,7 +2826,7 @@ Parses a string date and returns a dayjs date
2908
2826
 
2909
2827
  | Name | Type | Description | |
2910
2828
  | ---- | ---- | ----------- | -------- |
2911
- | date | `string` `Dayjs` `Date` | | &nbsp; |
2829
+ | time | | (optional) deafult 500 | &nbsp; |
2912
2830
 
2913
2831
 
2914
2832
 
@@ -2916,7 +2834,7 @@ Parses a string date and returns a dayjs date
2916
2834
  ##### Returns
2917
2835
 
2918
2836
 
2919
- - `Dayjs` A dayjs date
2837
+ - `Void`
2920
2838
 
2921
2839
 
2922
2840
 
@@ -4320,4 +4238,86 @@ Resolves conditions between UI flattened filter and given parameters
4320
4238
 
4321
4239
 
4322
4240
 
4241
+ ### dist/dates/relative/helpers/formatStatement.js
4242
+
4243
+
4244
+ #### formatStatement(statement)
4245
+
4246
+ Build a proper relative date statement type
4247
+
4248
+
4249
+
4250
+
4251
+ ##### Parameters
4252
+
4253
+ | Name | Type | Description | |
4254
+ | ---- | ---- | ----------- | -------- |
4255
+ | statement | `RelativeStatement` | | &nbsp; |
4256
+
4257
+
4258
+
4259
+
4260
+ ##### Returns
4261
+
4262
+
4263
+ - `RelativeStatement`
4264
+
4265
+
4266
+
4267
+
4268
+ ### dist/dates/relative/helpers/getStatementCase.js
4269
+
4270
+
4271
+ #### getStatementCase(includeCurrent, isCalendarDate)
4272
+
4273
+ Returns a number/constant that identifies a relative date case
4274
+
4275
+
4276
+
4277
+
4278
+ ##### Parameters
4279
+
4280
+ | Name | Type | Description | |
4281
+ | ---- | ---- | ----------- | -------- |
4282
+ | includeCurrent | `boolean` | | &nbsp; |
4283
+ | isCalendarDate | `boolean` | | &nbsp; |
4284
+
4285
+
4286
+
4287
+
4288
+ ##### Returns
4289
+
4290
+
4291
+ - `number`
4292
+
4293
+
4294
+
4295
+
4296
+ ### dist/dates/relative/helpers/parseDate.js
4297
+
4298
+
4299
+ #### parseDate(date)
4300
+
4301
+ Parses a string date and returns a dayjs date
4302
+
4303
+
4304
+
4305
+
4306
+ ##### Parameters
4307
+
4308
+ | Name | Type | Description | |
4309
+ | ---- | ---- | ----------- | -------- |
4310
+ | date | `string` `Dayjs` `Date` | | &nbsp; |
4311
+
4312
+
4313
+
4314
+
4315
+ ##### Returns
4316
+
4317
+
4318
+ - `Dayjs` A dayjs date
4319
+
4320
+
4321
+
4322
+
4323
4323
  *Documentation generated with [doxdox](https://github.com/neogeek/doxdox).*