@qrvey/utils 1.1.2-0 → 1.1.2-1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +534 -534
- package/dist/cjs/filters/adapters/adaptFilterData.js +1 -1
- package/dist/cjs/filters/adapters/logicToFlatUI.js +75 -63
- package/dist/filters/adapters/adaptFilterData.js +1 -1
- package/dist/filters/adapters/logicToFlatUI.js +77 -65
- package/package.json +1 -1
- package/src/filters/adapters/adaptFilterData.ts +1 -1
- package/src/filters/adapters/logicToFlatUI.ts +84 -70
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.1.2-
|
|
1
|
+
# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.1.2-1*
|
|
2
2
|
|
|
3
3
|
> Helper, Utils for all Qrvey Projects
|
|
4
4
|
|
|
@@ -107,12 +107,12 @@ Get a text and evaluate if it matchs with a token box label.
|
|
|
107
107
|
|
|
108
108
|
|
|
109
109
|
|
|
110
|
-
### dist/
|
|
110
|
+
### dist/date/range/getDateRange.js
|
|
111
111
|
|
|
112
112
|
|
|
113
|
-
####
|
|
113
|
+
#### getDateRange(value, dateGroupLabel, withTime)
|
|
114
114
|
|
|
115
|
-
|
|
115
|
+
Get date range object from a string date value
|
|
116
116
|
|
|
117
117
|
|
|
118
118
|
|
|
@@ -121,59 +121,74 @@ Generates a Flattened UI filter structure from Filter Data structure.
|
|
|
121
121
|
|
|
122
122
|
| Name | Type | Description | |
|
|
123
123
|
| ---- | ---- | ----------- | -------- |
|
|
124
|
-
|
|
|
125
|
-
|
|
|
126
|
-
|
|
124
|
+
| value | `String` | string date value | |
|
|
125
|
+
| dateGroupLabel | `String` | could be 'YEAR', 'QUARTER', 'MONTH' or 'DAY'. Deafult is 'DAY' | |
|
|
126
|
+
| withTime | `Boolean` | determines if the date range will include time. Default is true | |
|
|
127
127
|
|
|
128
128
|
|
|
129
129
|
|
|
130
|
-
##### Returns
|
|
131
130
|
|
|
131
|
+
##### Examples
|
|
132
132
|
|
|
133
|
-
|
|
133
|
+
```javascript
|
|
134
|
+
// 1) Year:
|
|
135
|
+
getDateRange('2020', 'YEAR');
|
|
136
|
+
// Will return:
|
|
137
|
+
{
|
|
138
|
+
from: '01/01/2020 00:00:00',
|
|
139
|
+
to: '12/31/2020 23:59:59'
|
|
140
|
+
}
|
|
134
141
|
|
|
142
|
+
// 2) Quarter:
|
|
143
|
+
getDateRange('Q3 2020', 'QUARTER');
|
|
144
|
+
// Will return:
|
|
145
|
+
{
|
|
146
|
+
from: '07/01/2020 00:00:00',
|
|
147
|
+
to: '09/30/2020 23:59:59'
|
|
148
|
+
}
|
|
135
149
|
|
|
150
|
+
// 3) Month:
|
|
151
|
+
getDateRange('Oct 2020', 'MONTH');
|
|
152
|
+
// Will return:
|
|
153
|
+
{
|
|
154
|
+
from: '10/01/2020 00:00:00',
|
|
155
|
+
to: '10/31/2020 23:59:59'
|
|
156
|
+
}
|
|
157
|
+
```
|
|
136
158
|
|
|
137
|
-
#### FD21ToFlatUI(scopes, datasetsInfo)
|
|
138
159
|
|
|
139
|
-
|
|
160
|
+
##### Returns
|
|
140
161
|
|
|
141
162
|
|
|
163
|
+
- `Object` an object with the date range with two string date properties: from and to
|
|
142
164
|
|
|
143
165
|
|
|
144
|
-
##### Parameters
|
|
145
166
|
|
|
146
|
-
| Name | Type | Description | |
|
|
147
|
-
| ---- | ---- | ----------- | -------- |
|
|
148
|
-
| scopes | | The filter scope section | |
|
|
149
|
-
| datasetsInfo | | Collection of datasets information | |
|
|
150
167
|
|
|
168
|
+
### dist/date/relative/Adapter.js
|
|
151
169
|
|
|
152
170
|
|
|
171
|
+
#### value()
|
|
153
172
|
|
|
154
|
-
|
|
173
|
+
Resolves statement and returns statement value
|
|
155
174
|
|
|
156
175
|
|
|
157
|
-
- a flattened UI filters array
|
|
158
176
|
|
|
159
177
|
|
|
160
178
|
|
|
161
179
|
|
|
162
|
-
|
|
180
|
+
##### Returns
|
|
163
181
|
|
|
164
182
|
|
|
165
|
-
|
|
183
|
+
- `AbsoluteRange` `string`
|
|
166
184
|
|
|
167
|
-
Generates a Filter Logic structure from Filter Data structure.
|
|
168
185
|
|
|
169
186
|
|
|
187
|
+
#### valueAsAnchor()
|
|
170
188
|
|
|
189
|
+
Resolves statement as an anchor
|
|
171
190
|
|
|
172
|
-
##### Parameters
|
|
173
191
|
|
|
174
|
-
| Name | Type | Description | |
|
|
175
|
-
| ---- | ---- | ----------- | -------- |
|
|
176
|
-
| filterData | | The filter data object. | |
|
|
177
192
|
|
|
178
193
|
|
|
179
194
|
|
|
@@ -181,22 +196,15 @@ Generates a Filter Logic structure from Filter Data structure.
|
|
|
181
196
|
##### Returns
|
|
182
197
|
|
|
183
198
|
|
|
184
|
-
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
#### getLogicBodyFromFD21(filterData)
|
|
199
|
+
- `string`
|
|
189
200
|
|
|
190
|
-
Gets the logic body
|
|
191
201
|
|
|
192
202
|
|
|
203
|
+
#### _statementToRange() *private method*
|
|
193
204
|
|
|
205
|
+
Convert verbal statement to range value
|
|
194
206
|
|
|
195
|
-
##### Parameters
|
|
196
207
|
|
|
197
|
-
| Name | Type | Description | |
|
|
198
|
-
| ---- | ---- | ----------- | -------- |
|
|
199
|
-
| filterData | | The filter data object | |
|
|
200
208
|
|
|
201
209
|
|
|
202
210
|
|
|
@@ -204,71 +212,61 @@ Gets the logic body
|
|
|
204
212
|
##### Returns
|
|
205
213
|
|
|
206
214
|
|
|
207
|
-
-
|
|
215
|
+
- `AbsoluteRange`
|
|
208
216
|
|
|
209
217
|
|
|
210
218
|
|
|
219
|
+
#### _resolveAsThis() *private method*
|
|
211
220
|
|
|
212
|
-
|
|
221
|
+
Apply 'this' cursor logic to statement
|
|
213
222
|
|
|
214
223
|
|
|
215
|
-
#### FDToUI(filterData, datasetsInfo)
|
|
216
224
|
|
|
217
|
-
Generates a UI filter structure from Filter Data structure.
|
|
218
225
|
|
|
219
226
|
|
|
220
227
|
|
|
228
|
+
##### Returns
|
|
221
229
|
|
|
222
|
-
##### Parameters
|
|
223
230
|
|
|
224
|
-
|
|
225
|
-
| ---- | ---- | ----------- | -------- |
|
|
226
|
-
| filterData | | The filter data object. | |
|
|
227
|
-
| datasetsInfo | | Collection of datasets information | |
|
|
231
|
+
- `AbsoluteStatement`
|
|
228
232
|
|
|
229
233
|
|
|
230
234
|
|
|
235
|
+
#### _resolveAsTheLast() *private method*
|
|
231
236
|
|
|
232
|
-
|
|
237
|
+
Apply 'the last' cursor logic to statement
|
|
233
238
|
|
|
234
239
|
|
|
235
|
-
- a UI Filters structure
|
|
236
240
|
|
|
237
241
|
|
|
238
242
|
|
|
239
|
-
#### FD21ToUI(scopes, section, version, datasetsInfo)
|
|
240
243
|
|
|
241
|
-
|
|
244
|
+
##### Returns
|
|
242
245
|
|
|
243
246
|
|
|
247
|
+
- `AbsoluteStatement`
|
|
244
248
|
|
|
245
249
|
|
|
246
|
-
##### Parameters
|
|
247
250
|
|
|
248
|
-
|
|
249
|
-
| ---- | ---- | ----------- | -------- |
|
|
250
|
-
| scopes | | The filter scope section | |
|
|
251
|
-
| section | | The filter section. | |
|
|
252
|
-
| version | | The version of the filter structure | |
|
|
253
|
-
| datasetsInfo | | Collection of datasets information | |
|
|
251
|
+
#### _resolveAsTheNext() *private method*
|
|
254
252
|
|
|
253
|
+
Apply 'the next' cursor logic to statement
|
|
255
254
|
|
|
256
255
|
|
|
257
256
|
|
|
258
|
-
##### Returns
|
|
259
257
|
|
|
260
258
|
|
|
261
|
-
- a UI filter Structure
|
|
262
259
|
|
|
260
|
+
##### Returns
|
|
263
261
|
|
|
264
262
|
|
|
263
|
+
- `AbsoluteStatement`
|
|
265
264
|
|
|
266
|
-
### dist/filters/adapters/UIToFD.js
|
|
267
265
|
|
|
268
266
|
|
|
269
|
-
####
|
|
267
|
+
#### replaceNowToken(value, now)
|
|
270
268
|
|
|
271
|
-
|
|
269
|
+
Replace '@now' token inside a string
|
|
272
270
|
|
|
273
271
|
|
|
274
272
|
|
|
@@ -277,7 +275,8 @@ Generates a Filter Data Structure structure from UI Filter Data structure.
|
|
|
277
275
|
|
|
278
276
|
| Name | Type | Description | |
|
|
279
277
|
| ---- | ---- | ----------- | -------- |
|
|
280
|
-
|
|
|
278
|
+
| value | `string` | | |
|
|
279
|
+
| now | `Date` | | |
|
|
281
280
|
|
|
282
281
|
|
|
283
282
|
|
|
@@ -285,13 +284,13 @@ Generates a Filter Data Structure structure from UI Filter Data structure.
|
|
|
285
284
|
##### Returns
|
|
286
285
|
|
|
287
286
|
|
|
288
|
-
-
|
|
287
|
+
- `string`
|
|
289
288
|
|
|
290
289
|
|
|
291
290
|
|
|
292
|
-
####
|
|
291
|
+
#### convertRelativeToAbsolute(args)
|
|
293
292
|
|
|
294
|
-
|
|
293
|
+
Returns a range object (date) from a group of statement params
|
|
295
294
|
|
|
296
295
|
|
|
297
296
|
|
|
@@ -300,26 +299,45 @@ Builds the Fitler Data structure from UI filter data
|
|
|
300
299
|
|
|
301
300
|
| Name | Type | Description | |
|
|
302
301
|
| ---- | ---- | ----------- | -------- |
|
|
303
|
-
|
|
|
304
|
-
| version | | the version of the structure | |
|
|
302
|
+
| args | `RelativeToAbsoluteStruct` | | |
|
|
305
303
|
|
|
306
304
|
|
|
307
305
|
|
|
308
306
|
|
|
307
|
+
##### Examples
|
|
308
|
+
|
|
309
|
+
```javascript
|
|
310
|
+
pivot = '2021-03-03T12:30:40'
|
|
311
|
+
unit = month
|
|
312
|
+
steps = 2
|
|
313
|
+
setTo = END
|
|
314
|
+
resolverAsCalendar: true
|
|
315
|
+
=> Returns '2021-05-31T23:59:59'
|
|
316
|
+
```
|
|
317
|
+
```javascript
|
|
318
|
+
pivot = '2021-03-03T12:30:40'
|
|
319
|
+
unit = month
|
|
320
|
+
steps = -2
|
|
321
|
+
setTo = START
|
|
322
|
+
resolverAsCalendar: false
|
|
323
|
+
=> Returns '2021-01-03T00:00:00'
|
|
324
|
+
```
|
|
325
|
+
|
|
326
|
+
|
|
309
327
|
##### Returns
|
|
310
328
|
|
|
311
329
|
|
|
312
|
-
-
|
|
330
|
+
- `string`
|
|
313
331
|
|
|
314
332
|
|
|
315
333
|
|
|
316
334
|
|
|
317
|
-
### dist/
|
|
335
|
+
### dist/date/relative/relative.js
|
|
318
336
|
|
|
319
337
|
|
|
320
|
-
####
|
|
338
|
+
#### resolveRelative(statements, clock)
|
|
321
339
|
|
|
322
|
-
|
|
340
|
+
Resolve a list of relative statements according to operator
|
|
323
341
|
|
|
324
342
|
|
|
325
343
|
|
|
@@ -328,22 +346,44 @@ Generates a Flattened UI filter structure from UI Filter Data structure.
|
|
|
328
346
|
|
|
329
347
|
| Name | Type | Description | |
|
|
330
348
|
| ---- | ---- | ----------- | -------- |
|
|
331
|
-
|
|
|
332
|
-
|
|
|
349
|
+
| statements | `Array.<RelativeStatement>` `Array.<string>` | - Raw statements/values | |
|
|
350
|
+
| clock | `Date` | - Clock/time reference for relative date resolution | |
|
|
333
351
|
|
|
334
352
|
|
|
335
353
|
|
|
336
354
|
|
|
355
|
+
##### Examples
|
|
356
|
+
|
|
357
|
+
```javascript
|
|
358
|
+
Input:
|
|
359
|
+
{
|
|
360
|
+
"cursor": "the_next",
|
|
361
|
+
"unit": "year",
|
|
362
|
+
"number": 1,
|
|
363
|
+
"includeCurrent": false,
|
|
364
|
+
"isCalendarDate": false,
|
|
365
|
+
"anchor": "03/05/2021"
|
|
366
|
+
}
|
|
367
|
+
|
|
368
|
+
Output:
|
|
369
|
+
{ gte: "03/06/2021 00:00:00", lte: "03/05/2022 23:59:59" }
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
|
|
337
373
|
##### Returns
|
|
338
374
|
|
|
339
375
|
|
|
340
|
-
-
|
|
376
|
+
- `Array.<AbsoluteRange>` `Array.<string>`
|
|
341
377
|
|
|
342
378
|
|
|
343
379
|
|
|
344
|
-
#### UI21ToFlatUI(scopes)
|
|
345
380
|
|
|
346
|
-
|
|
381
|
+
### dist/filters/adapters/FDToFlatUI.js
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
#### FDToFlatUI(filterData, datasetsInfo)
|
|
385
|
+
|
|
386
|
+
Generates a Flattened UI filter structure from Filter Data structure.
|
|
347
387
|
|
|
348
388
|
|
|
349
389
|
|
|
@@ -352,7 +392,8 @@ Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
|
|
|
352
392
|
|
|
353
393
|
| Name | Type | Description | |
|
|
354
394
|
| ---- | ---- | ----------- | -------- |
|
|
355
|
-
|
|
|
395
|
+
| filterData | | The filter data object. | |
|
|
396
|
+
| datasetsInfo | | Collection of datasets information | |
|
|
356
397
|
|
|
357
398
|
|
|
358
399
|
|
|
@@ -364,13 +405,9 @@ Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
|
|
|
364
405
|
|
|
365
406
|
|
|
366
407
|
|
|
408
|
+
#### FD21ToFlatUI(scopes, datasetsInfo)
|
|
367
409
|
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
#### adaptFilterData(filterData, getUIFilterData, datasetsInfo)
|
|
372
|
-
|
|
373
|
-
Checks and adapts the v2.0 Filter Data Structure to the v2.1
|
|
410
|
+
Generates a Filter Builder Structure from the Filter Data structure v2.1
|
|
374
411
|
|
|
375
412
|
|
|
376
413
|
|
|
@@ -379,9 +416,8 @@ Checks and adapts the v2.0 Filter Data Structure to the v2.1
|
|
|
379
416
|
|
|
380
417
|
| Name | Type | Description | |
|
|
381
418
|
| ---- | ---- | ----------- | -------- |
|
|
382
|
-
|
|
|
383
|
-
|
|
|
384
|
-
| datasetsInfo | | Collection of datasets information. If getUIFilterData is true, the datasetsInfo should be mandatory | |
|
|
419
|
+
| scopes | | The filter scope section | |
|
|
420
|
+
| datasetsInfo | | Collection of datasets information | |
|
|
385
421
|
|
|
386
422
|
|
|
387
423
|
|
|
@@ -389,17 +425,17 @@ Checks and adapts the v2.0 Filter Data Structure to the v2.1
|
|
|
389
425
|
##### Returns
|
|
390
426
|
|
|
391
427
|
|
|
392
|
-
-
|
|
428
|
+
- a flattened UI filters array
|
|
393
429
|
|
|
394
430
|
|
|
395
431
|
|
|
396
432
|
|
|
397
|
-
### dist/filters/adapters/
|
|
433
|
+
### dist/filters/adapters/FDToLogic.js
|
|
398
434
|
|
|
399
435
|
|
|
400
|
-
####
|
|
436
|
+
#### FDToLogic(filterData)
|
|
401
437
|
|
|
402
|
-
Generates a
|
|
438
|
+
Generates a Filter Logic structure from Filter Data structure.
|
|
403
439
|
|
|
404
440
|
|
|
405
441
|
|
|
@@ -408,8 +444,7 @@ Generates a filter data structure from the flatttened UI filters.
|
|
|
408
444
|
|
|
409
445
|
| Name | Type | Description | |
|
|
410
446
|
| ---- | ---- | ----------- | -------- |
|
|
411
|
-
|
|
|
412
|
-
| version | | Tag for the version of the filter data structure | |
|
|
447
|
+
| filterData | | The filter data object. | |
|
|
413
448
|
|
|
414
449
|
|
|
415
450
|
|
|
@@ -417,14 +452,13 @@ Generates a filter data structure from the flatttened UI filters.
|
|
|
417
452
|
##### Returns
|
|
418
453
|
|
|
419
454
|
|
|
420
|
-
- a
|
|
455
|
+
- a filter logic array
|
|
421
456
|
|
|
422
457
|
|
|
423
458
|
|
|
424
|
-
####
|
|
459
|
+
#### getLogicBodyFromFD21(filterData)
|
|
425
460
|
|
|
426
|
-
Gets
|
|
427
|
-
Also, adds and organizes filters by datasets
|
|
461
|
+
Gets the logic body
|
|
428
462
|
|
|
429
463
|
|
|
430
464
|
|
|
@@ -433,7 +467,7 @@ Also, adds and organizes filters by datasets
|
|
|
433
467
|
|
|
434
468
|
| Name | Type | Description | |
|
|
435
469
|
| ---- | ---- | ----------- | -------- |
|
|
436
|
-
|
|
|
470
|
+
| filterData | | The filter data object | |
|
|
437
471
|
|
|
438
472
|
|
|
439
473
|
|
|
@@ -441,13 +475,17 @@ Also, adds and organizes filters by datasets
|
|
|
441
475
|
##### Returns
|
|
442
476
|
|
|
443
477
|
|
|
444
|
-
-
|
|
478
|
+
- a filter logic array
|
|
445
479
|
|
|
446
480
|
|
|
447
481
|
|
|
448
|
-
#### buildScope(uFilter)
|
|
449
482
|
|
|
450
|
-
|
|
483
|
+
### dist/filters/adapters/FDToUI.js
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
#### FDToUI(filterData, datasetsInfo)
|
|
487
|
+
|
|
488
|
+
Generates a UI filter structure from Filter Data structure.
|
|
451
489
|
|
|
452
490
|
|
|
453
491
|
|
|
@@ -456,7 +494,8 @@ Gets an scope structure for the filter data
|
|
|
456
494
|
|
|
457
495
|
| Name | Type | Description | |
|
|
458
496
|
| ---- | ---- | ----------- | -------- |
|
|
459
|
-
|
|
|
497
|
+
| filterData | | The filter data object. | |
|
|
498
|
+
| datasetsInfo | | Collection of datasets information | |
|
|
460
499
|
|
|
461
500
|
|
|
462
501
|
|
|
@@ -464,13 +503,13 @@ Gets an scope structure for the filter data
|
|
|
464
503
|
##### Returns
|
|
465
504
|
|
|
466
505
|
|
|
467
|
-
-
|
|
506
|
+
- a UI Filters structure
|
|
468
507
|
|
|
469
508
|
|
|
470
509
|
|
|
471
|
-
####
|
|
510
|
+
#### FD21ToUI(scopes, section, version, datasetsInfo)
|
|
472
511
|
|
|
473
|
-
|
|
512
|
+
Generates a UI filter Structure from the Filter Data structure v2.1
|
|
474
513
|
|
|
475
514
|
|
|
476
515
|
|
|
@@ -479,7 +518,10 @@ Gets an dataset structure for the filter data
|
|
|
479
518
|
|
|
480
519
|
| Name | Type | Description | |
|
|
481
520
|
| ---- | ---- | ----------- | -------- |
|
|
482
|
-
|
|
|
521
|
+
| scopes | | The filter scope section | |
|
|
522
|
+
| section | | The filter section. | |
|
|
523
|
+
| version | | The version of the filter structure | |
|
|
524
|
+
| datasetsInfo | | Collection of datasets information | |
|
|
483
525
|
|
|
484
526
|
|
|
485
527
|
|
|
@@ -487,18 +529,247 @@ Gets an dataset structure for the filter data
|
|
|
487
529
|
##### Returns
|
|
488
530
|
|
|
489
531
|
|
|
490
|
-
-
|
|
532
|
+
- a UI filter Structure
|
|
491
533
|
|
|
492
534
|
|
|
493
535
|
|
|
494
|
-
#### buildFilter(uFilter)
|
|
495
536
|
|
|
496
|
-
|
|
537
|
+
### dist/filters/adapters/UIToFD.js
|
|
497
538
|
|
|
498
539
|
|
|
540
|
+
#### UIToFD(filterData)
|
|
499
541
|
|
|
542
|
+
Generates a Filter Data Structure structure from UI Filter Data structure.
|
|
500
543
|
|
|
501
|
-
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
##### Parameters
|
|
548
|
+
|
|
549
|
+
| Name | Type | Description | |
|
|
550
|
+
| ---- | ---- | ----------- | -------- |
|
|
551
|
+
| filterData | | The UI filter data object. | |
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
##### Returns
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
- a Filter Data structure
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
#### UI21ToFD(uFilterData, version)
|
|
564
|
+
|
|
565
|
+
Builds the Fitler Data structure from UI filter data
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
##### Parameters
|
|
571
|
+
|
|
572
|
+
| Name | Type | Description | |
|
|
573
|
+
| ---- | ---- | ----------- | -------- |
|
|
574
|
+
| uFilterData | | The UI filter Data object | |
|
|
575
|
+
| version | | the version of the structure | |
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
##### Returns
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
-
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
### dist/filters/adapters/UIToFlatUI.js
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
#### UIToFlatUI(filterData, datasetsInfo)
|
|
592
|
+
|
|
593
|
+
Generates a Flattened UI filter structure from UI Filter Data structure.
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
##### Parameters
|
|
599
|
+
|
|
600
|
+
| Name | Type | Description | |
|
|
601
|
+
| ---- | ---- | ----------- | -------- |
|
|
602
|
+
| filterData | | The UI filter data object. | |
|
|
603
|
+
| datasetsInfo | | Collection of datasets information. Optional for updating the datasets info | |
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
##### Returns
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
- a flattened UI filters array
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
#### UI21ToFlatUI(scopes)
|
|
616
|
+
|
|
617
|
+
Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
##### Parameters
|
|
623
|
+
|
|
624
|
+
| Name | Type | Description | |
|
|
625
|
+
| ---- | ---- | ----------- | -------- |
|
|
626
|
+
| scopes | | The filter scope section | |
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
##### Returns
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
- a flattened UI filters array
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
### dist/filters/adapters/adaptFilterData.js
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
#### adaptFilterData(filterData, getUIFilterData, datasetsInfo)
|
|
643
|
+
|
|
644
|
+
Checks and adapts the v2.0 Filter Data Structure to the v2.1
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
##### Parameters
|
|
650
|
+
|
|
651
|
+
| Name | Type | Description | |
|
|
652
|
+
| ---- | ---- | ----------- | -------- |
|
|
653
|
+
| filterData | | The filter data structure. Accepts both v2.1 or v2.0 | |
|
|
654
|
+
| getUIFilterData | | Flag to get a Filter Data (False) or the UI Filter Data (True) | |
|
|
655
|
+
| datasetsInfo | | Collection of datasets information. If getUIFilterData is true, the datasetsInfo should be mandatory | |
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
##### Returns
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
- A new filter data structure v2.1
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
### dist/filters/adapters/flatUIToFD.js
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
#### flatUIToFD(uFilters, version)
|
|
672
|
+
|
|
673
|
+
Generates a filter data structure from the flatttened UI filters.
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
##### Parameters
|
|
679
|
+
|
|
680
|
+
| Name | Type | Description | |
|
|
681
|
+
| ---- | ---- | ----------- | -------- |
|
|
682
|
+
| uFilters | | Array of flattened filters from UI | |
|
|
683
|
+
| version | | Tag for the version of the filter data structure | |
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
##### Returns
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
- a Filter Data.
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
#### buildScopes(fbFilters)
|
|
696
|
+
|
|
697
|
+
Gets an array of scopes structure for the filter data. The scopes is organized by scope types and scope IDs
|
|
698
|
+
Also, adds and organizes filters by datasets
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
##### Parameters
|
|
704
|
+
|
|
705
|
+
| Name | Type | Description | |
|
|
706
|
+
| ---- | ---- | ----------- | -------- |
|
|
707
|
+
| fbFilters | | Array of flat filters from UI | |
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
##### Returns
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
- an array of scopes structure.
|
|
716
|
+
|
|
717
|
+
|
|
718
|
+
|
|
719
|
+
#### buildScope(uFilter)
|
|
720
|
+
|
|
721
|
+
Gets an scope structure for the filter data
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
##### Parameters
|
|
727
|
+
|
|
728
|
+
| Name | Type | Description | |
|
|
729
|
+
| ---- | ---- | ----------- | -------- |
|
|
730
|
+
| uFilter | | UI structure filter | |
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
##### Returns
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
- an scope structure
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
#### buildDataset(uFilter)
|
|
743
|
+
|
|
744
|
+
Gets an dataset structure for the filter data
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
|
|
749
|
+
##### Parameters
|
|
750
|
+
|
|
751
|
+
| Name | Type | Description | |
|
|
752
|
+
| ---- | ---- | ----------- | -------- |
|
|
753
|
+
| uFilter | | a UI structure filter | |
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
##### Returns
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
- an dataset structure
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
#### buildFilter(uFilter)
|
|
766
|
+
|
|
767
|
+
Gets an filter structure for the filter data
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
##### Parameters
|
|
502
773
|
|
|
503
774
|
| Name | Type | Description | |
|
|
504
775
|
| ---- | ---- | ----------- | -------- |
|
|
@@ -1096,12 +1367,12 @@ Flat deeply an array
|
|
|
1096
1367
|
|
|
1097
1368
|
|
|
1098
1369
|
|
|
1099
|
-
### dist/general/array/
|
|
1370
|
+
### dist/general/array/getLastIndexFromArray.js
|
|
1100
1371
|
|
|
1101
1372
|
|
|
1102
|
-
####
|
|
1373
|
+
#### getLastIndexFromArray(array, callback)
|
|
1103
1374
|
|
|
1104
|
-
Gets the
|
|
1375
|
+
Gets the last index from the array by a callback condition
|
|
1105
1376
|
|
|
1106
1377
|
|
|
1107
1378
|
|
|
@@ -1119,17 +1390,17 @@ Gets the first index from the array by a callback condition
|
|
|
1119
1390
|
##### Returns
|
|
1120
1391
|
|
|
1121
1392
|
|
|
1122
|
-
- the
|
|
1393
|
+
- the last index of the array. -1 when the condition is not satisfied
|
|
1123
1394
|
|
|
1124
1395
|
|
|
1125
1396
|
|
|
1126
1397
|
|
|
1127
|
-
### dist/general/array/
|
|
1398
|
+
### dist/general/array/getFirstIndexFromArray.js
|
|
1128
1399
|
|
|
1129
1400
|
|
|
1130
|
-
####
|
|
1401
|
+
#### getFirstIndexFromArray(array, callback)
|
|
1131
1402
|
|
|
1132
|
-
Gets the
|
|
1403
|
+
Gets the first index from the array by a callback condition
|
|
1133
1404
|
|
|
1134
1405
|
|
|
1135
1406
|
|
|
@@ -1147,7 +1418,7 @@ Gets the last index from the array by a callback condition
|
|
|
1147
1418
|
##### Returns
|
|
1148
1419
|
|
|
1149
1420
|
|
|
1150
|
-
- the
|
|
1421
|
+
- the first index of the array. -1 when the condition is not satisfied
|
|
1151
1422
|
|
|
1152
1423
|
|
|
1153
1424
|
|
|
@@ -1321,13 +1592,12 @@ Validates if the given argument is empty
|
|
|
1321
1592
|
|
|
1322
1593
|
|
|
1323
1594
|
|
|
1324
|
-
### dist/general/mix/
|
|
1595
|
+
### dist/general/mix/randomId.js
|
|
1325
1596
|
|
|
1326
1597
|
|
|
1327
|
-
####
|
|
1598
|
+
#### randomId(length)
|
|
1328
1599
|
|
|
1329
|
-
|
|
1330
|
-
useful to avoid falsify validating Number Zero (0)
|
|
1600
|
+
create random unique string
|
|
1331
1601
|
|
|
1332
1602
|
|
|
1333
1603
|
|
|
@@ -1336,7 +1606,7 @@ useful to avoid falsify validating Number Zero (0)
|
|
|
1336
1606
|
|
|
1337
1607
|
| Name | Type | Description | |
|
|
1338
1608
|
| ---- | ---- | ----------- | -------- |
|
|
1339
|
-
|
|
|
1609
|
+
| length | `Number` | size of the generated string. Default 8 | |
|
|
1340
1610
|
|
|
1341
1611
|
|
|
1342
1612
|
|
|
@@ -1344,19 +1614,18 @@ useful to avoid falsify validating Number Zero (0)
|
|
|
1344
1614
|
##### Returns
|
|
1345
1615
|
|
|
1346
1616
|
|
|
1347
|
-
- `
|
|
1617
|
+
- `String`
|
|
1348
1618
|
|
|
1349
1619
|
|
|
1350
1620
|
|
|
1351
1621
|
|
|
1352
|
-
### dist/general/mix/
|
|
1622
|
+
### dist/general/mix/isNull.js
|
|
1353
1623
|
|
|
1354
1624
|
|
|
1355
|
-
####
|
|
1625
|
+
#### isNull(arg)
|
|
1356
1626
|
|
|
1357
|
-
|
|
1358
|
-
|
|
1359
|
-
For `null` or `undefined` argument the returned value will be 0.
|
|
1627
|
+
return if a given variable is either `null` or `undefined`
|
|
1628
|
+
useful to avoid falsify validating Number Zero (0)
|
|
1360
1629
|
|
|
1361
1630
|
|
|
1362
1631
|
|
|
@@ -1365,7 +1634,7 @@ For `null` or `undefined` argument the returned value will be 0.
|
|
|
1365
1634
|
|
|
1366
1635
|
| Name | Type | Description | |
|
|
1367
1636
|
| ---- | ---- | ----------- | -------- |
|
|
1368
|
-
|
|
|
1637
|
+
| arg | `any` | | |
|
|
1369
1638
|
|
|
1370
1639
|
|
|
1371
1640
|
|
|
@@ -1373,17 +1642,19 @@ For `null` or `undefined` argument the returned value will be 0.
|
|
|
1373
1642
|
##### Returns
|
|
1374
1643
|
|
|
1375
1644
|
|
|
1376
|
-
- `
|
|
1645
|
+
- `Boolean`
|
|
1377
1646
|
|
|
1378
1647
|
|
|
1379
1648
|
|
|
1380
1649
|
|
|
1381
|
-
### dist/general/mix/
|
|
1650
|
+
### dist/general/mix/size.js
|
|
1382
1651
|
|
|
1383
1652
|
|
|
1384
|
-
####
|
|
1653
|
+
#### size(obj)
|
|
1385
1654
|
|
|
1386
|
-
|
|
1655
|
+
get the length of an Array or String and also the number of first level attributes
|
|
1656
|
+
in an Object.
|
|
1657
|
+
For `null` or `undefined` argument the returned value will be 0.
|
|
1387
1658
|
|
|
1388
1659
|
|
|
1389
1660
|
|
|
@@ -1392,7 +1663,7 @@ create random unique string
|
|
|
1392
1663
|
|
|
1393
1664
|
| Name | Type | Description | |
|
|
1394
1665
|
| ---- | ---- | ----------- | -------- |
|
|
1395
|
-
|
|
|
1666
|
+
| obj | `Any` | | |
|
|
1396
1667
|
|
|
1397
1668
|
|
|
1398
1669
|
|
|
@@ -1400,17 +1671,18 @@ create random unique string
|
|
|
1400
1671
|
##### Returns
|
|
1401
1672
|
|
|
1402
1673
|
|
|
1403
|
-
- `
|
|
1674
|
+
- `Number`
|
|
1404
1675
|
|
|
1405
1676
|
|
|
1406
1677
|
|
|
1407
1678
|
|
|
1408
|
-
### dist/general/
|
|
1679
|
+
### dist/general/object/cloneDeep.js
|
|
1409
1680
|
|
|
1410
1681
|
|
|
1411
|
-
####
|
|
1682
|
+
#### cloneDeep(obj)
|
|
1412
1683
|
|
|
1413
|
-
|
|
1684
|
+
A simple Deep Cloning function. Valid only for primivite values and object with primitive values.
|
|
1685
|
+
Not to use this function with inner objects and functions
|
|
1414
1686
|
|
|
1415
1687
|
|
|
1416
1688
|
|
|
@@ -1419,7 +1691,7 @@ Upper case teh first letter of a given text
|
|
|
1419
1691
|
|
|
1420
1692
|
| Name | Type | Description | |
|
|
1421
1693
|
| ---- | ---- | ----------- | -------- |
|
|
1422
|
-
|
|
|
1694
|
+
| obj | | The object | |
|
|
1423
1695
|
|
|
1424
1696
|
|
|
1425
1697
|
|
|
@@ -1427,7 +1699,7 @@ Upper case teh first letter of a given text
|
|
|
1427
1699
|
##### Returns
|
|
1428
1700
|
|
|
1429
1701
|
|
|
1430
|
-
-
|
|
1702
|
+
- The new reference object or the given object if the parsing is incorrect or empty
|
|
1431
1703
|
|
|
1432
1704
|
|
|
1433
1705
|
|
|
@@ -1489,34 +1761,6 @@ _get({ item1: { item11: 'Hello Again' }, item2: {} }, ['item1', 'item11'])
|
|
|
1489
1761
|
|
|
1490
1762
|
|
|
1491
1763
|
|
|
1492
|
-
### dist/general/object/cloneDeep.js
|
|
1493
|
-
|
|
1494
|
-
|
|
1495
|
-
#### cloneDeep(obj)
|
|
1496
|
-
|
|
1497
|
-
A simple Deep Cloning function. Valid only for primivite values and object with primitive values.
|
|
1498
|
-
Not to use this function with inner objects and functions
|
|
1499
|
-
|
|
1500
|
-
|
|
1501
|
-
|
|
1502
|
-
|
|
1503
|
-
##### Parameters
|
|
1504
|
-
|
|
1505
|
-
| Name | Type | Description | |
|
|
1506
|
-
| ---- | ---- | ----------- | -------- |
|
|
1507
|
-
| obj | | The object | |
|
|
1508
|
-
|
|
1509
|
-
|
|
1510
|
-
|
|
1511
|
-
|
|
1512
|
-
##### Returns
|
|
1513
|
-
|
|
1514
|
-
|
|
1515
|
-
- The new reference object or the given object if the parsing is incorrect or empty
|
|
1516
|
-
|
|
1517
|
-
|
|
1518
|
-
|
|
1519
|
-
|
|
1520
1764
|
### dist/general/object/getAttribute.js
|
|
1521
1765
|
|
|
1522
1766
|
|
|
@@ -1620,13 +1864,12 @@ Checks if the given argument is an object type
|
|
|
1620
1864
|
|
|
1621
1865
|
|
|
1622
1866
|
|
|
1623
|
-
### dist/general/object/
|
|
1867
|
+
### dist/general/object/omit.js
|
|
1624
1868
|
|
|
1625
1869
|
|
|
1626
|
-
####
|
|
1870
|
+
#### omit(obj, props)
|
|
1627
1871
|
|
|
1628
|
-
|
|
1629
|
-
and return a mapped object
|
|
1872
|
+
return a nwe Object excluding attributes in _props_ list
|
|
1630
1873
|
|
|
1631
1874
|
|
|
1632
1875
|
|
|
@@ -1635,8 +1878,8 @@ and return a mapped object
|
|
|
1635
1878
|
|
|
1636
1879
|
| Name | Type | Description | |
|
|
1637
1880
|
| ---- | ---- | ----------- | -------- |
|
|
1638
|
-
|
|
|
1639
|
-
|
|
|
1881
|
+
| obj | `Object` | base object | |
|
|
1882
|
+
| props | `Array.<String>` | list of attribute to exclude | |
|
|
1640
1883
|
|
|
1641
1884
|
|
|
1642
1885
|
|
|
@@ -1644,17 +1887,18 @@ and return a mapped object
|
|
|
1644
1887
|
##### Returns
|
|
1645
1888
|
|
|
1646
1889
|
|
|
1647
|
-
- `Object`
|
|
1890
|
+
- `Object` clean object
|
|
1648
1891
|
|
|
1649
1892
|
|
|
1650
1893
|
|
|
1651
1894
|
|
|
1652
|
-
### dist/general/object/
|
|
1895
|
+
### dist/general/object/mapValues.js
|
|
1653
1896
|
|
|
1654
1897
|
|
|
1655
|
-
####
|
|
1898
|
+
#### mapValues(baseObject, iteratee)
|
|
1656
1899
|
|
|
1657
|
-
|
|
1900
|
+
Invoke iteratee (function) for each object key-value pair
|
|
1901
|
+
and return a mapped object
|
|
1658
1902
|
|
|
1659
1903
|
|
|
1660
1904
|
|
|
@@ -1663,8 +1907,8 @@ return a nwe Object excluding attributes in _props_ list
|
|
|
1663
1907
|
|
|
1664
1908
|
| Name | Type | Description | |
|
|
1665
1909
|
| ---- | ---- | ----------- | -------- |
|
|
1666
|
-
|
|
|
1667
|
-
|
|
|
1910
|
+
| baseObject | `Object` | Base object. | |
|
|
1911
|
+
| iteratee | `Function` | The executed per iteration. | |
|
|
1668
1912
|
|
|
1669
1913
|
|
|
1670
1914
|
|
|
@@ -1672,7 +1916,7 @@ return a nwe Object excluding attributes in _props_ list
|
|
|
1672
1916
|
##### Returns
|
|
1673
1917
|
|
|
1674
1918
|
|
|
1675
|
-
- `Object`
|
|
1919
|
+
- `Object` New mapped object.
|
|
1676
1920
|
|
|
1677
1921
|
|
|
1678
1922
|
|
|
@@ -1705,12 +1949,12 @@ return a new object just with attributes in _keys_ list
|
|
|
1705
1949
|
|
|
1706
1950
|
|
|
1707
1951
|
|
|
1708
|
-
### dist/
|
|
1952
|
+
### dist/general/string/capitalize.js
|
|
1709
1953
|
|
|
1710
1954
|
|
|
1711
|
-
####
|
|
1955
|
+
#### capitalize(text)
|
|
1712
1956
|
|
|
1713
|
-
|
|
1957
|
+
Upper case teh first letter of a given text
|
|
1714
1958
|
|
|
1715
1959
|
|
|
1716
1960
|
|
|
@@ -1719,122 +1963,7 @@ Get date range object from a string date value
|
|
|
1719
1963
|
|
|
1720
1964
|
| Name | Type | Description | |
|
|
1721
1965
|
| ---- | ---- | ----------- | -------- |
|
|
1722
|
-
|
|
|
1723
|
-
| dateGroupLabel | `String` | could be 'YEAR', 'QUARTER', 'MONTH' or 'DAY'. Deafult is 'DAY' | |
|
|
1724
|
-
| withTime | `Boolean` | determines if the date range will include time. Default is true | |
|
|
1725
|
-
|
|
1726
|
-
|
|
1727
|
-
|
|
1728
|
-
|
|
1729
|
-
##### Examples
|
|
1730
|
-
|
|
1731
|
-
```javascript
|
|
1732
|
-
// 1) Year:
|
|
1733
|
-
getDateRange('2020', 'YEAR');
|
|
1734
|
-
// Will return:
|
|
1735
|
-
{
|
|
1736
|
-
from: '01/01/2020 00:00:00',
|
|
1737
|
-
to: '12/31/2020 23:59:59'
|
|
1738
|
-
}
|
|
1739
|
-
|
|
1740
|
-
// 2) Quarter:
|
|
1741
|
-
getDateRange('Q3 2020', 'QUARTER');
|
|
1742
|
-
// Will return:
|
|
1743
|
-
{
|
|
1744
|
-
from: '07/01/2020 00:00:00',
|
|
1745
|
-
to: '09/30/2020 23:59:59'
|
|
1746
|
-
}
|
|
1747
|
-
|
|
1748
|
-
// 3) Month:
|
|
1749
|
-
getDateRange('Oct 2020', 'MONTH');
|
|
1750
|
-
// Will return:
|
|
1751
|
-
{
|
|
1752
|
-
from: '10/01/2020 00:00:00',
|
|
1753
|
-
to: '10/31/2020 23:59:59'
|
|
1754
|
-
}
|
|
1755
|
-
```
|
|
1756
|
-
|
|
1757
|
-
|
|
1758
|
-
##### Returns
|
|
1759
|
-
|
|
1760
|
-
|
|
1761
|
-
- `Object` an object with the date range with two string date properties: from and to
|
|
1762
|
-
|
|
1763
|
-
|
|
1764
|
-
|
|
1765
|
-
|
|
1766
|
-
### dist/date/relative/Adapter.js
|
|
1767
|
-
|
|
1768
|
-
|
|
1769
|
-
#### value()
|
|
1770
|
-
|
|
1771
|
-
Resolves statement and returns statement value
|
|
1772
|
-
|
|
1773
|
-
|
|
1774
|
-
|
|
1775
|
-
|
|
1776
|
-
|
|
1777
|
-
|
|
1778
|
-
##### Returns
|
|
1779
|
-
|
|
1780
|
-
|
|
1781
|
-
- `AbsoluteRange` `string`
|
|
1782
|
-
|
|
1783
|
-
|
|
1784
|
-
|
|
1785
|
-
#### valueAsAnchor()
|
|
1786
|
-
|
|
1787
|
-
Resolves statement as an anchor
|
|
1788
|
-
|
|
1789
|
-
|
|
1790
|
-
|
|
1791
|
-
|
|
1792
|
-
|
|
1793
|
-
|
|
1794
|
-
##### Returns
|
|
1795
|
-
|
|
1796
|
-
|
|
1797
|
-
- `string`
|
|
1798
|
-
|
|
1799
|
-
|
|
1800
|
-
|
|
1801
|
-
#### _statementToRange() *private method*
|
|
1802
|
-
|
|
1803
|
-
Convert verbal statement to range value
|
|
1804
|
-
|
|
1805
|
-
|
|
1806
|
-
|
|
1807
|
-
|
|
1808
|
-
|
|
1809
|
-
|
|
1810
|
-
##### Returns
|
|
1811
|
-
|
|
1812
|
-
|
|
1813
|
-
- `AbsoluteRange`
|
|
1814
|
-
|
|
1815
|
-
|
|
1816
|
-
|
|
1817
|
-
#### _resolveAsThis() *private method*
|
|
1818
|
-
|
|
1819
|
-
Apply 'this' cursor logic to statement
|
|
1820
|
-
|
|
1821
|
-
|
|
1822
|
-
|
|
1823
|
-
|
|
1824
|
-
|
|
1825
|
-
|
|
1826
|
-
##### Returns
|
|
1827
|
-
|
|
1828
|
-
|
|
1829
|
-
- `AbsoluteStatement`
|
|
1830
|
-
|
|
1831
|
-
|
|
1832
|
-
|
|
1833
|
-
#### _resolveAsTheLast() *private method*
|
|
1834
|
-
|
|
1835
|
-
Apply 'the last' cursor logic to statement
|
|
1836
|
-
|
|
1837
|
-
|
|
1966
|
+
| text | `String` | | |
|
|
1838
1967
|
|
|
1839
1968
|
|
|
1840
1969
|
|
|
@@ -1842,163 +1971,112 @@ Apply 'the last' cursor logic to statement
|
|
|
1842
1971
|
##### Returns
|
|
1843
1972
|
|
|
1844
1973
|
|
|
1845
|
-
- `
|
|
1846
|
-
|
|
1847
|
-
|
|
1848
|
-
|
|
1849
|
-
#### _resolveAsTheNext() *private method*
|
|
1850
|
-
|
|
1851
|
-
Apply 'the next' cursor logic to statement
|
|
1852
|
-
|
|
1853
|
-
|
|
1854
|
-
|
|
1855
|
-
|
|
1974
|
+
- `String`
|
|
1856
1975
|
|
|
1857
1976
|
|
|
1858
|
-
##### Returns
|
|
1859
1977
|
|
|
1860
1978
|
|
|
1861
|
-
|
|
1979
|
+
### dist/stencil/decorators/Config.js
|
|
1862
1980
|
|
|
1863
1981
|
|
|
1982
|
+
#### Config()
|
|
1864
1983
|
|
|
1865
|
-
|
|
1984
|
+
Stencil.js - Prop Decorator
|
|
1985
|
+
Get and Parse the Widget Configuration Object and also provide the ability to get properties in different case styles such as: lower, upper, camel and pascal
|
|
1986
|
+
But for this, is required ask for a property in `snake_case` style
|
|
1866
1987
|
|
|
1867
|
-
Replace '@now' token inside a string
|
|
1868
1988
|
|
|
1869
1989
|
|
|
1870
1990
|
|
|
1871
1991
|
|
|
1872
|
-
##### Parameters
|
|
1873
1992
|
|
|
1874
|
-
|
|
1875
|
-
| ---- | ---- | ----------- | -------- |
|
|
1876
|
-
| value | `string` | | |
|
|
1877
|
-
| now | `Date` | | |
|
|
1993
|
+
##### Examples
|
|
1878
1994
|
|
|
1995
|
+
```javascript
|
|
1996
|
+
\ @Config() @Prop() settings;
|
|
1879
1997
|
|
|
1998
|
+
someMethod() {
|
|
1999
|
+
this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
|
|
2000
|
+
}
|
|
2001
|
+
```
|
|
1880
2002
|
|
|
1881
2003
|
|
|
1882
2004
|
##### Returns
|
|
1883
2005
|
|
|
1884
2006
|
|
|
1885
|
-
- `
|
|
1886
|
-
|
|
1887
|
-
|
|
1888
|
-
|
|
1889
|
-
#### convertRelativeToAbsolute(args)
|
|
2007
|
+
- `Void`
|
|
1890
2008
|
|
|
1891
|
-
Returns a range object (date) from a group of statement params
|
|
1892
2009
|
|
|
1893
2010
|
|
|
1894
2011
|
|
|
2012
|
+
### dist/stencil/util/createRef.js
|
|
1895
2013
|
|
|
1896
|
-
##### Parameters
|
|
1897
2014
|
|
|
1898
|
-
|
|
1899
|
-
| ---- | ---- | ----------- | -------- |
|
|
1900
|
-
| args | `RelativeToAbsoluteStruct` | | |
|
|
2015
|
+
#### createRef()
|
|
1901
2016
|
|
|
2017
|
+
lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
|
|
1902
2018
|
|
|
1903
2019
|
|
|
1904
2020
|
|
|
1905
|
-
##### Examples
|
|
1906
2021
|
|
|
1907
|
-
```javascript
|
|
1908
|
-
pivot = '2021-03-03T12:30:40'
|
|
1909
|
-
unit = month
|
|
1910
|
-
steps = 2
|
|
1911
|
-
setTo = END
|
|
1912
|
-
resolverAsCalendar: true
|
|
1913
|
-
=> Returns '2021-05-31T23:59:59'
|
|
1914
|
-
```
|
|
1915
|
-
```javascript
|
|
1916
|
-
pivot = '2021-03-03T12:30:40'
|
|
1917
|
-
unit = month
|
|
1918
|
-
steps = -2
|
|
1919
|
-
setTo = START
|
|
1920
|
-
resolverAsCalendar: false
|
|
1921
|
-
=> Returns '2021-01-03T00:00:00'
|
|
1922
|
-
```
|
|
1923
2022
|
|
|
1924
2023
|
|
|
1925
2024
|
##### Returns
|
|
1926
2025
|
|
|
1927
2026
|
|
|
1928
|
-
-
|
|
1929
|
-
|
|
1930
|
-
|
|
2027
|
+
- function - Function to use in ref prop in html elements
|
|
1931
2028
|
|
|
1932
2029
|
|
|
1933
|
-
### dist/date/relative/relative.js
|
|
1934
2030
|
|
|
1935
2031
|
|
|
1936
|
-
|
|
1937
|
-
|
|
1938
|
-
Resolve a list of relative statements according to operator
|
|
1939
|
-
|
|
2032
|
+
### dist/stencil/util/getConfig.js
|
|
1940
2033
|
|
|
1941
2034
|
|
|
2035
|
+
#### getConfig(cfg)
|
|
1942
2036
|
|
|
1943
|
-
|
|
2037
|
+
verify the Config object type and try to return a parsed Object
|
|
2038
|
+
- In case _cfg_ is a string, first try to make a JSON parse in other case
|
|
2039
|
+
try to find this string as a variable on Windows object
|
|
2040
|
+
- If _cfg_ is a fuction, tis is invoked and parsed
|
|
2041
|
+
- Finally, if is an object, _cfg_ is inmediatly returned
|
|
1944
2042
|
|
|
1945
|
-
| Name | Type | Description | |
|
|
1946
|
-
| ---- | ---- | ----------- | -------- |
|
|
1947
|
-
| statements | `Array.<RelativeStatement>` `Array.<string>` | - Raw statements/values | |
|
|
1948
|
-
| clock | `Date` | - Clock/time reference for relative date resolution | |
|
|
1949
2043
|
|
|
1950
2044
|
|
|
1951
2045
|
|
|
2046
|
+
##### Parameters
|
|
1952
2047
|
|
|
1953
|
-
|
|
2048
|
+
| Name | Type | Description | |
|
|
2049
|
+
| ---- | ---- | ----------- | -------- |
|
|
2050
|
+
| cfg | | | |
|
|
1954
2051
|
|
|
1955
|
-
```javascript
|
|
1956
|
-
Input:
|
|
1957
|
-
{
|
|
1958
|
-
"cursor": "the_next",
|
|
1959
|
-
"unit": "year",
|
|
1960
|
-
"number": 1,
|
|
1961
|
-
"includeCurrent": false,
|
|
1962
|
-
"isCalendarDate": false,
|
|
1963
|
-
"anchor": "03/05/2021"
|
|
1964
|
-
}
|
|
1965
2052
|
|
|
1966
|
-
Output:
|
|
1967
|
-
{ gte: "03/06/2021 00:00:00", lte: "03/05/2022 23:59:59" }
|
|
1968
|
-
```
|
|
1969
2053
|
|
|
1970
2054
|
|
|
1971
2055
|
##### Returns
|
|
1972
2056
|
|
|
1973
2057
|
|
|
1974
|
-
- `
|
|
1975
|
-
|
|
2058
|
+
- `Void`
|
|
1976
2059
|
|
|
1977
2060
|
|
|
1978
2061
|
|
|
1979
|
-
### dist/stencil/decorators/Config.js
|
|
1980
2062
|
|
|
2063
|
+
### dist/typescript/decorators/Throttled.js
|
|
1981
2064
|
|
|
1982
|
-
#### Config()
|
|
1983
2065
|
|
|
1984
|
-
|
|
1985
|
-
Get and Parse the Widget Configuration Object and also provide the ability to get properties in different case styles such as: lower, upper, camel and pascal
|
|
1986
|
-
But for this, is required ask for a property in `snake_case` style
|
|
2066
|
+
#### Throttled(time)
|
|
1987
2067
|
|
|
2068
|
+
(Method Decorator) Throttled Class Method
|
|
1988
2069
|
|
|
1989
2070
|
|
|
1990
2071
|
|
|
1991
2072
|
|
|
2073
|
+
##### Parameters
|
|
1992
2074
|
|
|
1993
|
-
|
|
2075
|
+
| Name | Type | Description | |
|
|
2076
|
+
| ---- | ---- | ----------- | -------- |
|
|
2077
|
+
| time | | (optional) deafult 500 | |
|
|
1994
2078
|
|
|
1995
|
-
```javascript
|
|
1996
|
-
\ @Config() @Prop() settings;
|
|
1997
2079
|
|
|
1998
|
-
someMethod() {
|
|
1999
|
-
this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
|
|
2000
|
-
}
|
|
2001
|
-
```
|
|
2002
2080
|
|
|
2003
2081
|
|
|
2004
2082
|
##### Returns
|
|
@@ -2009,16 +2087,12 @@ someMethod() {
|
|
|
2009
2087
|
|
|
2010
2088
|
|
|
2011
2089
|
|
|
2012
|
-
### dist/
|
|
2090
|
+
### dist/typescript/decorators/Debounce.js
|
|
2013
2091
|
|
|
2014
2092
|
|
|
2015
|
-
####
|
|
2093
|
+
#### Debounce(time)
|
|
2016
2094
|
|
|
2017
|
-
|
|
2018
|
-
- In case _cfg_ is a string, first try to make a JSON parse in other case
|
|
2019
|
-
try to find this string as a variable on Windows object
|
|
2020
|
-
- If _cfg_ is a fuction, tis is invoked and parsed
|
|
2021
|
-
- Finally, if is an object, _cfg_ is inmediatly returned
|
|
2095
|
+
(Method Decorator) Debounce Class Method
|
|
2022
2096
|
|
|
2023
2097
|
|
|
2024
2098
|
|
|
@@ -2027,7 +2101,7 @@ try to find this string as a variable on Windows object
|
|
|
2027
2101
|
|
|
2028
2102
|
| Name | Type | Description | |
|
|
2029
2103
|
| ---- | ---- | ----------- | -------- |
|
|
2030
|
-
|
|
|
2104
|
+
| time | | (optional) deafult 500 | |
|
|
2031
2105
|
|
|
2032
2106
|
|
|
2033
2107
|
|
|
@@ -2040,14 +2114,21 @@ try to find this string as a variable on Windows object
|
|
|
2040
2114
|
|
|
2041
2115
|
|
|
2042
2116
|
|
|
2043
|
-
### dist/
|
|
2117
|
+
### dist/date/relative/helpers/formatStatement.js
|
|
2044
2118
|
|
|
2045
2119
|
|
|
2046
|
-
####
|
|
2120
|
+
#### formatStatement(statement)
|
|
2121
|
+
|
|
2122
|
+
Build a proper relative date statement type
|
|
2123
|
+
|
|
2047
2124
|
|
|
2048
|
-
lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
|
|
2049
2125
|
|
|
2050
2126
|
|
|
2127
|
+
##### Parameters
|
|
2128
|
+
|
|
2129
|
+
| Name | Type | Description | |
|
|
2130
|
+
| ---- | ---- | ----------- | -------- |
|
|
2131
|
+
| statement | `RelativeStatement` | | |
|
|
2051
2132
|
|
|
2052
2133
|
|
|
2053
2134
|
|
|
@@ -2055,17 +2136,17 @@ lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom
|
|
|
2055
2136
|
##### Returns
|
|
2056
2137
|
|
|
2057
2138
|
|
|
2058
|
-
-
|
|
2139
|
+
- `RelativeStatement`
|
|
2059
2140
|
|
|
2060
2141
|
|
|
2061
2142
|
|
|
2062
2143
|
|
|
2063
|
-
### dist/
|
|
2144
|
+
### dist/date/relative/helpers/getStatementCase.js
|
|
2064
2145
|
|
|
2065
2146
|
|
|
2066
|
-
####
|
|
2147
|
+
#### getStatementCase(includeCurrent, isCalendarDate)
|
|
2067
2148
|
|
|
2068
|
-
|
|
2149
|
+
Returns a number/constant that identifies a relative date case
|
|
2069
2150
|
|
|
2070
2151
|
|
|
2071
2152
|
|
|
@@ -2074,7 +2155,8 @@ lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom
|
|
|
2074
2155
|
|
|
2075
2156
|
| Name | Type | Description | |
|
|
2076
2157
|
| ---- | ---- | ----------- | -------- |
|
|
2077
|
-
|
|
|
2158
|
+
| includeCurrent | `boolean` | | |
|
|
2159
|
+
| isCalendarDate | `boolean` | | |
|
|
2078
2160
|
|
|
2079
2161
|
|
|
2080
2162
|
|
|
@@ -2082,17 +2164,17 @@ lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom
|
|
|
2082
2164
|
##### Returns
|
|
2083
2165
|
|
|
2084
2166
|
|
|
2085
|
-
- `
|
|
2167
|
+
- `number`
|
|
2086
2168
|
|
|
2087
2169
|
|
|
2088
2170
|
|
|
2089
2171
|
|
|
2090
|
-
### dist/
|
|
2172
|
+
### dist/date/relative/helpers/parseDate.js
|
|
2091
2173
|
|
|
2092
2174
|
|
|
2093
|
-
####
|
|
2175
|
+
#### parseDate(date)
|
|
2094
2176
|
|
|
2095
|
-
|
|
2177
|
+
Parses a string date and returns a dayjs date
|
|
2096
2178
|
|
|
2097
2179
|
|
|
2098
2180
|
|
|
@@ -2101,7 +2183,7 @@ lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom
|
|
|
2101
2183
|
|
|
2102
2184
|
| Name | Type | Description | |
|
|
2103
2185
|
| ---- | ---- | ----------- | -------- |
|
|
2104
|
-
|
|
|
2186
|
+
| date | `string` `Dayjs` `Date` | | |
|
|
2105
2187
|
|
|
2106
2188
|
|
|
2107
2189
|
|
|
@@ -2109,7 +2191,7 @@ lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom
|
|
|
2109
2191
|
##### Returns
|
|
2110
2192
|
|
|
2111
2193
|
|
|
2112
|
-
- `
|
|
2194
|
+
- `Dayjs` A dayjs date
|
|
2113
2195
|
|
|
2114
2196
|
|
|
2115
2197
|
|
|
@@ -2437,12 +2519,12 @@ Returns a filter builder config object by a any given config
|
|
|
2437
2519
|
|
|
2438
2520
|
|
|
2439
2521
|
|
|
2440
|
-
### dist/filters/helpers/common/
|
|
2522
|
+
### dist/filters/helpers/common/areFiltersEquals.js
|
|
2441
2523
|
|
|
2442
2524
|
|
|
2443
|
-
####
|
|
2525
|
+
#### areFiltersEquals(filter1, filter2)
|
|
2444
2526
|
|
|
2445
|
-
|
|
2527
|
+
Validates if both filters are the same
|
|
2446
2528
|
|
|
2447
2529
|
|
|
2448
2530
|
|
|
@@ -2451,8 +2533,8 @@ Determines if the filter column and property is a distinct group dates type
|
|
|
2451
2533
|
|
|
2452
2534
|
| Name | Type | Description | |
|
|
2453
2535
|
| ---- | ---- | ----------- | -------- |
|
|
2454
|
-
|
|
|
2455
|
-
|
|
|
2536
|
+
| filter1 | | filter 1 | |
|
|
2537
|
+
| filter2 | | filter 2 | |
|
|
2456
2538
|
|
|
2457
2539
|
|
|
2458
2540
|
|
|
@@ -2460,17 +2542,17 @@ Determines if the filter column and property is a distinct group dates type
|
|
|
2460
2542
|
##### Returns
|
|
2461
2543
|
|
|
2462
2544
|
|
|
2463
|
-
-
|
|
2545
|
+
- true: the filters are equal; false: the filters are NOT equal
|
|
2464
2546
|
|
|
2465
2547
|
|
|
2466
2548
|
|
|
2467
2549
|
|
|
2468
|
-
### dist/filters/helpers/common/
|
|
2550
|
+
### dist/filters/helpers/common/arePropertiesDateP.js
|
|
2469
2551
|
|
|
2470
2552
|
|
|
2471
|
-
####
|
|
2553
|
+
#### arePropertiesDateP(column, property)
|
|
2472
2554
|
|
|
2473
|
-
|
|
2555
|
+
Determines if the filter column and property is a distinct group dates type
|
|
2474
2556
|
|
|
2475
2557
|
|
|
2476
2558
|
|
|
@@ -2479,8 +2561,8 @@ Validates if both filters are the same
|
|
|
2479
2561
|
|
|
2480
2562
|
| Name | Type | Description | |
|
|
2481
2563
|
| ---- | ---- | ----------- | -------- |
|
|
2482
|
-
|
|
|
2483
|
-
|
|
|
2564
|
+
| column | | The filter column | |
|
|
2565
|
+
| property | | The filter property | |
|
|
2484
2566
|
|
|
2485
2567
|
|
|
2486
2568
|
|
|
@@ -2488,7 +2570,7 @@ Validates if both filters are the same
|
|
|
2488
2570
|
##### Returns
|
|
2489
2571
|
|
|
2490
2572
|
|
|
2491
|
-
-
|
|
2573
|
+
- True if the given property is included from distinct group dates type
|
|
2492
2574
|
|
|
2493
2575
|
|
|
2494
2576
|
|
|
@@ -2585,12 +2667,12 @@ Excludes and returns a filter data without filters by the given scopes
|
|
|
2585
2667
|
|
|
2586
2668
|
|
|
2587
2669
|
|
|
2588
|
-
### dist/filters/helpers/common/
|
|
2670
|
+
### dist/filters/helpers/common/getFilterLabel.js
|
|
2589
2671
|
|
|
2590
2672
|
|
|
2591
|
-
####
|
|
2673
|
+
#### getFilterLabel(filter)
|
|
2592
2674
|
|
|
2593
|
-
|
|
2675
|
+
Gets the Filter Label + Column label
|
|
2594
2676
|
|
|
2595
2677
|
|
|
2596
2678
|
|
|
@@ -2599,7 +2681,7 @@ Get an string of the properties of the given filter column.
|
|
|
2599
2681
|
|
|
2600
2682
|
| Name | Type | Description | |
|
|
2601
2683
|
| ---- | ---- | ----------- | -------- |
|
|
2602
|
-
|
|
|
2684
|
+
| filter | | the UI filter | |
|
|
2603
2685
|
|
|
2604
2686
|
|
|
2605
2687
|
|
|
@@ -2607,17 +2689,17 @@ Get an string of the properties of the given filter column.
|
|
|
2607
2689
|
##### Returns
|
|
2608
2690
|
|
|
2609
2691
|
|
|
2610
|
-
-
|
|
2692
|
+
- a sring label
|
|
2611
2693
|
|
|
2612
2694
|
|
|
2613
2695
|
|
|
2614
2696
|
|
|
2615
|
-
### dist/filters/helpers/common/
|
|
2697
|
+
### dist/filters/helpers/common/getFilterColumnLabel.js
|
|
2616
2698
|
|
|
2617
2699
|
|
|
2618
|
-
####
|
|
2700
|
+
#### getFilterColumnLabel(column)
|
|
2619
2701
|
|
|
2620
|
-
|
|
2702
|
+
Get an string of the properties of the given filter column.
|
|
2621
2703
|
|
|
2622
2704
|
|
|
2623
2705
|
|
|
@@ -2626,7 +2708,7 @@ Gets the Filter Label + Column label
|
|
|
2626
2708
|
|
|
2627
2709
|
| Name | Type | Description | |
|
|
2628
2710
|
| ---- | ---- | ----------- | -------- |
|
|
2629
|
-
|
|
|
2711
|
+
| column | | The filter column | |
|
|
2630
2712
|
|
|
2631
2713
|
|
|
2632
2714
|
|
|
@@ -2634,7 +2716,7 @@ Gets the Filter Label + Column label
|
|
|
2634
2716
|
##### Returns
|
|
2635
2717
|
|
|
2636
2718
|
|
|
2637
|
-
-
|
|
2719
|
+
- an string with the property, aggregate or calculation label.
|
|
2638
2720
|
|
|
2639
2721
|
|
|
2640
2722
|
|
|
@@ -2769,12 +2851,12 @@ Filters and gets a Filter Data by the given scopes
|
|
|
2769
2851
|
|
|
2770
2852
|
|
|
2771
2853
|
|
|
2772
|
-
### dist/filters/helpers/common/
|
|
2854
|
+
### dist/filters/helpers/common/getFiltersByVisibility.js
|
|
2773
2855
|
|
|
2774
2856
|
|
|
2775
|
-
####
|
|
2857
|
+
#### getFiltersByVisibility(filterData, scopes)
|
|
2776
2858
|
|
|
2777
|
-
|
|
2859
|
+
Get a new Filter Data by filtering scopes/scope IDs and enabled flags
|
|
2778
2860
|
|
|
2779
2861
|
|
|
2780
2862
|
|
|
@@ -2783,8 +2865,8 @@ Gets filters from Filter Data by Scopes/Scope IDs.
|
|
|
2783
2865
|
|
|
2784
2866
|
| Name | Type | Description | |
|
|
2785
2867
|
| ---- | ---- | ----------- | -------- |
|
|
2786
|
-
| filterData | |
|
|
2787
|
-
| scopes | |
|
|
2868
|
+
| filterData | | a Filter Data or UI Filter Data | |
|
|
2869
|
+
| scopes | | a Scopes/Scope IDs array | |
|
|
2788
2870
|
|
|
2789
2871
|
|
|
2790
2872
|
|
|
@@ -2824,12 +2906,12 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
|
|
|
2824
2906
|
|
|
2825
2907
|
|
|
2826
2908
|
|
|
2827
|
-
### dist/filters/helpers/common/
|
|
2909
|
+
### dist/filters/helpers/common/getFiltersByScopesIds.js
|
|
2828
2910
|
|
|
2829
2911
|
|
|
2830
|
-
####
|
|
2912
|
+
#### getFiltersByScopesIds(filterData, scopes)
|
|
2831
2913
|
|
|
2832
|
-
|
|
2914
|
+
Gets filters from Filter Data by Scopes/Scope IDs.
|
|
2833
2915
|
|
|
2834
2916
|
|
|
2835
2917
|
|
|
@@ -2838,8 +2920,8 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
|
|
|
2838
2920
|
|
|
2839
2921
|
| Name | Type | Description | |
|
|
2840
2922
|
| ---- | ---- | ----------- | -------- |
|
|
2841
|
-
| filterData | |
|
|
2842
|
-
| scopes | |
|
|
2923
|
+
| filterData | | The filter data | |
|
|
2924
|
+
| scopes | | The collection of Scopes/Scope IDs | |
|
|
2843
2925
|
|
|
2844
2926
|
|
|
2845
2927
|
|
|
@@ -3261,12 +3343,12 @@ Resolves the conditions by given params
|
|
|
3261
3343
|
|
|
3262
3344
|
|
|
3263
3345
|
|
|
3264
|
-
### dist/filters/helpers/ui/
|
|
3346
|
+
### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
|
|
3265
3347
|
|
|
3266
3348
|
|
|
3267
|
-
####
|
|
3349
|
+
#### excludeUIFlatFiltersByScopes(uFilters, scopes)
|
|
3268
3350
|
|
|
3269
|
-
Excludes
|
|
3351
|
+
Excludes and returns a UI Flat Filters without filters by the given scopes
|
|
3270
3352
|
|
|
3271
3353
|
|
|
3272
3354
|
|
|
@@ -3275,7 +3357,8 @@ Excludes Aggregate Filters in the Flattened UI Filters array
|
|
|
3275
3357
|
|
|
3276
3358
|
| Name | Type | Description | |
|
|
3277
3359
|
| ---- | ---- | ----------- | -------- |
|
|
3278
|
-
| uFilters | |
|
|
3360
|
+
| uFilters | | The Flatten UI Filters | |
|
|
3361
|
+
| scopes | | collection of scopes types | |
|
|
3279
3362
|
|
|
3280
3363
|
|
|
3281
3364
|
|
|
@@ -3283,17 +3366,17 @@ Excludes Aggregate Filters in the Flattened UI Filters array
|
|
|
3283
3366
|
##### Returns
|
|
3284
3367
|
|
|
3285
3368
|
|
|
3286
|
-
-
|
|
3369
|
+
- The new array of UI Flattened filters
|
|
3287
3370
|
|
|
3288
3371
|
|
|
3289
3372
|
|
|
3290
3373
|
|
|
3291
|
-
### dist/filters/helpers/ui/
|
|
3374
|
+
### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
|
|
3292
3375
|
|
|
3293
3376
|
|
|
3294
|
-
####
|
|
3377
|
+
#### excludeUIFiltersByAggregate(uFilters)
|
|
3295
3378
|
|
|
3296
|
-
Excludes
|
|
3379
|
+
Excludes Aggregate Filters in the Flattened UI Filters array
|
|
3297
3380
|
|
|
3298
3381
|
|
|
3299
3382
|
|
|
@@ -3302,8 +3385,7 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
|
|
|
3302
3385
|
|
|
3303
3386
|
| Name | Type | Description | |
|
|
3304
3387
|
| ---- | ---- | ----------- | -------- |
|
|
3305
|
-
| uFilters | |
|
|
3306
|
-
| scopes | | collection of scopes types | |
|
|
3388
|
+
| uFilters | | Collection of Flat UI Filters | |
|
|
3307
3389
|
|
|
3308
3390
|
|
|
3309
3391
|
|
|
@@ -3311,7 +3393,7 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
|
|
|
3311
3393
|
##### Returns
|
|
3312
3394
|
|
|
3313
3395
|
|
|
3314
|
-
-
|
|
3396
|
+
- a new Flat UI Filters that were excluded the aggregate filters
|
|
3315
3397
|
|
|
3316
3398
|
|
|
3317
3399
|
|
|
@@ -3457,86 +3539,4 @@ Resolves conditions between UI flattened filter and given parameters
|
|
|
3457
3539
|
|
|
3458
3540
|
|
|
3459
3541
|
|
|
3460
|
-
### dist/date/relative/helpers/formatStatement.js
|
|
3461
|
-
|
|
3462
|
-
|
|
3463
|
-
#### formatStatement(statement)
|
|
3464
|
-
|
|
3465
|
-
Build a proper relative date statement type
|
|
3466
|
-
|
|
3467
|
-
|
|
3468
|
-
|
|
3469
|
-
|
|
3470
|
-
##### Parameters
|
|
3471
|
-
|
|
3472
|
-
| Name | Type | Description | |
|
|
3473
|
-
| ---- | ---- | ----------- | -------- |
|
|
3474
|
-
| statement | `RelativeStatement` | | |
|
|
3475
|
-
|
|
3476
|
-
|
|
3477
|
-
|
|
3478
|
-
|
|
3479
|
-
##### Returns
|
|
3480
|
-
|
|
3481
|
-
|
|
3482
|
-
- `RelativeStatement`
|
|
3483
|
-
|
|
3484
|
-
|
|
3485
|
-
|
|
3486
|
-
|
|
3487
|
-
### dist/date/relative/helpers/getStatementCase.js
|
|
3488
|
-
|
|
3489
|
-
|
|
3490
|
-
#### getStatementCase(includeCurrent, isCalendarDate)
|
|
3491
|
-
|
|
3492
|
-
Returns a number/constant that identifies a relative date case
|
|
3493
|
-
|
|
3494
|
-
|
|
3495
|
-
|
|
3496
|
-
|
|
3497
|
-
##### Parameters
|
|
3498
|
-
|
|
3499
|
-
| Name | Type | Description | |
|
|
3500
|
-
| ---- | ---- | ----------- | -------- |
|
|
3501
|
-
| includeCurrent | `boolean` | | |
|
|
3502
|
-
| isCalendarDate | `boolean` | | |
|
|
3503
|
-
|
|
3504
|
-
|
|
3505
|
-
|
|
3506
|
-
|
|
3507
|
-
##### Returns
|
|
3508
|
-
|
|
3509
|
-
|
|
3510
|
-
- `number`
|
|
3511
|
-
|
|
3512
|
-
|
|
3513
|
-
|
|
3514
|
-
|
|
3515
|
-
### dist/date/relative/helpers/parseDate.js
|
|
3516
|
-
|
|
3517
|
-
|
|
3518
|
-
#### parseDate(date)
|
|
3519
|
-
|
|
3520
|
-
Parses a string date and returns a dayjs date
|
|
3521
|
-
|
|
3522
|
-
|
|
3523
|
-
|
|
3524
|
-
|
|
3525
|
-
##### Parameters
|
|
3526
|
-
|
|
3527
|
-
| Name | Type | Description | |
|
|
3528
|
-
| ---- | ---- | ----------- | -------- |
|
|
3529
|
-
| date | `string` `Dayjs` `Date` | | |
|
|
3530
|
-
|
|
3531
|
-
|
|
3532
|
-
|
|
3533
|
-
|
|
3534
|
-
##### Returns
|
|
3535
|
-
|
|
3536
|
-
|
|
3537
|
-
- `Dayjs` A dayjs date
|
|
3538
|
-
|
|
3539
|
-
|
|
3540
|
-
|
|
3541
|
-
|
|
3542
3542
|
*Documentation generated with [doxdox](https://github.com/neogeek/doxdox).*
|