@qrvey/utils 1.2.9-34 → 1.2.9-35
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 +783 -783
- package/dist/cjs/format/localization.js +16 -2
- package/dist/format/localization.js +16 -2
- package/package.json +1 -1
- package/src/format/localization.ts +16 -2
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-
|
|
1
|
+
# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-35*
|
|
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/
|
|
83
|
+
### dist/dates/adapters/mdyDateToDate.js
|
|
84
84
|
|
|
85
85
|
|
|
86
|
-
####
|
|
86
|
+
#### mdyDateToDate(monthYearDate, time)
|
|
87
87
|
|
|
88
|
-
|
|
88
|
+
Transforms String Date from a [mm/dd/yyyy] format to Date object.
|
|
89
89
|
|
|
90
90
|
|
|
91
91
|
|
|
@@ -94,9 +94,8 @@ Gets a Date Object instance by a Date format
|
|
|
94
94
|
|
|
95
95
|
| Name | Type | Description | |
|
|
96
96
|
| ---- | ---- | ----------- | -------- |
|
|
97
|
-
|
|
|
98
|
-
|
|
|
99
|
-
| time | | flag to convert the formatted date to miliseconds | |
|
|
97
|
+
| monthYearDate | | String of [mm/dd/yyyy] date | |
|
|
98
|
+
| time | | Flag to parse the object date to milliseconds. | |
|
|
100
99
|
|
|
101
100
|
|
|
102
101
|
|
|
@@ -104,17 +103,17 @@ Gets a Date Object instance by a Date format
|
|
|
104
103
|
##### Returns
|
|
105
104
|
|
|
106
105
|
|
|
107
|
-
-
|
|
106
|
+
- The date object or the date in milliseconds
|
|
108
107
|
|
|
109
108
|
|
|
110
109
|
|
|
111
110
|
|
|
112
|
-
### dist/dates/
|
|
111
|
+
### dist/dates/adapters/monthYearToDate.js
|
|
113
112
|
|
|
114
113
|
|
|
115
|
-
####
|
|
114
|
+
#### monthYearToDate(monthYearDate, time)
|
|
116
115
|
|
|
117
|
-
|
|
116
|
+
Transforms String Date from a [Month Year] format to Date object.
|
|
118
117
|
|
|
119
118
|
|
|
120
119
|
|
|
@@ -123,7 +122,8 @@ Gets the date format by the given property
|
|
|
123
122
|
|
|
124
123
|
| Name | Type | Description | |
|
|
125
124
|
| ---- | ---- | ----------- | -------- |
|
|
126
|
-
|
|
|
125
|
+
| monthYearDate | | String of [Month Year] date | |
|
|
126
|
+
| time | | Flag to parse the object date to milliseconds. | |
|
|
127
127
|
|
|
128
128
|
|
|
129
129
|
|
|
@@ -131,17 +131,17 @@ Gets the date format by the given property
|
|
|
131
131
|
##### Returns
|
|
132
132
|
|
|
133
133
|
|
|
134
|
-
- The date
|
|
134
|
+
- The date object or the date in milliseconds
|
|
135
135
|
|
|
136
136
|
|
|
137
137
|
|
|
138
138
|
|
|
139
|
-
### dist/dates/
|
|
139
|
+
### dist/dates/adapters/quarterYearToDate.js
|
|
140
140
|
|
|
141
141
|
|
|
142
|
-
####
|
|
142
|
+
#### quarterYearToDate(quarterYearDate, time)
|
|
143
143
|
|
|
144
|
-
|
|
144
|
+
Transforms String Date from a [Quarter Year] format to Date object.
|
|
145
145
|
|
|
146
146
|
|
|
147
147
|
|
|
@@ -150,7 +150,8 @@ Gets an array of regular expressions by the given date format
|
|
|
150
150
|
|
|
151
151
|
| Name | Type | Description | |
|
|
152
152
|
| ---- | ---- | ----------- | -------- |
|
|
153
|
-
|
|
|
153
|
+
| quarterYearDate | | String of [Quarter Year] date | |
|
|
154
|
+
| time | | Flag to parse the object date to milliseconds. | |
|
|
154
155
|
|
|
155
156
|
|
|
156
157
|
|
|
@@ -158,17 +159,17 @@ Gets an array of regular expressions by the given date format
|
|
|
158
159
|
##### Returns
|
|
159
160
|
|
|
160
161
|
|
|
161
|
-
-
|
|
162
|
+
- The date object or the date in milliseconds
|
|
162
163
|
|
|
163
164
|
|
|
164
165
|
|
|
165
166
|
|
|
166
|
-
### dist/dates/
|
|
167
|
+
### dist/dates/adapters/weekYearToDate.js
|
|
167
168
|
|
|
168
169
|
|
|
169
|
-
####
|
|
170
|
+
#### weekYearToDate(date, time)
|
|
170
171
|
|
|
171
|
-
|
|
172
|
+
Transforms String Date from a [Week Year] format to Date object.
|
|
172
173
|
|
|
173
174
|
|
|
174
175
|
|
|
@@ -177,7 +178,8 @@ Gets the separator of the date format
|
|
|
177
178
|
|
|
178
179
|
| Name | Type | Description | |
|
|
179
180
|
| ---- | ---- | ----------- | -------- |
|
|
180
|
-
|
|
|
181
|
+
| date | | String of [Week Year] date | |
|
|
182
|
+
| time | | Flag to parse the object date to milliseconds. | |
|
|
181
183
|
|
|
182
184
|
|
|
183
185
|
|
|
@@ -185,18 +187,17 @@ Gets the separator of the date format
|
|
|
185
187
|
##### Returns
|
|
186
188
|
|
|
187
189
|
|
|
188
|
-
-
|
|
190
|
+
- The date object or the date in milliseconds
|
|
189
191
|
|
|
190
192
|
|
|
191
193
|
|
|
192
194
|
|
|
193
|
-
### dist/dates/
|
|
195
|
+
### dist/dates/adapters/yearToDate.js
|
|
194
196
|
|
|
195
197
|
|
|
196
|
-
####
|
|
198
|
+
#### yearToDate(yearDate, time)
|
|
197
199
|
|
|
198
|
-
|
|
199
|
-
Additionally, the month and the year
|
|
200
|
+
Transforms String Date from a [Year] format to Date object.
|
|
200
201
|
|
|
201
202
|
|
|
202
203
|
|
|
@@ -205,7 +206,8 @@ Additionally, the month and the year
|
|
|
205
206
|
|
|
206
207
|
| Name | Type | Description | |
|
|
207
208
|
| ---- | ---- | ----------- | -------- |
|
|
208
|
-
|
|
|
209
|
+
| yearDate | | String of [Year] date | |
|
|
210
|
+
| time | | Flag to parse the object date to milliseconds. | |
|
|
209
211
|
|
|
210
212
|
|
|
211
213
|
|
|
@@ -213,20 +215,17 @@ Additionally, the month and the year
|
|
|
213
215
|
##### Returns
|
|
214
216
|
|
|
215
217
|
|
|
216
|
-
-
|
|
218
|
+
- The date object or the date in milliseconds
|
|
217
219
|
|
|
218
220
|
|
|
219
221
|
|
|
220
222
|
|
|
221
|
-
### dist/dates/helpers/
|
|
223
|
+
### dist/dates/helpers/getDateByDateFormat.js
|
|
222
224
|
|
|
223
225
|
|
|
224
|
-
####
|
|
226
|
+
#### getDateByDateFormat(date, format, time)
|
|
225
227
|
|
|
226
|
-
|
|
227
|
-
- If the string is a token label, the function lets it pass.
|
|
228
|
-
- Otherwise depends of the format
|
|
229
|
-
- Some escenarios the string is a mix of token labels and dates
|
|
228
|
+
Gets a Date Object instance by a Date format
|
|
230
229
|
|
|
231
230
|
|
|
232
231
|
|
|
@@ -235,8 +234,9 @@ Validate a string date depending on giving format
|
|
|
235
234
|
|
|
236
235
|
| Name | Type | Description | |
|
|
237
236
|
| ---- | ---- | ----------- | -------- |
|
|
238
|
-
| date | | String
|
|
239
|
-
| format | |
|
|
237
|
+
| date | | String with a formatted date | |
|
|
238
|
+
| format | | The date format | |
|
|
239
|
+
| time | | flag to convert the formatted date to miliseconds | |
|
|
240
240
|
|
|
241
241
|
|
|
242
242
|
|
|
@@ -244,17 +244,17 @@ Validate a string date depending on giving format
|
|
|
244
244
|
##### Returns
|
|
245
245
|
|
|
246
246
|
|
|
247
|
-
-
|
|
247
|
+
- a Date object, milisecond time or the same value if date format does not match.
|
|
248
248
|
|
|
249
249
|
|
|
250
250
|
|
|
251
251
|
|
|
252
|
-
### dist/dates/helpers/
|
|
252
|
+
### dist/dates/helpers/getDateFormatByProperty.js
|
|
253
253
|
|
|
254
254
|
|
|
255
|
-
####
|
|
255
|
+
#### getDateFormatByProperty(property)
|
|
256
256
|
|
|
257
|
-
|
|
257
|
+
Gets the date format by the given property
|
|
258
258
|
|
|
259
259
|
|
|
260
260
|
|
|
@@ -263,8 +263,7 @@ Validates the given string as Date by its date format.
|
|
|
263
263
|
|
|
264
264
|
| Name | Type | Description | |
|
|
265
265
|
| ---- | ---- | ----------- | -------- |
|
|
266
|
-
|
|
|
267
|
-
| dateForma | | the format of the date to validate the string | |
|
|
266
|
+
| property | | The Column Property | |
|
|
268
267
|
|
|
269
268
|
|
|
270
269
|
|
|
@@ -272,17 +271,17 @@ Validates the given string as Date by its date format.
|
|
|
272
271
|
##### Returns
|
|
273
272
|
|
|
274
273
|
|
|
275
|
-
-
|
|
274
|
+
- The date format
|
|
276
275
|
|
|
277
276
|
|
|
278
277
|
|
|
279
278
|
|
|
280
|
-
### dist/dates/
|
|
279
|
+
### dist/dates/helpers/getDateFormatRegularExpressionInArray.js
|
|
281
280
|
|
|
282
281
|
|
|
283
|
-
####
|
|
282
|
+
#### getDateFormatRegularExpressionInArray(dateFormat)
|
|
284
283
|
|
|
285
|
-
|
|
284
|
+
Gets an array of regular expressions by the given date format
|
|
286
285
|
|
|
287
286
|
|
|
288
287
|
|
|
@@ -291,8 +290,7 @@ Transforms String Date from a [mm/dd/yyyy] format to Date object.
|
|
|
291
290
|
|
|
292
291
|
| Name | Type | Description | |
|
|
293
292
|
| ---- | ---- | ----------- | -------- |
|
|
294
|
-
|
|
|
295
|
-
| time | | Flag to parse the object date to milliseconds. | |
|
|
293
|
+
| dateFormat | | the date format | |
|
|
296
294
|
|
|
297
295
|
|
|
298
296
|
|
|
@@ -300,17 +298,17 @@ Transforms String Date from a [mm/dd/yyyy] format to Date object.
|
|
|
300
298
|
##### Returns
|
|
301
299
|
|
|
302
300
|
|
|
303
|
-
-
|
|
301
|
+
- an array of regular expressions
|
|
304
302
|
|
|
305
303
|
|
|
306
304
|
|
|
307
305
|
|
|
308
|
-
### dist/dates/
|
|
306
|
+
### dist/dates/helpers/getSeparatorByDateFormat.js
|
|
309
307
|
|
|
310
308
|
|
|
311
|
-
####
|
|
309
|
+
#### getSeparatorByDateFormat(format)
|
|
312
310
|
|
|
313
|
-
|
|
311
|
+
Gets the separator of the date format
|
|
314
312
|
|
|
315
313
|
|
|
316
314
|
|
|
@@ -319,8 +317,7 @@ Transforms String Date from a [Month Year] format to Date object.
|
|
|
319
317
|
|
|
320
318
|
| Name | Type | Description | |
|
|
321
319
|
| ---- | ---- | ----------- | -------- |
|
|
322
|
-
|
|
|
323
|
-
| time | | Flag to parse the object date to milliseconds. | |
|
|
320
|
+
| format | | the date format | |
|
|
324
321
|
|
|
325
322
|
|
|
326
323
|
|
|
@@ -328,17 +325,18 @@ Transforms String Date from a [Month Year] format to Date object.
|
|
|
328
325
|
##### Returns
|
|
329
326
|
|
|
330
327
|
|
|
331
|
-
-
|
|
328
|
+
- a separator string
|
|
332
329
|
|
|
333
330
|
|
|
334
331
|
|
|
335
332
|
|
|
336
|
-
### dist/dates/
|
|
333
|
+
### dist/dates/helpers/getWeek.js
|
|
337
334
|
|
|
338
335
|
|
|
339
|
-
####
|
|
336
|
+
#### getWeek(date)
|
|
340
337
|
|
|
341
|
-
|
|
338
|
+
Gets the week number of the year
|
|
339
|
+
Additionally, the month and the year
|
|
342
340
|
|
|
343
341
|
|
|
344
342
|
|
|
@@ -347,8 +345,7 @@ Transforms String Date from a [Quarter Year] format to Date object.
|
|
|
347
345
|
|
|
348
346
|
| Name | Type | Description | |
|
|
349
347
|
| ---- | ---- | ----------- | -------- |
|
|
350
|
-
|
|
|
351
|
-
| time | | Flag to parse the object date to milliseconds. | |
|
|
348
|
+
| date | | the date object | |
|
|
352
349
|
|
|
353
350
|
|
|
354
351
|
|
|
@@ -356,17 +353,20 @@ Transforms String Date from a [Quarter Year] format to Date object.
|
|
|
356
353
|
##### Returns
|
|
357
354
|
|
|
358
355
|
|
|
359
|
-
-
|
|
356
|
+
- an object with the week, month and year.
|
|
360
357
|
|
|
361
358
|
|
|
362
359
|
|
|
363
360
|
|
|
364
|
-
### dist/dates/
|
|
361
|
+
### dist/dates/helpers/validateDate.js
|
|
365
362
|
|
|
366
363
|
|
|
367
|
-
####
|
|
364
|
+
#### validateDate(date, format)
|
|
368
365
|
|
|
369
|
-
|
|
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
|
|
370
370
|
|
|
371
371
|
|
|
372
372
|
|
|
@@ -375,8 +375,8 @@ Transforms String Date from a [Week Year] format to Date object.
|
|
|
375
375
|
|
|
376
376
|
| Name | Type | Description | |
|
|
377
377
|
| ---- | ---- | ----------- | -------- |
|
|
378
|
-
| date | | String of
|
|
379
|
-
|
|
|
378
|
+
| date | | String of date | |
|
|
379
|
+
| format | | String of the format to validate | |
|
|
380
380
|
|
|
381
381
|
|
|
382
382
|
|
|
@@ -384,17 +384,17 @@ Transforms String Date from a [Week Year] format to Date object.
|
|
|
384
384
|
##### Returns
|
|
385
385
|
|
|
386
386
|
|
|
387
|
-
-
|
|
387
|
+
- True if it is valid or not. Undefined if date is undefined
|
|
388
388
|
|
|
389
389
|
|
|
390
390
|
|
|
391
391
|
|
|
392
|
-
### dist/dates/
|
|
392
|
+
### dist/dates/helpers/validateDateByDateFormat.js
|
|
393
393
|
|
|
394
394
|
|
|
395
|
-
####
|
|
395
|
+
#### validateDateByDateFormat(date, dateForma)
|
|
396
396
|
|
|
397
|
-
|
|
397
|
+
Validates the given string as Date by its date format.
|
|
398
398
|
|
|
399
399
|
|
|
400
400
|
|
|
@@ -403,8 +403,8 @@ Transforms String Date from a [Year] format to Date object.
|
|
|
403
403
|
|
|
404
404
|
| Name | Type | Description | |
|
|
405
405
|
| ---- | ---- | ----------- | -------- |
|
|
406
|
-
|
|
|
407
|
-
|
|
|
406
|
+
| date | | a string to validate as date form | |
|
|
407
|
+
| dateForma | | the format of the date to validate the string | |
|
|
408
408
|
|
|
409
409
|
|
|
410
410
|
|
|
@@ -412,7 +412,7 @@ Transforms String Date from a [Year] format to Date object.
|
|
|
412
412
|
##### Returns
|
|
413
413
|
|
|
414
414
|
|
|
415
|
-
-
|
|
415
|
+
- true: the string is a valida date
|
|
416
416
|
|
|
417
417
|
|
|
418
418
|
|
|
@@ -688,22 +688,14 @@ Output:
|
|
|
688
688
|
|
|
689
689
|
|
|
690
690
|
|
|
691
|
-
### dist/
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
#### ArrayDelete(array, index)
|
|
691
|
+
### dist/filters/classes/FilterInputErrorHandler.js
|
|
695
692
|
|
|
696
|
-
Inmutable Array Item deletion
|
|
697
693
|
|
|
694
|
+
#### new FilterInputErrorHandler()
|
|
698
695
|
|
|
699
696
|
|
|
700
697
|
|
|
701
|
-
##### Parameters
|
|
702
698
|
|
|
703
|
-
| Name | Type | Description | |
|
|
704
|
-
| ---- | ---- | ----------- | -------- |
|
|
705
|
-
| array | `Array` | a collection of items to delete | |
|
|
706
|
-
| index | `Number` | the position of the item to delete | |
|
|
707
699
|
|
|
708
700
|
|
|
709
701
|
|
|
@@ -711,20 +703,17 @@ Inmutable Array Item deletion
|
|
|
711
703
|
##### Returns
|
|
712
704
|
|
|
713
705
|
|
|
714
|
-
-
|
|
706
|
+
- `Void`
|
|
715
707
|
|
|
716
708
|
|
|
717
709
|
|
|
718
710
|
|
|
719
|
-
### dist/
|
|
711
|
+
### dist/filters/adapters/FDToFlatUI.js
|
|
720
712
|
|
|
721
713
|
|
|
722
|
-
####
|
|
714
|
+
#### FDToFlatUI(filterData, datasetsInfo)
|
|
723
715
|
|
|
724
|
-
|
|
725
|
-
- If the given arguments are not valid, the function returns the first argument.
|
|
726
|
-
- If the childArrKey is not matched in the object, the condition tries to resolve the filter anyway and returns an empty array.
|
|
727
|
-
- If the condition is not fulfilled, the function returns a filtered array, probably a empty array inside of the child array
|
|
716
|
+
Generates a Flattened UI filter structure from Filter Data structure.
|
|
728
717
|
|
|
729
718
|
|
|
730
719
|
|
|
@@ -733,9 +722,8 @@ Filters a nested tree array by a custom condition on the last child node
|
|
|
733
722
|
|
|
734
723
|
| Name | Type | Description | |
|
|
735
724
|
| ---- | ---- | ----------- | -------- |
|
|
736
|
-
|
|
|
737
|
-
|
|
|
738
|
-
| condition | | function callback that determines if the filter is applied on the last child node of the nested tree | |
|
|
725
|
+
| filterData | | The filter data object. | |
|
|
726
|
+
| datasetsInfo | | Collection of datasets information | |
|
|
739
727
|
|
|
740
728
|
|
|
741
729
|
|
|
@@ -743,17 +731,13 @@ Filters a nested tree array by a custom condition on the last child node
|
|
|
743
731
|
##### Returns
|
|
744
732
|
|
|
745
733
|
|
|
746
|
-
- array
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
734
|
+
- a flattened UI filters array
|
|
750
735
|
|
|
751
|
-
### dist/general/array/flattenDeep.js
|
|
752
736
|
|
|
753
737
|
|
|
754
|
-
####
|
|
738
|
+
#### FD21ToFlatUI(scopes, datasetsInfo)
|
|
755
739
|
|
|
756
|
-
|
|
740
|
+
Generates a Filter Builder Structure from the Filter Data structure v2.1
|
|
757
741
|
|
|
758
742
|
|
|
759
743
|
|
|
@@ -762,7 +746,8 @@ Flat deeply an array
|
|
|
762
746
|
|
|
763
747
|
| Name | Type | Description | |
|
|
764
748
|
| ---- | ---- | ----------- | -------- |
|
|
765
|
-
|
|
|
749
|
+
| scopes | | The filter scope section | |
|
|
750
|
+
| datasetsInfo | | Collection of datasets information | |
|
|
766
751
|
|
|
767
752
|
|
|
768
753
|
|
|
@@ -770,17 +755,17 @@ Flat deeply an array
|
|
|
770
755
|
##### Returns
|
|
771
756
|
|
|
772
757
|
|
|
773
|
-
-
|
|
758
|
+
- a flattened UI filters array
|
|
774
759
|
|
|
775
760
|
|
|
776
761
|
|
|
777
762
|
|
|
778
|
-
### dist/
|
|
763
|
+
### dist/filters/adapters/FDToLogic.js
|
|
779
764
|
|
|
780
765
|
|
|
781
|
-
####
|
|
766
|
+
#### FDToLogic(filterData)
|
|
782
767
|
|
|
783
|
-
|
|
768
|
+
Generates a Filter Logic structure from Filter Data structure.
|
|
784
769
|
|
|
785
770
|
|
|
786
771
|
|
|
@@ -789,8 +774,7 @@ Gets the first index from the array by a callback condition
|
|
|
789
774
|
|
|
790
775
|
| Name | Type | Description | |
|
|
791
776
|
| ---- | ---- | ----------- | -------- |
|
|
792
|
-
|
|
|
793
|
-
| callback | | function callback | |
|
|
777
|
+
| filterData | | The filter data object. | |
|
|
794
778
|
|
|
795
779
|
|
|
796
780
|
|
|
@@ -798,17 +782,13 @@ Gets the first index from the array by a callback condition
|
|
|
798
782
|
##### Returns
|
|
799
783
|
|
|
800
784
|
|
|
801
|
-
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
785
|
+
- a filter logic array
|
|
805
786
|
|
|
806
|
-
### dist/general/array/getLastIndexFromArray.js
|
|
807
787
|
|
|
808
788
|
|
|
809
|
-
####
|
|
789
|
+
#### getLogicBodyFromFD21(filterData)
|
|
810
790
|
|
|
811
|
-
Gets the
|
|
791
|
+
Gets the logic body
|
|
812
792
|
|
|
813
793
|
|
|
814
794
|
|
|
@@ -817,8 +797,7 @@ Gets the last index from the array by a callback condition
|
|
|
817
797
|
|
|
818
798
|
| Name | Type | Description | |
|
|
819
799
|
| ---- | ---- | ----------- | -------- |
|
|
820
|
-
|
|
|
821
|
-
| callback | | function callback | |
|
|
800
|
+
| filterData | | The filter data object | |
|
|
822
801
|
|
|
823
802
|
|
|
824
803
|
|
|
@@ -826,17 +805,17 @@ Gets the last index from the array by a callback condition
|
|
|
826
805
|
##### Returns
|
|
827
806
|
|
|
828
807
|
|
|
829
|
-
-
|
|
808
|
+
- a filter logic array
|
|
830
809
|
|
|
831
810
|
|
|
832
811
|
|
|
833
812
|
|
|
834
|
-
### dist/
|
|
813
|
+
### dist/filters/adapters/FDToUI.js
|
|
835
814
|
|
|
836
815
|
|
|
837
|
-
####
|
|
816
|
+
#### FDToUI(filterData, datasetsInfo)
|
|
838
817
|
|
|
839
|
-
|
|
818
|
+
Generates a UI filter structure from Filter Data structure.
|
|
840
819
|
|
|
841
820
|
|
|
842
821
|
|
|
@@ -845,8 +824,8 @@ Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last
|
|
|
845
824
|
|
|
846
825
|
| Name | Type | Description | |
|
|
847
826
|
| ---- | ---- | ----------- | -------- |
|
|
848
|
-
|
|
|
849
|
-
|
|
|
827
|
+
| filterData | | The filter data object. | |
|
|
828
|
+
| datasetsInfo | | Collection of datasets information | |
|
|
850
829
|
|
|
851
830
|
|
|
852
831
|
|
|
@@ -854,17 +833,13 @@ Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last
|
|
|
854
833
|
##### Returns
|
|
855
834
|
|
|
856
835
|
|
|
857
|
-
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
836
|
+
- a UI Filters structure
|
|
861
837
|
|
|
862
|
-
### dist/general/function/throttled.js
|
|
863
838
|
|
|
864
839
|
|
|
865
|
-
####
|
|
840
|
+
#### FD21ToUI(scopes, section, version, datasetsInfo)
|
|
866
841
|
|
|
867
|
-
|
|
842
|
+
Generates a UI filter Structure from the Filter Data structure v2.1
|
|
868
843
|
|
|
869
844
|
|
|
870
845
|
|
|
@@ -873,8 +848,10 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
|
|
|
873
848
|
|
|
874
849
|
| Name | Type | Description | |
|
|
875
850
|
| ---- | ---- | ----------- | -------- |
|
|
876
|
-
|
|
|
877
|
-
|
|
|
851
|
+
| scopes | | The filter scope section | |
|
|
852
|
+
| section | | The filter section. | |
|
|
853
|
+
| version | | The version of the filter structure | |
|
|
854
|
+
| datasetsInfo | | Collection of datasets information | |
|
|
878
855
|
|
|
879
856
|
|
|
880
857
|
|
|
@@ -882,18 +859,17 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
|
|
|
882
859
|
##### Returns
|
|
883
860
|
|
|
884
861
|
|
|
885
|
-
-
|
|
862
|
+
- a UI filter Structure
|
|
886
863
|
|
|
887
864
|
|
|
888
865
|
|
|
889
866
|
|
|
890
|
-
### dist/
|
|
867
|
+
### dist/filters/adapters/UIToFD.js
|
|
891
868
|
|
|
892
869
|
|
|
893
|
-
####
|
|
870
|
+
#### UIToFD(filterData)
|
|
894
871
|
|
|
895
|
-
|
|
896
|
-
Not to use this function with inner objects and functions
|
|
872
|
+
Generates a Filter Data Structure structure from UI Filter Data structure.
|
|
897
873
|
|
|
898
874
|
|
|
899
875
|
|
|
@@ -902,7 +878,7 @@ Not to use this function with inner objects and functions
|
|
|
902
878
|
|
|
903
879
|
| Name | Type | Description | |
|
|
904
880
|
| ---- | ---- | ----------- | -------- |
|
|
905
|
-
|
|
|
881
|
+
| filterData | | The UI filter data object. | |
|
|
906
882
|
|
|
907
883
|
|
|
908
884
|
|
|
@@ -910,21 +886,13 @@ Not to use this function with inner objects and functions
|
|
|
910
886
|
##### Returns
|
|
911
887
|
|
|
912
888
|
|
|
913
|
-
-
|
|
889
|
+
- a Filter Data structure
|
|
914
890
|
|
|
915
891
|
|
|
916
892
|
|
|
893
|
+
#### UI21ToFD(uFilterData, version)
|
|
917
894
|
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
#### _get(baseObject, path, defaultValue)
|
|
922
|
-
|
|
923
|
-
Like lodash _.get.
|
|
924
|
-
Gets the value at path of object. If the resolved value is undefined, the defaultValue is returned in its place.
|
|
925
|
-
|
|
926
|
-
Empty arrays and empty objects are returned but the defaultValue is not
|
|
927
|
-
Undefined and null values will return the defaultValue.
|
|
895
|
+
Builds the Fitler Data structure from UI filter data
|
|
928
896
|
|
|
929
897
|
|
|
930
898
|
|
|
@@ -933,59 +901,27 @@ Undefined and null values will return the defaultValue.
|
|
|
933
901
|
|
|
934
902
|
| Name | Type | Description | |
|
|
935
903
|
| ---- | ---- | ----------- | -------- |
|
|
936
|
-
|
|
|
937
|
-
|
|
|
938
|
-
| defaultValue | | The value returned for undefined resolved values. | |
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
|
|
904
|
+
| uFilterData | | The UI filter Data object | |
|
|
905
|
+
| version | | the version of the structure | |
|
|
942
906
|
|
|
943
|
-
##### Examples
|
|
944
907
|
|
|
945
|
-
```javascript
|
|
946
|
-
// returns 'Hello'
|
|
947
|
-
_get({ item1: 'Hello', item2: 'World' }, 'item1')
|
|
948
|
-
```
|
|
949
|
-
```javascript
|
|
950
|
-
// returns 'A simple Hello'
|
|
951
|
-
_get({ item1: 'Hello', item2: 'World' }, 'item3', 'A simple Hello')
|
|
952
|
-
```
|
|
953
|
-
```javascript
|
|
954
|
-
// returns 'Hello Again'
|
|
955
|
-
_get({ item1: { item11: 'Hello Again' }, item2: {} }, 'item1.item11')
|
|
956
|
-
```
|
|
957
|
-
```javascript
|
|
958
|
-
// returns 'Hello 2'
|
|
959
|
-
_get({ item1: ['Hello 1', 'Hello 2' }, item2: [] }, 'item1[1]')
|
|
960
|
-
```
|
|
961
|
-
```javascript
|
|
962
|
-
// returns 'Hello Again'
|
|
963
|
-
_get({ item1: { item11: 'Hello Again' }, item2: {} }, ['item1', 'item11'])
|
|
964
|
-
```
|
|
965
908
|
|
|
966
909
|
|
|
967
910
|
##### Returns
|
|
968
911
|
|
|
969
912
|
|
|
970
|
-
-
|
|
913
|
+
-
|
|
971
914
|
|
|
972
915
|
|
|
973
916
|
|
|
974
917
|
|
|
975
|
-
### dist/
|
|
918
|
+
### dist/filters/adapters/adaptDateGroupingProperty.js
|
|
976
919
|
|
|
977
920
|
|
|
978
|
-
####
|
|
921
|
+
#### adaptDateGroupingProperty(property)
|
|
979
922
|
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
- List of cases that do not match
|
|
983
|
-
-- From lower to snake case
|
|
984
|
-
-- From upper to snake case
|
|
985
|
-
-- From lower to camel case
|
|
986
|
-
-- From upper to camel case
|
|
987
|
-
-- From lower to pascal case
|
|
988
|
-
-- From upper to pascal case
|
|
923
|
+
[TODO: For 2022, eliminate this adapter]
|
|
924
|
+
Get the new property base on the old date grouping properties
|
|
989
925
|
|
|
990
926
|
|
|
991
927
|
|
|
@@ -994,33 +930,25 @@ Searchs for properties in different case styles such as: lower, upper, camel and
|
|
|
994
930
|
|
|
995
931
|
| Name | Type | Description | |
|
|
996
932
|
| ---- | ---- | ----------- | -------- |
|
|
997
|
-
|
|
|
998
|
-
| key | `string` | String attribute in snake_case style | |
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
933
|
+
| property | | | |
|
|
1002
934
|
|
|
1003
|
-
##### Examples
|
|
1004
935
|
|
|
1005
|
-
```javascript
|
|
1006
|
-
getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
|
|
1007
|
-
```
|
|
1008
936
|
|
|
1009
937
|
|
|
1010
938
|
##### Returns
|
|
1011
939
|
|
|
1012
940
|
|
|
1013
|
-
-
|
|
941
|
+
-
|
|
1014
942
|
|
|
1015
943
|
|
|
1016
944
|
|
|
1017
945
|
|
|
1018
|
-
### dist/
|
|
946
|
+
### dist/filters/adapters/UIToFlatUI.js
|
|
1019
947
|
|
|
1020
948
|
|
|
1021
|
-
####
|
|
949
|
+
#### UIToFlatUI(filterData, datasetsInfo)
|
|
1022
950
|
|
|
1023
|
-
|
|
951
|
+
Generates a Flattened UI filter structure from UI Filter Data structure.
|
|
1024
952
|
|
|
1025
953
|
|
|
1026
954
|
|
|
@@ -1029,38 +957,49 @@ Use the hasOwnProperty in order to verify if the given property exists in the ob
|
|
|
1029
957
|
|
|
1030
958
|
| Name | Type | Description | |
|
|
1031
959
|
| ---- | ---- | ----------- | -------- |
|
|
1032
|
-
|
|
|
1033
|
-
|
|
|
960
|
+
| filterData | | The UI filter data object. | |
|
|
961
|
+
| datasetsInfo | | Collection of datasets information. Optional for updating the datasets info | |
|
|
1034
962
|
|
|
1035
963
|
|
|
1036
964
|
|
|
1037
965
|
|
|
1038
|
-
#####
|
|
966
|
+
##### Returns
|
|
967
|
+
|
|
968
|
+
|
|
969
|
+
- a flattened UI filters array
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
|
|
973
|
+
#### UI21ToFlatUI(scopes)
|
|
974
|
+
|
|
975
|
+
Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
|
|
980
|
+
##### Parameters
|
|
981
|
+
|
|
982
|
+
| Name | Type | Description | |
|
|
983
|
+
| ---- | ---- | ----------- | -------- |
|
|
984
|
+
| scopes | | The filter scope section | |
|
|
1039
985
|
|
|
1040
|
-
```javascript
|
|
1041
|
-
const prop = 'prop2'
|
|
1042
|
-
const obj1 = { prop1: 'hello', prop2: 'world'}
|
|
1043
|
-
_hasProperty(ob1, prop1) // true
|
|
1044
986
|
|
|
1045
|
-
const obj2 = { prop1: 'hello world' }
|
|
1046
|
-
_hasProperty(ob1, prop2) // false
|
|
1047
|
-
```
|
|
1048
987
|
|
|
1049
988
|
|
|
1050
989
|
##### Returns
|
|
1051
990
|
|
|
1052
991
|
|
|
1053
|
-
-
|
|
992
|
+
- a flattened UI filters array
|
|
1054
993
|
|
|
1055
994
|
|
|
1056
995
|
|
|
1057
996
|
|
|
1058
|
-
### dist/
|
|
997
|
+
### dist/filters/adapters/adaptFilterData.js
|
|
1059
998
|
|
|
1060
999
|
|
|
1061
|
-
####
|
|
1000
|
+
#### adaptFilterData(filterData, getUIFilterData, datasetsInfo)
|
|
1062
1001
|
|
|
1063
|
-
Checks
|
|
1002
|
+
Checks and adapts the v2.0 Filter Data Structure to the v2.1
|
|
1064
1003
|
|
|
1065
1004
|
|
|
1066
1005
|
|
|
@@ -1069,7 +1008,9 @@ Checks if the given argument is an object type
|
|
|
1069
1008
|
|
|
1070
1009
|
| Name | Type | Description | |
|
|
1071
1010
|
| ---- | ---- | ----------- | -------- |
|
|
1072
|
-
|
|
|
1011
|
+
| filterData | | The filter data structure. Accepts both v2.1 or v2.0 | |
|
|
1012
|
+
| getUIFilterData | | Flag to get a Filter Data (False) or the UI Filter Data (True) | |
|
|
1013
|
+
| datasetsInfo | | Collection of datasets information. If getUIFilterData is true, the datasetsInfo should be mandatory | |
|
|
1073
1014
|
|
|
1074
1015
|
|
|
1075
1016
|
|
|
@@ -1077,18 +1018,18 @@ Checks if the given argument is an object type
|
|
|
1077
1018
|
##### Returns
|
|
1078
1019
|
|
|
1079
1020
|
|
|
1080
|
-
-
|
|
1021
|
+
- A new filter data structure v2.1
|
|
1081
1022
|
|
|
1082
1023
|
|
|
1083
1024
|
|
|
1084
1025
|
|
|
1085
|
-
### dist/
|
|
1026
|
+
### dist/filters/adapters/adaptFilterValues.js
|
|
1086
1027
|
|
|
1087
1028
|
|
|
1088
|
-
####
|
|
1029
|
+
#### adaptFilterValues(filter)
|
|
1089
1030
|
|
|
1090
|
-
|
|
1091
|
-
|
|
1031
|
+
[TODO: For 2022, eliminate this adapter]
|
|
1032
|
+
Gets an adapted filter value array. Validates the enabled property and sets
|
|
1092
1033
|
|
|
1093
1034
|
|
|
1094
1035
|
|
|
@@ -1097,8 +1038,7 @@ and return a mapped object
|
|
|
1097
1038
|
|
|
1098
1039
|
| Name | Type | Description | |
|
|
1099
1040
|
| ---- | ---- | ----------- | -------- |
|
|
1100
|
-
|
|
|
1101
|
-
| iteratee | `Function` | The executed per iteration. | |
|
|
1041
|
+
| filter | | The filter | |
|
|
1102
1042
|
|
|
1103
1043
|
|
|
1104
1044
|
|
|
@@ -1106,18 +1046,17 @@ and return a mapped object
|
|
|
1106
1046
|
##### Returns
|
|
1107
1047
|
|
|
1108
1048
|
|
|
1109
|
-
-
|
|
1049
|
+
- A new value array with the filled properties.
|
|
1110
1050
|
|
|
1111
1051
|
|
|
1112
1052
|
|
|
1113
1053
|
|
|
1114
|
-
### dist/
|
|
1054
|
+
### dist/filters/adapters/flatUIToFD.js
|
|
1115
1055
|
|
|
1116
1056
|
|
|
1117
|
-
####
|
|
1057
|
+
#### flatUIToFD(uFilters, version)
|
|
1118
1058
|
|
|
1119
|
-
|
|
1120
|
-
The second given argument to the first given argument.
|
|
1059
|
+
Generates a filter data structure from the flatttened UI filters.
|
|
1121
1060
|
|
|
1122
1061
|
|
|
1123
1062
|
|
|
@@ -1126,9 +1065,8 @@ The second given argument to the first given argument.
|
|
|
1126
1065
|
|
|
1127
1066
|
| Name | Type | Description | |
|
|
1128
1067
|
| ---- | ---- | ----------- | -------- |
|
|
1129
|
-
|
|
|
1130
|
-
|
|
|
1131
|
-
| settings | | Object settings for this function | |
|
|
1068
|
+
| uFilters | | Array of flattened filters from UI | |
|
|
1069
|
+
| version | | Tag for the version of the filter data structure | |
|
|
1132
1070
|
|
|
1133
1071
|
|
|
1134
1072
|
|
|
@@ -1136,13 +1074,14 @@ The second given argument to the first given argument.
|
|
|
1136
1074
|
##### Returns
|
|
1137
1075
|
|
|
1138
1076
|
|
|
1139
|
-
- a
|
|
1077
|
+
- a Filter Data.
|
|
1140
1078
|
|
|
1141
1079
|
|
|
1142
1080
|
|
|
1143
|
-
####
|
|
1081
|
+
#### buildScopes(fbFilters)
|
|
1144
1082
|
|
|
1145
|
-
|
|
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
|
|
1146
1085
|
|
|
1147
1086
|
|
|
1148
1087
|
|
|
@@ -1151,8 +1090,7 @@ Validates if the two arguments are objects
|
|
|
1151
1090
|
|
|
1152
1091
|
| Name | Type | Description | |
|
|
1153
1092
|
| ---- | ---- | ----------- | -------- |
|
|
1154
|
-
|
|
|
1155
|
-
| obj2 | | The object to be merged | |
|
|
1093
|
+
| fbFilters | | Array of flat filters from UI | |
|
|
1156
1094
|
|
|
1157
1095
|
|
|
1158
1096
|
|
|
@@ -1160,13 +1098,13 @@ Validates if the two arguments are objects
|
|
|
1160
1098
|
##### Returns
|
|
1161
1099
|
|
|
1162
1100
|
|
|
1163
|
-
-
|
|
1101
|
+
- an array of scopes structure.
|
|
1164
1102
|
|
|
1165
1103
|
|
|
1166
1104
|
|
|
1167
|
-
####
|
|
1105
|
+
#### buildScope(uFilter)
|
|
1168
1106
|
|
|
1169
|
-
|
|
1107
|
+
Gets an scope structure for the filter data
|
|
1170
1108
|
|
|
1171
1109
|
|
|
1172
1110
|
|
|
@@ -1175,7 +1113,7 @@ Validates and gets the settings with all set parameters.
|
|
|
1175
1113
|
|
|
1176
1114
|
| Name | Type | Description | |
|
|
1177
1115
|
| ---- | ---- | ----------- | -------- |
|
|
1178
|
-
|
|
|
1116
|
+
| uFilter | | UI structure filter | |
|
|
1179
1117
|
|
|
1180
1118
|
|
|
1181
1119
|
|
|
@@ -1183,17 +1121,13 @@ Validates and gets the settings with all set parameters.
|
|
|
1183
1121
|
##### Returns
|
|
1184
1122
|
|
|
1185
1123
|
|
|
1186
|
-
-
|
|
1187
|
-
|
|
1188
|
-
|
|
1189
|
-
|
|
1124
|
+
- an scope structure
|
|
1190
1125
|
|
|
1191
|
-
### dist/general/object/objectCopy.js
|
|
1192
1126
|
|
|
1193
1127
|
|
|
1194
|
-
####
|
|
1128
|
+
#### buildDataset(uFilter)
|
|
1195
1129
|
|
|
1196
|
-
|
|
1130
|
+
Gets an dataset structure for the filter data
|
|
1197
1131
|
|
|
1198
1132
|
|
|
1199
1133
|
|
|
@@ -1202,8 +1136,7 @@ Created a new reference of the given argument
|
|
|
1202
1136
|
|
|
1203
1137
|
| Name | Type | Description | |
|
|
1204
1138
|
| ---- | ---- | ----------- | -------- |
|
|
1205
|
-
|
|
|
1206
|
-
| cache | | | |
|
|
1139
|
+
| uFilter | | a UI structure filter | |
|
|
1207
1140
|
|
|
1208
1141
|
|
|
1209
1142
|
|
|
@@ -1211,17 +1144,13 @@ Created a new reference of the given argument
|
|
|
1211
1144
|
##### Returns
|
|
1212
1145
|
|
|
1213
1146
|
|
|
1214
|
-
-
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
|
|
1147
|
+
- an dataset structure
|
|
1218
1148
|
|
|
1219
|
-
### dist/general/object/omit.js
|
|
1220
1149
|
|
|
1221
1150
|
|
|
1222
|
-
####
|
|
1151
|
+
#### buildFilter(uFilter)
|
|
1223
1152
|
|
|
1224
|
-
|
|
1153
|
+
Gets an filter structure for the filter data
|
|
1225
1154
|
|
|
1226
1155
|
|
|
1227
1156
|
|
|
@@ -1230,8 +1159,7 @@ return a new Object excluding attributes in _props_ list
|
|
|
1230
1159
|
|
|
1231
1160
|
| Name | Type | Description | |
|
|
1232
1161
|
| ---- | ---- | ----------- | -------- |
|
|
1233
|
-
|
|
|
1234
|
-
| props | `Array.<String>` | list of attribute to exclude | |
|
|
1162
|
+
| uFilter | | a UI structure filter | |
|
|
1235
1163
|
|
|
1236
1164
|
|
|
1237
1165
|
|
|
@@ -1239,17 +1167,17 @@ return a new Object excluding attributes in _props_ list
|
|
|
1239
1167
|
##### Returns
|
|
1240
1168
|
|
|
1241
1169
|
|
|
1242
|
-
-
|
|
1170
|
+
- an filter structure
|
|
1243
1171
|
|
|
1244
1172
|
|
|
1245
1173
|
|
|
1246
1174
|
|
|
1247
|
-
### dist/
|
|
1175
|
+
### dist/filters/adapters/flatUIToLogic.js
|
|
1248
1176
|
|
|
1249
1177
|
|
|
1250
|
-
####
|
|
1178
|
+
#### flatUIToLogic(uFilter)
|
|
1251
1179
|
|
|
1252
|
-
|
|
1180
|
+
Generates a Logic structure from flattened UI filters
|
|
1253
1181
|
|
|
1254
1182
|
|
|
1255
1183
|
|
|
@@ -1258,8 +1186,7 @@ return a new object just with attributes in _keys_ list
|
|
|
1258
1186
|
|
|
1259
1187
|
| Name | Type | Description | |
|
|
1260
1188
|
| ---- | ---- | ----------- | -------- |
|
|
1261
|
-
|
|
|
1262
|
-
| keys | `Array.<String>` | list of attributes to preserve | |
|
|
1189
|
+
| uFilter | | Array of flat filters from UI | |
|
|
1263
1190
|
|
|
1264
1191
|
|
|
1265
1192
|
|
|
@@ -1267,17 +1194,17 @@ return a new object just with attributes in _keys_ list
|
|
|
1267
1194
|
##### Returns
|
|
1268
1195
|
|
|
1269
1196
|
|
|
1270
|
-
-
|
|
1197
|
+
- The logic structure
|
|
1271
1198
|
|
|
1272
1199
|
|
|
1273
1200
|
|
|
1274
1201
|
|
|
1275
|
-
### dist/
|
|
1202
|
+
### dist/filters/adapters/flatUIToOldLogic.js
|
|
1276
1203
|
|
|
1277
1204
|
|
|
1278
|
-
####
|
|
1205
|
+
#### flatUIToOldLogic(uFilters)
|
|
1279
1206
|
|
|
1280
|
-
|
|
1207
|
+
Generates a Logic structure from flattened UI filters
|
|
1281
1208
|
|
|
1282
1209
|
|
|
1283
1210
|
|
|
@@ -1286,7 +1213,7 @@ serialize object to url param
|
|
|
1286
1213
|
|
|
1287
1214
|
| Name | Type | Description | |
|
|
1288
1215
|
| ---- | ---- | ----------- | -------- |
|
|
1289
|
-
|
|
|
1216
|
+
| uFilters | | Array of flat filters from UI | |
|
|
1290
1217
|
|
|
1291
1218
|
|
|
1292
1219
|
|
|
@@ -1294,17 +1221,17 @@ serialize object to url param
|
|
|
1294
1221
|
##### Returns
|
|
1295
1222
|
|
|
1296
1223
|
|
|
1297
|
-
-
|
|
1224
|
+
- The logic structure
|
|
1298
1225
|
|
|
1299
1226
|
|
|
1300
1227
|
|
|
1301
1228
|
|
|
1302
|
-
### dist/
|
|
1229
|
+
### dist/filters/adapters/flatUIToUI.js
|
|
1303
1230
|
|
|
1304
1231
|
|
|
1305
|
-
####
|
|
1232
|
+
#### flatUIToUI(uFilters, version)
|
|
1306
1233
|
|
|
1307
|
-
|
|
1234
|
+
Generates a UI filter data structure from the flatttened UI filters.
|
|
1308
1235
|
|
|
1309
1236
|
|
|
1310
1237
|
|
|
@@ -1313,7 +1240,8 @@ Upper case the first letter of a given text
|
|
|
1313
1240
|
|
|
1314
1241
|
| Name | Type | Description | |
|
|
1315
1242
|
| ---- | ---- | ----------- | -------- |
|
|
1316
|
-
|
|
|
1243
|
+
| uFilters | | Array of flattened filters from UI | |
|
|
1244
|
+
| version | | Tag for the version of the filter data structure | |
|
|
1317
1245
|
|
|
1318
1246
|
|
|
1319
1247
|
|
|
@@ -1321,18 +1249,14 @@ Upper case the first letter of a given text
|
|
|
1321
1249
|
##### Returns
|
|
1322
1250
|
|
|
1323
1251
|
|
|
1324
|
-
-
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1252
|
+
- a UI Filter Data.
|
|
1328
1253
|
|
|
1329
|
-
### dist/general/mix/compareDeep.js
|
|
1330
1254
|
|
|
1331
1255
|
|
|
1332
|
-
####
|
|
1256
|
+
#### buildScopes(fbFilters)
|
|
1333
1257
|
|
|
1334
|
-
|
|
1335
|
-
|
|
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
|
|
1336
1260
|
|
|
1337
1261
|
|
|
1338
1262
|
|
|
@@ -1341,8 +1265,7 @@ Includes arrays in the comparison.
|
|
|
1341
1265
|
|
|
1342
1266
|
| Name | Type | Description | |
|
|
1343
1267
|
| ---- | ---- | ----------- | -------- |
|
|
1344
|
-
|
|
|
1345
|
-
| object2 | | Second Object to compare | |
|
|
1268
|
+
| fbFilters | | Array of flat filters from UI | |
|
|
1346
1269
|
|
|
1347
1270
|
|
|
1348
1271
|
|
|
@@ -1350,17 +1273,13 @@ Includes arrays in the comparison.
|
|
|
1350
1273
|
##### Returns
|
|
1351
1274
|
|
|
1352
1275
|
|
|
1353
|
-
-
|
|
1354
|
-
|
|
1355
|
-
|
|
1356
|
-
|
|
1276
|
+
- an array of scopes structure.
|
|
1357
1277
|
|
|
1358
|
-
### dist/general/mix/getTag.js
|
|
1359
1278
|
|
|
1360
1279
|
|
|
1361
|
-
####
|
|
1280
|
+
#### buildScope(uFilter)
|
|
1362
1281
|
|
|
1363
|
-
Gets the
|
|
1282
|
+
Gets an scope structure for the UI filter data
|
|
1364
1283
|
|
|
1365
1284
|
|
|
1366
1285
|
|
|
@@ -1369,7 +1288,7 @@ Gets the `toStringTag` of `value`.
|
|
|
1369
1288
|
|
|
1370
1289
|
| Name | Type | Description | |
|
|
1371
1290
|
| ---- | ---- | ----------- | -------- |
|
|
1372
|
-
|
|
|
1291
|
+
| uFilter | | UI structure filter | |
|
|
1373
1292
|
|
|
1374
1293
|
|
|
1375
1294
|
|
|
@@ -1377,17 +1296,13 @@ Gets the `toStringTag` of `value`.
|
|
|
1377
1296
|
##### Returns
|
|
1378
1297
|
|
|
1379
1298
|
|
|
1380
|
-
-
|
|
1381
|
-
|
|
1382
|
-
|
|
1383
|
-
|
|
1299
|
+
- an scope structure
|
|
1384
1300
|
|
|
1385
|
-
### dist/general/mix/importScripts.js
|
|
1386
1301
|
|
|
1387
1302
|
|
|
1388
|
-
####
|
|
1303
|
+
#### buildDataset(uFilter)
|
|
1389
1304
|
|
|
1390
|
-
|
|
1305
|
+
Gets an dataset structure for the UI filter data
|
|
1391
1306
|
|
|
1392
1307
|
|
|
1393
1308
|
|
|
@@ -1396,54 +1311,21 @@ Import a set of external Scripts given the URL in both serie and cascade way
|
|
|
1396
1311
|
|
|
1397
1312
|
| Name | Type | Description | |
|
|
1398
1313
|
| ---- | ---- | ----------- | -------- |
|
|
1399
|
-
|
|
|
1400
|
-
| scripts.url | `String` | CDN URL | |
|
|
1401
|
-
| scripts.namespace | `String` `Function` | (Optional) if is a String, that name is evaluated on Window[namespace] object otherwise the Function is invoked expecting a Thrutly value | |
|
|
1402
|
-
| scripts.type | `String` | (Optional) it could be `module` of `text/javascript`. Default `text/javascript` | |
|
|
1403
|
-
| scripts.noModule | `Boolean` | (Optional) add `momodule` attribute to script tag. Default `false` | |
|
|
1404
|
-
| scripts.dependencies | `Array.<Object>` | an array with the same structure to load in cascade mode | |
|
|
1405
|
-
|
|
1406
|
-
|
|
1407
|
-
|
|
1408
|
-
|
|
1409
|
-
##### Examples
|
|
1410
|
-
|
|
1411
|
-
```javascript
|
|
1412
|
-
// 1) Simple script (paralell loading)
|
|
1413
|
-
importScripts(['http://myscript.js', 'http://another.js']);
|
|
1414
|
-
|
|
1415
|
-
// 2) Loading `.js` and `.esm.js` script (parallel loading)
|
|
1416
|
-
importScripts([
|
|
1417
|
-
{ url: 'http://myscript.esm.js', type: 'module' },
|
|
1418
|
-
{ url: 'http://myscript.js', noModule: true }
|
|
1419
|
-
]);
|
|
1314
|
+
| uFilter | | a UI structure filter | |
|
|
1420
1315
|
|
|
1421
|
-
// 3) import dependent scripts (cascade)
|
|
1422
|
-
importScripts([
|
|
1423
|
-
{ url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] }
|
|
1424
|
-
]);
|
|
1425
1316
|
|
|
1426
|
-
// 4) mix
|
|
1427
|
-
importScripts([
|
|
1428
|
-
{ url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] },
|
|
1429
|
-
{ url: 'http://another.esm.js', type: 'module' },
|
|
1430
|
-
{ url: 'http://another.js', noModule: true },
|
|
1431
|
-
'http://simplescript.js'
|
|
1432
|
-
]);
|
|
1433
|
-
```
|
|
1434
1317
|
|
|
1435
1318
|
|
|
1436
1319
|
##### Returns
|
|
1437
1320
|
|
|
1438
1321
|
|
|
1439
|
-
-
|
|
1322
|
+
- an dataset structure
|
|
1440
1323
|
|
|
1441
1324
|
|
|
1442
1325
|
|
|
1443
|
-
####
|
|
1326
|
+
#### buildFilter(uFilter)
|
|
1444
1327
|
|
|
1445
|
-
|
|
1446
|
-
return a Promise that is resolved when the script is loaded
|
|
1328
|
+
Gets an filter structure for the UI filter data
|
|
1447
1329
|
|
|
1448
1330
|
|
|
1449
1331
|
|
|
@@ -1452,9 +1334,7 @@ return a Promise that is resolved when the script is loaded
|
|
|
1452
1334
|
|
|
1453
1335
|
| Name | Type | Description | |
|
|
1454
1336
|
| ---- | ---- | ----------- | -------- |
|
|
1455
|
-
|
|
|
1456
|
-
| type | `String` | (Optional) it could be `module` of `text/javascript`. Default `text/javascript` | |
|
|
1457
|
-
| noModule | `boolean` | (Optional) add `momodule` attribute to script tag. Default `false` | |
|
|
1337
|
+
| uFilter | | a UI structure filter | |
|
|
1458
1338
|
|
|
1459
1339
|
|
|
1460
1340
|
|
|
@@ -1462,17 +1342,17 @@ return a Promise that is resolved when the script is loaded
|
|
|
1462
1342
|
##### Returns
|
|
1463
1343
|
|
|
1464
1344
|
|
|
1465
|
-
-
|
|
1345
|
+
- an filter structure
|
|
1466
1346
|
|
|
1467
1347
|
|
|
1468
1348
|
|
|
1469
1349
|
|
|
1470
|
-
### dist/
|
|
1350
|
+
### dist/filters/adapters/logicToFD.js
|
|
1471
1351
|
|
|
1472
1352
|
|
|
1473
|
-
####
|
|
1353
|
+
#### logicToFD(filterData, version)
|
|
1474
1354
|
|
|
1475
|
-
|
|
1355
|
+
Generates a filter data structure from the old logic structure (v2.0).
|
|
1476
1356
|
|
|
1477
1357
|
|
|
1478
1358
|
|
|
@@ -1481,8 +1361,8 @@ Validates if the given argument is empty
|
|
|
1481
1361
|
|
|
1482
1362
|
| Name | Type | Description | |
|
|
1483
1363
|
| ---- | ---- | ----------- | -------- |
|
|
1484
|
-
|
|
|
1485
|
-
|
|
|
1364
|
+
| filterData | | The old filter data structure with logic (v2.0) | |
|
|
1365
|
+
| version | | Tag for the version of the filter data structure | |
|
|
1486
1366
|
|
|
1487
1367
|
|
|
1488
1368
|
|
|
@@ -1490,19 +1370,17 @@ Validates if the given argument is empty
|
|
|
1490
1370
|
##### Returns
|
|
1491
1371
|
|
|
1492
1372
|
|
|
1493
|
-
-
|
|
1373
|
+
- a Filter Data.
|
|
1494
1374
|
|
|
1495
1375
|
|
|
1496
1376
|
|
|
1497
1377
|
|
|
1498
|
-
### dist/
|
|
1378
|
+
### dist/filters/adapters/logicToFlatUI.js
|
|
1499
1379
|
|
|
1500
1380
|
|
|
1501
|
-
####
|
|
1381
|
+
#### logicToFlatUI(logics)
|
|
1502
1382
|
|
|
1503
|
-
|
|
1504
|
-
This function recieves any variable but will return false.
|
|
1505
|
-
Validates if variable is null, undefined, or an empty string, also, the function uses isNaN native function.
|
|
1383
|
+
Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
|
|
1506
1384
|
|
|
1507
1385
|
|
|
1508
1386
|
|
|
@@ -1511,7 +1389,7 @@ Validates if variable is null, undefined, or an empty string, also, the function
|
|
|
1511
1389
|
|
|
1512
1390
|
| Name | Type | Description | |
|
|
1513
1391
|
| ---- | ---- | ----------- | -------- |
|
|
1514
|
-
|
|
|
1392
|
+
| logics | | The old logic structure (v2.0) | |
|
|
1515
1393
|
|
|
1516
1394
|
|
|
1517
1395
|
|
|
@@ -1519,18 +1397,13 @@ Validates if variable is null, undefined, or an empty string, also, the function
|
|
|
1519
1397
|
##### Returns
|
|
1520
1398
|
|
|
1521
1399
|
|
|
1522
|
-
-
|
|
1523
|
-
|
|
1524
|
-
|
|
1525
|
-
|
|
1400
|
+
- The Flattened UI Filters array
|
|
1526
1401
|
|
|
1527
|
-
### dist/general/mix/isNull.js
|
|
1528
1402
|
|
|
1529
1403
|
|
|
1530
|
-
####
|
|
1404
|
+
#### getFilter(filters, filter, getIndex)
|
|
1531
1405
|
|
|
1532
|
-
|
|
1533
|
-
useful to avoid falsify validating Number Zero (0)
|
|
1406
|
+
Get the filter or the index of the given array, validating an old filter structure.
|
|
1534
1407
|
|
|
1535
1408
|
|
|
1536
1409
|
|
|
@@ -1539,7 +1412,9 @@ useful to avoid falsify validating Number Zero (0)
|
|
|
1539
1412
|
|
|
1540
1413
|
| Name | Type | Description | |
|
|
1541
1414
|
| ---- | ---- | ----------- | -------- |
|
|
1542
|
-
|
|
|
1415
|
+
| filters | | The array of UI filters | |
|
|
1416
|
+
| filter | | The old logic structure filter | |
|
|
1417
|
+
| getIndex | | Determines if the index or returns the UI filter object | |
|
|
1543
1418
|
|
|
1544
1419
|
|
|
1545
1420
|
|
|
@@ -1547,19 +1422,13 @@ useful to avoid falsify validating Number Zero (0)
|
|
|
1547
1422
|
##### Returns
|
|
1548
1423
|
|
|
1549
1424
|
|
|
1550
|
-
-
|
|
1551
|
-
|
|
1552
|
-
|
|
1553
|
-
|
|
1425
|
+
- the index or the UI filter object
|
|
1554
1426
|
|
|
1555
|
-
### dist/general/mix/randomId.js
|
|
1556
1427
|
|
|
1557
1428
|
|
|
1558
|
-
####
|
|
1429
|
+
#### refineRankingValues(values, uiValues)
|
|
1559
1430
|
|
|
1560
|
-
|
|
1561
|
-
- If the first given argument is different than a length number, the variable is replaced by a default number
|
|
1562
|
-
- If the optional second given argument is passed the random string is permutated.
|
|
1431
|
+
Refines the values of the Ranking column type.
|
|
1563
1432
|
|
|
1564
1433
|
|
|
1565
1434
|
|
|
@@ -1568,8 +1437,8 @@ Creates a random string
|
|
|
1568
1437
|
|
|
1569
1438
|
| Name | Type | Description | |
|
|
1570
1439
|
| ---- | ---- | ----------- | -------- |
|
|
1571
|
-
|
|
|
1572
|
-
|
|
|
1440
|
+
| values | | the Array of Ranking values | |
|
|
1441
|
+
| uiValues | | Object with additional info about the values of the filter. | |
|
|
1573
1442
|
|
|
1574
1443
|
|
|
1575
1444
|
|
|
@@ -1577,19 +1446,17 @@ Creates a random string
|
|
|
1577
1446
|
##### Returns
|
|
1578
1447
|
|
|
1579
1448
|
|
|
1580
|
-
-
|
|
1449
|
+
- the array of Ranking values
|
|
1581
1450
|
|
|
1582
1451
|
|
|
1583
1452
|
|
|
1584
1453
|
|
|
1585
|
-
### dist/
|
|
1454
|
+
### dist/filters/adapters/logicToUI.js
|
|
1586
1455
|
|
|
1587
1456
|
|
|
1588
|
-
####
|
|
1457
|
+
#### logicToUI(uFilters, datasetsInfo)
|
|
1589
1458
|
|
|
1590
|
-
|
|
1591
|
-
- Useful for Object, Array and string type.
|
|
1592
|
-
- For `null` or `undefined` or else argument the returned value will be 0.
|
|
1459
|
+
Generates a UI filter structure from the old logic structure (v2.0).
|
|
1593
1460
|
|
|
1594
1461
|
|
|
1595
1462
|
|
|
@@ -1598,7 +1465,8 @@ Gets the length of the given array.
|
|
|
1598
1465
|
|
|
1599
1466
|
| Name | Type | Description | |
|
|
1600
1467
|
| ---- | ---- | ----------- | -------- |
|
|
1601
|
-
|
|
|
1468
|
+
| uFilters | | Array of filters from old logic structure | |
|
|
1469
|
+
| datasetsInfo | | Collection of datasets information | |
|
|
1602
1470
|
|
|
1603
1471
|
|
|
1604
1472
|
|
|
@@ -1606,17 +1474,17 @@ Gets the length of the given array.
|
|
|
1606
1474
|
##### Returns
|
|
1607
1475
|
|
|
1608
1476
|
|
|
1609
|
-
-
|
|
1477
|
+
- a UI Filter Data.
|
|
1610
1478
|
|
|
1611
1479
|
|
|
1612
1480
|
|
|
1613
1481
|
|
|
1614
|
-
### dist/filters/adapters/
|
|
1482
|
+
### dist/filters/adapters/transformFilters.js
|
|
1615
1483
|
|
|
1616
1484
|
|
|
1617
|
-
####
|
|
1485
|
+
#### transformFilters(oldFiltersObj, section)
|
|
1618
1486
|
|
|
1619
|
-
|
|
1487
|
+
Transform the old filters structure into the new one
|
|
1620
1488
|
|
|
1621
1489
|
|
|
1622
1490
|
|
|
@@ -1625,22 +1493,77 @@ Generates a Flattened UI filter structure from Filter Data structure.
|
|
|
1625
1493
|
|
|
1626
1494
|
| Name | Type | Description | |
|
|
1627
1495
|
| ---- | ---- | ----------- | -------- |
|
|
1628
|
-
|
|
|
1629
|
-
|
|
|
1496
|
+
| oldFiltersObj | `Object` | an object with the old filters structure | |
|
|
1497
|
+
| section | `String` | could be 'ANALYZE', 'PB', 'UM' or any other value. Deafult is 'ANYWHERE' | |
|
|
1498
|
+
|
|
1499
|
+
|
|
1500
|
+
|
|
1501
|
+
|
|
1502
|
+
##### Examples
|
|
1503
|
+
|
|
1504
|
+
```javascript
|
|
1630
1505
|
|
|
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
|
+
};
|
|
1631
1548
|
|
|
1549
|
+
const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
|
|
1550
|
+
```
|
|
1632
1551
|
|
|
1633
1552
|
|
|
1634
1553
|
##### Returns
|
|
1635
1554
|
|
|
1636
1555
|
|
|
1637
|
-
-
|
|
1556
|
+
- `Object` an object with the new filters structure
|
|
1638
1557
|
|
|
1639
1558
|
|
|
1640
1559
|
|
|
1641
|
-
#### FD21ToFlatUI(scopes, datasetsInfo)
|
|
1642
1560
|
|
|
1643
|
-
|
|
1561
|
+
### dist/filters/helpers/applyHierarchyForAggFilters.js
|
|
1562
|
+
|
|
1563
|
+
|
|
1564
|
+
#### applyHierarchyForAggFilters(chartSettings, scopes, currentScope)
|
|
1565
|
+
|
|
1566
|
+
[TODO: Make a proper description for this function]
|
|
1644
1567
|
|
|
1645
1568
|
|
|
1646
1569
|
|
|
@@ -1649,8 +1572,9 @@ Generates a Filter Builder Structure from the Filter Data structure v2.1
|
|
|
1649
1572
|
|
|
1650
1573
|
| Name | Type | Description | |
|
|
1651
1574
|
| ---- | ---- | ----------- | -------- |
|
|
1652
|
-
|
|
|
1653
|
-
|
|
|
1575
|
+
| chartSettings | | Chart Settings for the Filter Builder | |
|
|
1576
|
+
| scopes | | | |
|
|
1577
|
+
| currentScope | | | |
|
|
1654
1578
|
|
|
1655
1579
|
|
|
1656
1580
|
|
|
@@ -1658,17 +1582,17 @@ Generates a Filter Builder Structure from the Filter Data structure v2.1
|
|
|
1658
1582
|
##### Returns
|
|
1659
1583
|
|
|
1660
1584
|
|
|
1661
|
-
-
|
|
1585
|
+
-
|
|
1662
1586
|
|
|
1663
1587
|
|
|
1664
1588
|
|
|
1665
1589
|
|
|
1666
|
-
### dist/filters/
|
|
1590
|
+
### dist/filters/helpers/getAvailableScopes.js
|
|
1667
1591
|
|
|
1668
1592
|
|
|
1669
|
-
####
|
|
1593
|
+
#### getAvailableScopes(config)
|
|
1670
1594
|
|
|
1671
|
-
|
|
1595
|
+
Gets Scopes/Scope IDs by given IDs
|
|
1672
1596
|
|
|
1673
1597
|
|
|
1674
1598
|
|
|
@@ -1677,7 +1601,7 @@ Generates a Filter Logic structure from Filter Data structure.
|
|
|
1677
1601
|
|
|
1678
1602
|
| Name | Type | Description | |
|
|
1679
1603
|
| ---- | ---- | ----------- | -------- |
|
|
1680
|
-
|
|
|
1604
|
+
| config | | given Differnts IDs in order set a available scope | |
|
|
1681
1605
|
|
|
1682
1606
|
|
|
1683
1607
|
|
|
@@ -1685,13 +1609,17 @@ Generates a Filter Logic structure from Filter Data structure.
|
|
|
1685
1609
|
##### Returns
|
|
1686
1610
|
|
|
1687
1611
|
|
|
1688
|
-
- a
|
|
1612
|
+
- a Scopes/Scope IDs array
|
|
1689
1613
|
|
|
1690
1614
|
|
|
1691
1615
|
|
|
1692
|
-
#### getLogicBodyFromFD21(filterData)
|
|
1693
1616
|
|
|
1694
|
-
|
|
1617
|
+
### dist/filters/helpers/getAvailableScopesIDsByConfig.js
|
|
1618
|
+
|
|
1619
|
+
|
|
1620
|
+
#### getAvailableScopesIDsByConfig(config)
|
|
1621
|
+
|
|
1622
|
+
Gets the Scopes IDS for the Available Scope function by any config
|
|
1695
1623
|
|
|
1696
1624
|
|
|
1697
1625
|
|
|
@@ -1700,7 +1628,7 @@ Gets the logic body
|
|
|
1700
1628
|
|
|
1701
1629
|
| Name | Type | Description | |
|
|
1702
1630
|
| ---- | ---- | ----------- | -------- |
|
|
1703
|
-
|
|
|
1631
|
+
| config | | any config | |
|
|
1704
1632
|
|
|
1705
1633
|
|
|
1706
1634
|
|
|
@@ -1708,17 +1636,17 @@ Gets the logic body
|
|
|
1708
1636
|
##### Returns
|
|
1709
1637
|
|
|
1710
1638
|
|
|
1711
|
-
- a
|
|
1639
|
+
- a Available Scope IDS config
|
|
1712
1640
|
|
|
1713
1641
|
|
|
1714
1642
|
|
|
1715
1643
|
|
|
1716
|
-
### dist/filters/
|
|
1644
|
+
### dist/filters/helpers/getScopesByHierarchy.js
|
|
1717
1645
|
|
|
1718
1646
|
|
|
1719
|
-
####
|
|
1647
|
+
#### getScopesByHierarchy(scopes, currentScope)
|
|
1720
1648
|
|
|
1721
|
-
|
|
1649
|
+
[TODO: Make a description for this]
|
|
1722
1650
|
|
|
1723
1651
|
|
|
1724
1652
|
|
|
@@ -1727,8 +1655,8 @@ Generates a UI filter structure from Filter Data structure.
|
|
|
1727
1655
|
|
|
1728
1656
|
| Name | Type | Description | |
|
|
1729
1657
|
| ---- | ---- | ----------- | -------- |
|
|
1730
|
-
|
|
|
1731
|
-
|
|
|
1658
|
+
| scopes | | the collection of Scopes/Scope IDs | |
|
|
1659
|
+
| currentScope | | Current scope type | |
|
|
1732
1660
|
|
|
1733
1661
|
|
|
1734
1662
|
|
|
@@ -1736,13 +1664,17 @@ Generates a UI filter structure from Filter Data structure.
|
|
|
1736
1664
|
##### Returns
|
|
1737
1665
|
|
|
1738
1666
|
|
|
1739
|
-
-
|
|
1667
|
+
- A new array of Scopes/Scope IDs
|
|
1740
1668
|
|
|
1741
1669
|
|
|
1742
1670
|
|
|
1743
|
-
#### FD21ToUI(scopes, section, version, datasetsInfo)
|
|
1744
1671
|
|
|
1745
|
-
|
|
1672
|
+
### dist/general/function/debounce.js
|
|
1673
|
+
|
|
1674
|
+
|
|
1675
|
+
#### debounce(fn, time)
|
|
1676
|
+
|
|
1677
|
+
Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last time the debounced function was invoked.
|
|
1746
1678
|
|
|
1747
1679
|
|
|
1748
1680
|
|
|
@@ -1751,10 +1683,8 @@ Generates a UI filter Structure from the Filter Data structure v2.1
|
|
|
1751
1683
|
|
|
1752
1684
|
| Name | Type | Description | |
|
|
1753
1685
|
| ---- | ---- | ----------- | -------- |
|
|
1754
|
-
|
|
|
1755
|
-
|
|
|
1756
|
-
| version | | The version of the filter structure | |
|
|
1757
|
-
| datasetsInfo | | Collection of datasets information | |
|
|
1686
|
+
| fn | `Function` | original Function | |
|
|
1687
|
+
| time | `Number` | default 500ms | |
|
|
1758
1688
|
|
|
1759
1689
|
|
|
1760
1690
|
|
|
@@ -1762,17 +1692,17 @@ Generates a UI filter Structure from the Filter Data structure v2.1
|
|
|
1762
1692
|
##### Returns
|
|
1763
1693
|
|
|
1764
1694
|
|
|
1765
|
-
-
|
|
1695
|
+
- `Function` debounced functions
|
|
1766
1696
|
|
|
1767
1697
|
|
|
1768
1698
|
|
|
1769
1699
|
|
|
1770
|
-
### dist/
|
|
1700
|
+
### dist/general/function/throttled.js
|
|
1771
1701
|
|
|
1772
1702
|
|
|
1773
|
-
####
|
|
1703
|
+
#### throttled(fn, time)
|
|
1774
1704
|
|
|
1775
|
-
|
|
1705
|
+
Make sure to only invokes _fn_ at most once per every _time_ milliseconds
|
|
1776
1706
|
|
|
1777
1707
|
|
|
1778
1708
|
|
|
@@ -1781,7 +1711,8 @@ Generates a Filter Data Structure structure from UI Filter Data structure.
|
|
|
1781
1711
|
|
|
1782
1712
|
| Name | Type | Description | |
|
|
1783
1713
|
| ---- | ---- | ----------- | -------- |
|
|
1784
|
-
|
|
|
1714
|
+
| fn | `Function` | original Function | |
|
|
1715
|
+
| time | `Number` | default 500ms | |
|
|
1785
1716
|
|
|
1786
1717
|
|
|
1787
1718
|
|
|
@@ -1789,13 +1720,17 @@ Generates a Filter Data Structure structure from UI Filter Data structure.
|
|
|
1789
1720
|
##### Returns
|
|
1790
1721
|
|
|
1791
1722
|
|
|
1792
|
-
-
|
|
1723
|
+
- `Function` throttled function
|
|
1793
1724
|
|
|
1794
1725
|
|
|
1795
1726
|
|
|
1796
|
-
#### UI21ToFD(uFilterData, version)
|
|
1797
1727
|
|
|
1798
|
-
|
|
1728
|
+
### dist/general/array/delete.js
|
|
1729
|
+
|
|
1730
|
+
|
|
1731
|
+
#### ArrayDelete(array, index)
|
|
1732
|
+
|
|
1733
|
+
Inmutable Array Item deletion
|
|
1799
1734
|
|
|
1800
1735
|
|
|
1801
1736
|
|
|
@@ -1804,8 +1739,8 @@ Builds the Fitler Data structure from UI filter data
|
|
|
1804
1739
|
|
|
1805
1740
|
| Name | Type | Description | |
|
|
1806
1741
|
| ---- | ---- | ----------- | -------- |
|
|
1807
|
-
|
|
|
1808
|
-
|
|
|
1742
|
+
| array | `Array` | a collection of items to delete | |
|
|
1743
|
+
| index | `Number` | the position of the item to delete | |
|
|
1809
1744
|
|
|
1810
1745
|
|
|
1811
1746
|
|
|
@@ -1813,17 +1748,20 @@ Builds the Fitler Data structure from UI filter data
|
|
|
1813
1748
|
##### Returns
|
|
1814
1749
|
|
|
1815
1750
|
|
|
1816
|
-
-
|
|
1751
|
+
- a new Array or the given parameter when is empty or not an array
|
|
1817
1752
|
|
|
1818
1753
|
|
|
1819
1754
|
|
|
1820
1755
|
|
|
1821
|
-
### dist/
|
|
1756
|
+
### dist/general/array/filterNestedTree.js
|
|
1822
1757
|
|
|
1823
1758
|
|
|
1824
|
-
####
|
|
1759
|
+
#### filterNestedTree(arr, childArrKey, condition)
|
|
1825
1760
|
|
|
1826
|
-
|
|
1761
|
+
Filters a nested tree array by a custom condition on the last child node
|
|
1762
|
+
- If the given arguments are not valid, the function returns the first argument.
|
|
1763
|
+
- If the childArrKey is not matched in the object, the condition tries to resolve the filter anyway and returns an empty array.
|
|
1764
|
+
- If the condition is not fulfilled, the function returns a filtered array, probably a empty array inside of the child array
|
|
1827
1765
|
|
|
1828
1766
|
|
|
1829
1767
|
|
|
@@ -1832,8 +1770,9 @@ Generates a Flattened UI filter structure from UI Filter Data structure.
|
|
|
1832
1770
|
|
|
1833
1771
|
| Name | Type | Description | |
|
|
1834
1772
|
| ---- | ---- | ----------- | -------- |
|
|
1835
|
-
|
|
|
1836
|
-
|
|
|
1773
|
+
| arr | | nested tree array | |
|
|
1774
|
+
| childArrKey | | property representing the children array on the nested tree | |
|
|
1775
|
+
| condition | | function callback that determines if the filter is applied on the last child node of the nested tree | |
|
|
1837
1776
|
|
|
1838
1777
|
|
|
1839
1778
|
|
|
@@ -1841,13 +1780,17 @@ Generates a Flattened UI filter structure from UI Filter Data structure.
|
|
|
1841
1780
|
##### Returns
|
|
1842
1781
|
|
|
1843
1782
|
|
|
1844
|
-
-
|
|
1783
|
+
- array filtered
|
|
1845
1784
|
|
|
1846
1785
|
|
|
1847
1786
|
|
|
1848
|
-
#### UI21ToFlatUI(scopes)
|
|
1849
1787
|
|
|
1850
|
-
|
|
1788
|
+
### dist/general/array/flattenDeep.js
|
|
1789
|
+
|
|
1790
|
+
|
|
1791
|
+
#### flattenDeep(arr)
|
|
1792
|
+
|
|
1793
|
+
Flat deeply an array
|
|
1851
1794
|
|
|
1852
1795
|
|
|
1853
1796
|
|
|
@@ -1856,7 +1799,7 @@ Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
|
|
|
1856
1799
|
|
|
1857
1800
|
| Name | Type | Description | |
|
|
1858
1801
|
| ---- | ---- | ----------- | -------- |
|
|
1859
|
-
|
|
|
1802
|
+
| arr | | Array to flat deeply | |
|
|
1860
1803
|
|
|
1861
1804
|
|
|
1862
1805
|
|
|
@@ -1864,18 +1807,17 @@ Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
|
|
|
1864
1807
|
##### Returns
|
|
1865
1808
|
|
|
1866
1809
|
|
|
1867
|
-
-
|
|
1810
|
+
- flatten array
|
|
1868
1811
|
|
|
1869
1812
|
|
|
1870
1813
|
|
|
1871
1814
|
|
|
1872
|
-
### dist/
|
|
1815
|
+
### dist/general/array/getFirstIndexFromArray.js
|
|
1873
1816
|
|
|
1874
1817
|
|
|
1875
|
-
####
|
|
1818
|
+
#### getFirstIndexFromArray(array, callback)
|
|
1876
1819
|
|
|
1877
|
-
|
|
1878
|
-
Get the new property base on the old date grouping properties
|
|
1820
|
+
Gets the first index from the array by a callback condition
|
|
1879
1821
|
|
|
1880
1822
|
|
|
1881
1823
|
|
|
@@ -1884,7 +1826,8 @@ Get the new property base on the old date grouping properties
|
|
|
1884
1826
|
|
|
1885
1827
|
| Name | Type | Description | |
|
|
1886
1828
|
| ---- | ---- | ----------- | -------- |
|
|
1887
|
-
|
|
|
1829
|
+
| array | | | |
|
|
1830
|
+
| callback | | function callback | |
|
|
1888
1831
|
|
|
1889
1832
|
|
|
1890
1833
|
|
|
@@ -1892,17 +1835,17 @@ Get the new property base on the old date grouping properties
|
|
|
1892
1835
|
##### Returns
|
|
1893
1836
|
|
|
1894
1837
|
|
|
1895
|
-
-
|
|
1838
|
+
- the first index of the array. -1 when the condition is not satisfied
|
|
1896
1839
|
|
|
1897
1840
|
|
|
1898
1841
|
|
|
1899
1842
|
|
|
1900
|
-
### dist/
|
|
1843
|
+
### dist/general/array/getLastIndexFromArray.js
|
|
1901
1844
|
|
|
1902
1845
|
|
|
1903
|
-
####
|
|
1846
|
+
#### getLastIndexFromArray(array, callback)
|
|
1904
1847
|
|
|
1905
|
-
|
|
1848
|
+
Gets the last index from the array by a callback condition
|
|
1906
1849
|
|
|
1907
1850
|
|
|
1908
1851
|
|
|
@@ -1911,9 +1854,8 @@ Checks and adapts the v2.0 Filter Data Structure to the v2.1
|
|
|
1911
1854
|
|
|
1912
1855
|
| Name | Type | Description | |
|
|
1913
1856
|
| ---- | ---- | ----------- | -------- |
|
|
1914
|
-
|
|
|
1915
|
-
|
|
|
1916
|
-
| datasetsInfo | | Collection of datasets information. If getUIFilterData is true, the datasetsInfo should be mandatory | |
|
|
1857
|
+
| array | | | |
|
|
1858
|
+
| callback | | function callback | |
|
|
1917
1859
|
|
|
1918
1860
|
|
|
1919
1861
|
|
|
@@ -1921,17 +1863,18 @@ Checks and adapts the v2.0 Filter Data Structure to the v2.1
|
|
|
1921
1863
|
##### Returns
|
|
1922
1864
|
|
|
1923
1865
|
|
|
1924
|
-
-
|
|
1866
|
+
- the last index of the array. -1 when the condition is not satisfied
|
|
1925
1867
|
|
|
1926
1868
|
|
|
1927
1869
|
|
|
1928
1870
|
|
|
1929
|
-
### dist/
|
|
1871
|
+
### dist/general/mix/compareDeep.js
|
|
1930
1872
|
|
|
1931
1873
|
|
|
1932
|
-
####
|
|
1874
|
+
#### compareDeep(object1, object2)
|
|
1933
1875
|
|
|
1934
|
-
|
|
1876
|
+
Compares two objects to know if they are equals. Go across nested objects.
|
|
1877
|
+
Includes arrays in the comparison.
|
|
1935
1878
|
|
|
1936
1879
|
|
|
1937
1880
|
|
|
@@ -1940,8 +1883,8 @@ Generates a filter data structure from the flatttened UI filters.
|
|
|
1940
1883
|
|
|
1941
1884
|
| Name | Type | Description | |
|
|
1942
1885
|
| ---- | ---- | ----------- | -------- |
|
|
1943
|
-
|
|
|
1944
|
-
|
|
|
1886
|
+
| object1 | | First Object to compare | |
|
|
1887
|
+
| object2 | | Second Object to compare | |
|
|
1945
1888
|
|
|
1946
1889
|
|
|
1947
1890
|
|
|
@@ -1949,14 +1892,17 @@ Generates a filter data structure from the flatttened UI filters.
|
|
|
1949
1892
|
##### Returns
|
|
1950
1893
|
|
|
1951
1894
|
|
|
1952
|
-
-
|
|
1895
|
+
- True: objects are equal. False: Objects are not equal. Undefined: invalid
|
|
1953
1896
|
|
|
1954
1897
|
|
|
1955
1898
|
|
|
1956
|
-
#### buildScopes(fbFilters)
|
|
1957
1899
|
|
|
1958
|
-
|
|
1959
|
-
|
|
1900
|
+
### dist/general/mix/getTag.js
|
|
1901
|
+
|
|
1902
|
+
|
|
1903
|
+
#### getTag(value)
|
|
1904
|
+
|
|
1905
|
+
Gets the `toStringTag` of `value`.
|
|
1960
1906
|
|
|
1961
1907
|
|
|
1962
1908
|
|
|
@@ -1965,7 +1911,7 @@ Also, adds and organizes filters by datasets
|
|
|
1965
1911
|
|
|
1966
1912
|
| Name | Type | Description | |
|
|
1967
1913
|
| ---- | ---- | ----------- | -------- |
|
|
1968
|
-
|
|
|
1914
|
+
| value | | The value to query. | |
|
|
1969
1915
|
|
|
1970
1916
|
|
|
1971
1917
|
|
|
@@ -1973,59 +1919,73 @@ Also, adds and organizes filters by datasets
|
|
|
1973
1919
|
##### Returns
|
|
1974
1920
|
|
|
1975
1921
|
|
|
1976
|
-
-
|
|
1977
|
-
|
|
1978
|
-
|
|
1979
|
-
|
|
1980
|
-
#### buildScope(uFilter)
|
|
1981
|
-
|
|
1982
|
-
Gets an scope structure for the filter data
|
|
1983
|
-
|
|
1984
|
-
|
|
1922
|
+
- `string` Returns the `toStringTag`.
|
|
1985
1923
|
|
|
1986
1924
|
|
|
1987
|
-
##### Parameters
|
|
1988
1925
|
|
|
1989
|
-
| Name | Type | Description | |
|
|
1990
|
-
| ---- | ---- | ----------- | -------- |
|
|
1991
|
-
| uFilter | | UI structure filter | |
|
|
1992
1926
|
|
|
1927
|
+
### dist/general/mix/importScripts.js
|
|
1993
1928
|
|
|
1994
1929
|
|
|
1930
|
+
#### importScripts(scripts)
|
|
1995
1931
|
|
|
1996
|
-
|
|
1932
|
+
Import a set of external Scripts given the URL in both serie and cascade way
|
|
1997
1933
|
|
|
1998
1934
|
|
|
1999
|
-
- an scope structure
|
|
2000
1935
|
|
|
2001
1936
|
|
|
1937
|
+
##### Parameters
|
|
2002
1938
|
|
|
2003
|
-
|
|
1939
|
+
| Name | Type | Description | |
|
|
1940
|
+
| ---- | ---- | ----------- | -------- |
|
|
1941
|
+
| scripts | `Array.<String>` `Array.<Object>` | can be an array of string or an array of object with the follow structure: | |
|
|
1942
|
+
| scripts.url | `String` | CDN URL | |
|
|
1943
|
+
| scripts.namespace | `String` `Function` | (Optional) if is a String, that name is evaluated on Window[namespace] object otherwise the Function is invoked expecting a Thrutly value | |
|
|
1944
|
+
| scripts.type | `String` | (Optional) it could be `module` of `text/javascript`. Default `text/javascript` | |
|
|
1945
|
+
| scripts.noModule | `Boolean` | (Optional) add `momodule` attribute to script tag. Default `false` | |
|
|
1946
|
+
| scripts.dependencies | `Array.<Object>` | an array with the same structure to load in cascade mode | |
|
|
2004
1947
|
|
|
2005
|
-
Gets an dataset structure for the filter data
|
|
2006
1948
|
|
|
2007
1949
|
|
|
2008
1950
|
|
|
1951
|
+
##### Examples
|
|
2009
1952
|
|
|
2010
|
-
|
|
1953
|
+
```javascript
|
|
1954
|
+
// 1) Simple script (paralell loading)
|
|
1955
|
+
importScripts(['http://myscript.js', 'http://another.js']);
|
|
2011
1956
|
|
|
2012
|
-
|
|
2013
|
-
|
|
2014
|
-
|
|
1957
|
+
// 2) Loading `.js` and `.esm.js` script (parallel loading)
|
|
1958
|
+
importScripts([
|
|
1959
|
+
{ url: 'http://myscript.esm.js', type: 'module' },
|
|
1960
|
+
{ url: 'http://myscript.js', noModule: true }
|
|
1961
|
+
]);
|
|
2015
1962
|
|
|
1963
|
+
// 3) import dependent scripts (cascade)
|
|
1964
|
+
importScripts([
|
|
1965
|
+
{ url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] }
|
|
1966
|
+
]);
|
|
2016
1967
|
|
|
1968
|
+
// 4) mix
|
|
1969
|
+
importScripts([
|
|
1970
|
+
{ url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] },
|
|
1971
|
+
{ url: 'http://another.esm.js', type: 'module' },
|
|
1972
|
+
{ url: 'http://another.js', noModule: true },
|
|
1973
|
+
'http://simplescript.js'
|
|
1974
|
+
]);
|
|
1975
|
+
```
|
|
2017
1976
|
|
|
2018
1977
|
|
|
2019
1978
|
##### Returns
|
|
2020
1979
|
|
|
2021
1980
|
|
|
2022
|
-
-
|
|
1981
|
+
- `Promise` Promise when all script have been loaded
|
|
2023
1982
|
|
|
2024
1983
|
|
|
2025
1984
|
|
|
2026
|
-
####
|
|
1985
|
+
#### loadScript(url, type, noModule)
|
|
2027
1986
|
|
|
2028
|
-
|
|
1987
|
+
Creates the script element and appends to document.head
|
|
1988
|
+
return a Promise that is resolved when the script is loaded
|
|
2029
1989
|
|
|
2030
1990
|
|
|
2031
1991
|
|
|
@@ -2034,7 +1994,9 @@ Gets an filter structure for the filter data
|
|
|
2034
1994
|
|
|
2035
1995
|
| Name | Type | Description | |
|
|
2036
1996
|
| ---- | ---- | ----------- | -------- |
|
|
2037
|
-
|
|
|
1997
|
+
| url | `String` | Cdn Url | |
|
|
1998
|
+
| type | `String` | (Optional) it could be `module` of `text/javascript`. Default `text/javascript` | |
|
|
1999
|
+
| noModule | `boolean` | (Optional) add `momodule` attribute to script tag. Default `false` | |
|
|
2038
2000
|
|
|
2039
2001
|
|
|
2040
2002
|
|
|
@@ -2042,18 +2004,17 @@ Gets an filter structure for the filter data
|
|
|
2042
2004
|
##### Returns
|
|
2043
2005
|
|
|
2044
2006
|
|
|
2045
|
-
-
|
|
2007
|
+
- `Void`
|
|
2046
2008
|
|
|
2047
2009
|
|
|
2048
2010
|
|
|
2049
2011
|
|
|
2050
|
-
### dist/
|
|
2012
|
+
### dist/general/mix/isEmpty.js
|
|
2051
2013
|
|
|
2052
2014
|
|
|
2053
|
-
####
|
|
2015
|
+
#### isEmpty(variable, includeFalsy)
|
|
2054
2016
|
|
|
2055
|
-
|
|
2056
|
-
Gets an adapted filter value array. Validates the enabled property and sets
|
|
2017
|
+
Validates if the given argument is empty
|
|
2057
2018
|
|
|
2058
2019
|
|
|
2059
2020
|
|
|
@@ -2062,7 +2023,8 @@ Gets an adapted filter value array. Validates the enabled property and sets
|
|
|
2062
2023
|
|
|
2063
2024
|
| Name | Type | Description | |
|
|
2064
2025
|
| ---- | ---- | ----------- | -------- |
|
|
2065
|
-
|
|
|
2026
|
+
| variable | | the given variable | |
|
|
2027
|
+
| includeFalsy | | flag to determine include the falsy variables into the validation | |
|
|
2066
2028
|
|
|
2067
2029
|
|
|
2068
2030
|
|
|
@@ -2070,17 +2032,19 @@ Gets an adapted filter value array. Validates the enabled property and sets
|
|
|
2070
2032
|
##### Returns
|
|
2071
2033
|
|
|
2072
2034
|
|
|
2073
|
-
-
|
|
2035
|
+
- true: the given argument is empty; false: is not.
|
|
2074
2036
|
|
|
2075
2037
|
|
|
2076
2038
|
|
|
2077
2039
|
|
|
2078
|
-
### dist/
|
|
2040
|
+
### dist/general/mix/isNaNV2.js
|
|
2079
2041
|
|
|
2080
2042
|
|
|
2081
|
-
####
|
|
2043
|
+
#### isNaNV2(variable)
|
|
2082
2044
|
|
|
2083
|
-
|
|
2045
|
+
Validates if the recieved number is NaN type.
|
|
2046
|
+
This function recieves any variable but will return false.
|
|
2047
|
+
Validates if variable is null, undefined, or an empty string, also, the function uses isNaN native function.
|
|
2084
2048
|
|
|
2085
2049
|
|
|
2086
2050
|
|
|
@@ -2089,7 +2053,7 @@ Generates a Logic structure from flattened UI filters
|
|
|
2089
2053
|
|
|
2090
2054
|
| Name | Type | Description | |
|
|
2091
2055
|
| ---- | ---- | ----------- | -------- |
|
|
2092
|
-
|
|
|
2056
|
+
| variable | | the variable to validate | |
|
|
2093
2057
|
|
|
2094
2058
|
|
|
2095
2059
|
|
|
@@ -2097,17 +2061,18 @@ Generates a Logic structure from flattened UI filters
|
|
|
2097
2061
|
##### Returns
|
|
2098
2062
|
|
|
2099
2063
|
|
|
2100
|
-
-
|
|
2064
|
+
- True if variable is a NaN or false otherwise
|
|
2101
2065
|
|
|
2102
2066
|
|
|
2103
2067
|
|
|
2104
2068
|
|
|
2105
|
-
### dist/
|
|
2069
|
+
### dist/general/mix/isNull.js
|
|
2106
2070
|
|
|
2107
2071
|
|
|
2108
|
-
####
|
|
2072
|
+
#### isNull(arg)
|
|
2109
2073
|
|
|
2110
|
-
|
|
2074
|
+
return if a given variable is either `null` or `undefined`
|
|
2075
|
+
useful to avoid falsify validating Number Zero (0)
|
|
2111
2076
|
|
|
2112
2077
|
|
|
2113
2078
|
|
|
@@ -2116,7 +2081,7 @@ Generates a Logic structure from flattened UI filters
|
|
|
2116
2081
|
|
|
2117
2082
|
| Name | Type | Description | |
|
|
2118
2083
|
| ---- | ---- | ----------- | -------- |
|
|
2119
|
-
|
|
|
2084
|
+
| arg | `any` | | |
|
|
2120
2085
|
|
|
2121
2086
|
|
|
2122
2087
|
|
|
@@ -2124,17 +2089,19 @@ Generates a Logic structure from flattened UI filters
|
|
|
2124
2089
|
##### Returns
|
|
2125
2090
|
|
|
2126
2091
|
|
|
2127
|
-
-
|
|
2092
|
+
- `Boolean`
|
|
2128
2093
|
|
|
2129
2094
|
|
|
2130
2095
|
|
|
2131
2096
|
|
|
2132
|
-
### dist/
|
|
2097
|
+
### dist/general/mix/randomId.js
|
|
2133
2098
|
|
|
2134
2099
|
|
|
2135
|
-
####
|
|
2100
|
+
#### randomId(length, exclude)
|
|
2136
2101
|
|
|
2137
|
-
|
|
2102
|
+
Creates a random string
|
|
2103
|
+
- If the first given argument is different than a length number, the variable is replaced by a default number
|
|
2104
|
+
- If the optional second given argument is passed the random string is permutated.
|
|
2138
2105
|
|
|
2139
2106
|
|
|
2140
2107
|
|
|
@@ -2143,8 +2110,8 @@ Generates a UI filter data structure from the flatttened UI filters.
|
|
|
2143
2110
|
|
|
2144
2111
|
| Name | Type | Description | |
|
|
2145
2112
|
| ---- | ---- | ----------- | -------- |
|
|
2146
|
-
|
|
|
2147
|
-
|
|
|
2113
|
+
| length | `Number` | size of the generated string. Default 8 | |
|
|
2114
|
+
| exclude | `Array` | collection of strings that is going to be excluded of the random string. | |
|
|
2148
2115
|
|
|
2149
2116
|
|
|
2150
2117
|
|
|
@@ -2152,14 +2119,19 @@ Generates a UI filter data structure from the flatttened UI filters.
|
|
|
2152
2119
|
##### Returns
|
|
2153
2120
|
|
|
2154
2121
|
|
|
2155
|
-
-
|
|
2122
|
+
- `String` Random string
|
|
2156
2123
|
|
|
2157
2124
|
|
|
2158
2125
|
|
|
2159
|
-
#### buildScopes(fbFilters)
|
|
2160
2126
|
|
|
2161
|
-
|
|
2162
|
-
|
|
2127
|
+
### dist/general/mix/size.js
|
|
2128
|
+
|
|
2129
|
+
|
|
2130
|
+
#### size(obj)
|
|
2131
|
+
|
|
2132
|
+
Gets the length of the given array.
|
|
2133
|
+
- Useful for Object, Array and string type.
|
|
2134
|
+
- For `null` or `undefined` or else argument the returned value will be 0.
|
|
2163
2135
|
|
|
2164
2136
|
|
|
2165
2137
|
|
|
@@ -2168,7 +2140,7 @@ Also, adds and organizes filters by datasets
|
|
|
2168
2140
|
|
|
2169
2141
|
| Name | Type | Description | |
|
|
2170
2142
|
| ---- | ---- | ----------- | -------- |
|
|
2171
|
-
|
|
|
2143
|
+
| obj | `Any` | Any object-type variable | |
|
|
2172
2144
|
|
|
2173
2145
|
|
|
2174
2146
|
|
|
@@ -2176,13 +2148,18 @@ Also, adds and organizes filters by datasets
|
|
|
2176
2148
|
##### Returns
|
|
2177
2149
|
|
|
2178
2150
|
|
|
2179
|
-
-
|
|
2151
|
+
- `Number` the size of the given variable
|
|
2180
2152
|
|
|
2181
2153
|
|
|
2182
2154
|
|
|
2183
|
-
#### buildScope(uFilter)
|
|
2184
2155
|
|
|
2185
|
-
|
|
2156
|
+
### dist/general/object/cloneDeep.js
|
|
2157
|
+
|
|
2158
|
+
|
|
2159
|
+
#### cloneDeep(obj)
|
|
2160
|
+
|
|
2161
|
+
A simple Deep Cloning function. Valid only for primivite values and object with primitive values.
|
|
2162
|
+
Not to use this function with inner objects and functions
|
|
2186
2163
|
|
|
2187
2164
|
|
|
2188
2165
|
|
|
@@ -2191,7 +2168,7 @@ Gets an scope structure for the UI filter data
|
|
|
2191
2168
|
|
|
2192
2169
|
| Name | Type | Description | |
|
|
2193
2170
|
| ---- | ---- | ----------- | -------- |
|
|
2194
|
-
|
|
|
2171
|
+
| obj | | The object | |
|
|
2195
2172
|
|
|
2196
2173
|
|
|
2197
2174
|
|
|
@@ -2199,63 +2176,82 @@ Gets an scope structure for the UI filter data
|
|
|
2199
2176
|
##### Returns
|
|
2200
2177
|
|
|
2201
2178
|
|
|
2202
|
-
-
|
|
2203
|
-
|
|
2179
|
+
- The new reference object or the given object if the parsing is incorrect or empty
|
|
2204
2180
|
|
|
2205
2181
|
|
|
2206
|
-
#### buildDataset(uFilter)
|
|
2207
2182
|
|
|
2208
|
-
Gets an dataset structure for the UI filter data
|
|
2209
2183
|
|
|
2184
|
+
### dist/general/object/get.js
|
|
2210
2185
|
|
|
2211
2186
|
|
|
2187
|
+
#### _get(baseObject, path, defaultValue)
|
|
2212
2188
|
|
|
2213
|
-
|
|
2189
|
+
Like lodash _.get.
|
|
2190
|
+
Gets the value at path of object. If the resolved value is undefined, the defaultValue is returned in its place.
|
|
2214
2191
|
|
|
2215
|
-
|
|
2216
|
-
|
|
2217
|
-
| uFilter | | a UI structure filter | |
|
|
2192
|
+
Empty arrays and empty objects are returned but the defaultValue is not
|
|
2193
|
+
Undefined and null values will return the defaultValue.
|
|
2218
2194
|
|
|
2219
2195
|
|
|
2220
2196
|
|
|
2221
2197
|
|
|
2222
|
-
#####
|
|
2198
|
+
##### Parameters
|
|
2223
2199
|
|
|
2200
|
+
| Name | Type | Description | |
|
|
2201
|
+
| ---- | ---- | ----------- | -------- |
|
|
2202
|
+
| baseObject | | The object to query | |
|
|
2203
|
+
| path | | The string path or collection of string paths of the property to get. | |
|
|
2204
|
+
| defaultValue | | The value returned for undefined resolved values. | |
|
|
2224
2205
|
|
|
2225
|
-
- an dataset structure
|
|
2226
2206
|
|
|
2227
2207
|
|
|
2228
2208
|
|
|
2229
|
-
|
|
2230
|
-
|
|
2231
|
-
Gets an filter structure for the UI filter data
|
|
2232
|
-
|
|
2233
|
-
|
|
2234
|
-
|
|
2235
|
-
|
|
2236
|
-
##### Parameters
|
|
2237
|
-
|
|
2238
|
-
| Name | Type | Description | |
|
|
2239
|
-
| ---- | ---- | ----------- | -------- |
|
|
2240
|
-
| uFilter | | a UI structure filter | |
|
|
2241
|
-
|
|
2209
|
+
##### Examples
|
|
2242
2210
|
|
|
2211
|
+
```javascript
|
|
2212
|
+
// returns 'Hello'
|
|
2213
|
+
_get({ item1: 'Hello', item2: 'World' }, 'item1')
|
|
2214
|
+
```
|
|
2215
|
+
```javascript
|
|
2216
|
+
// returns 'A simple Hello'
|
|
2217
|
+
_get({ item1: 'Hello', item2: 'World' }, 'item3', 'A simple Hello')
|
|
2218
|
+
```
|
|
2219
|
+
```javascript
|
|
2220
|
+
// returns 'Hello Again'
|
|
2221
|
+
_get({ item1: { item11: 'Hello Again' }, item2: {} }, 'item1.item11')
|
|
2222
|
+
```
|
|
2223
|
+
```javascript
|
|
2224
|
+
// returns 'Hello 2'
|
|
2225
|
+
_get({ item1: ['Hello 1', 'Hello 2' }, item2: [] }, 'item1[1]')
|
|
2226
|
+
```
|
|
2227
|
+
```javascript
|
|
2228
|
+
// returns 'Hello Again'
|
|
2229
|
+
_get({ item1: { item11: 'Hello Again' }, item2: {} }, ['item1', 'item11'])
|
|
2230
|
+
```
|
|
2243
2231
|
|
|
2244
2232
|
|
|
2245
2233
|
##### Returns
|
|
2246
2234
|
|
|
2247
2235
|
|
|
2248
|
-
-
|
|
2236
|
+
- the resolved value.
|
|
2249
2237
|
|
|
2250
2238
|
|
|
2251
2239
|
|
|
2252
2240
|
|
|
2253
|
-
### dist/
|
|
2241
|
+
### dist/general/object/getAttribute.js
|
|
2254
2242
|
|
|
2255
2243
|
|
|
2256
|
-
####
|
|
2244
|
+
#### getAttribute(obj, key)
|
|
2257
2245
|
|
|
2258
|
-
|
|
2246
|
+
Searchs for properties in different case styles such as: lower, upper, camel and pascal
|
|
2247
|
+
- To optimize the searching, it is required a key in a snake_case style
|
|
2248
|
+
- List of cases that do not match
|
|
2249
|
+
-- From lower to snake case
|
|
2250
|
+
-- From upper to snake case
|
|
2251
|
+
-- From lower to camel case
|
|
2252
|
+
-- From upper to camel case
|
|
2253
|
+
-- From lower to pascal case
|
|
2254
|
+
-- From upper to pascal case
|
|
2259
2255
|
|
|
2260
2256
|
|
|
2261
2257
|
|
|
@@ -2264,26 +2260,33 @@ Generates a filter data structure from the old logic structure (v2.0).
|
|
|
2264
2260
|
|
|
2265
2261
|
| Name | Type | Description | |
|
|
2266
2262
|
| ---- | ---- | ----------- | -------- |
|
|
2267
|
-
|
|
|
2268
|
-
|
|
|
2263
|
+
| obj | `object` | object to look for | |
|
|
2264
|
+
| key | `string` | String attribute in snake_case style | |
|
|
2269
2265
|
|
|
2270
2266
|
|
|
2271
2267
|
|
|
2272
2268
|
|
|
2269
|
+
##### Examples
|
|
2270
|
+
|
|
2271
|
+
```javascript
|
|
2272
|
+
getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
|
|
2273
|
+
```
|
|
2274
|
+
|
|
2275
|
+
|
|
2273
2276
|
##### Returns
|
|
2274
2277
|
|
|
2275
2278
|
|
|
2276
|
-
-
|
|
2279
|
+
- `Void`
|
|
2277
2280
|
|
|
2278
2281
|
|
|
2279
2282
|
|
|
2280
2283
|
|
|
2281
|
-
### dist/
|
|
2284
|
+
### dist/general/object/hasProperty.js
|
|
2282
2285
|
|
|
2283
2286
|
|
|
2284
|
-
####
|
|
2287
|
+
#### _hasProperty(obj, property)
|
|
2285
2288
|
|
|
2286
|
-
|
|
2289
|
+
Use the hasOwnProperty in order to verify if the given property exists in the object.
|
|
2287
2290
|
|
|
2288
2291
|
|
|
2289
2292
|
|
|
@@ -2292,46 +2295,38 @@ Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
|
|
|
2292
2295
|
|
|
2293
2296
|
| Name | Type | Description | |
|
|
2294
2297
|
| ---- | ---- | ----------- | -------- |
|
|
2295
|
-
|
|
|
2296
|
-
|
|
2297
|
-
|
|
2298
|
-
|
|
2299
|
-
|
|
2300
|
-
##### Returns
|
|
2301
|
-
|
|
2302
|
-
|
|
2303
|
-
- The Flattened UI Filters array
|
|
2304
|
-
|
|
2305
|
-
|
|
2298
|
+
| obj | `object` | an object | |
|
|
2299
|
+
| property | `string` | String to verify if exists in the object as property | |
|
|
2306
2300
|
|
|
2307
|
-
#### getFilter(filters, filter, getIndex)
|
|
2308
2301
|
|
|
2309
|
-
Get the filter or the index of the given array, validating an old filter structure.
|
|
2310
2302
|
|
|
2311
2303
|
|
|
2304
|
+
##### Examples
|
|
2312
2305
|
|
|
2306
|
+
```javascript
|
|
2307
|
+
const prop = 'prop2'
|
|
2308
|
+
const obj1 = { prop1: 'hello', prop2: 'world'}
|
|
2309
|
+
_hasProperty(ob1, prop1) // true
|
|
2313
2310
|
|
|
2314
|
-
|
|
2311
|
+
const obj2 = { prop1: 'hello world' }
|
|
2312
|
+
_hasProperty(ob1, prop2) // false
|
|
2313
|
+
```
|
|
2315
2314
|
|
|
2316
|
-
| Name | Type | Description | |
|
|
2317
|
-
| ---- | ---- | ----------- | -------- |
|
|
2318
|
-
| filters | | The array of UI filters | |
|
|
2319
|
-
| filter | | The old logic structure filter | |
|
|
2320
|
-
| getIndex | | Determines if the index or returns the UI filter object | |
|
|
2321
2315
|
|
|
2316
|
+
##### Returns
|
|
2322
2317
|
|
|
2323
2318
|
|
|
2319
|
+
- True if the object has the given property; otherwise, false.
|
|
2324
2320
|
|
|
2325
|
-
##### Returns
|
|
2326
2321
|
|
|
2327
2322
|
|
|
2328
|
-
- the index or the UI filter object
|
|
2329
2323
|
|
|
2324
|
+
### dist/general/object/isObject.js
|
|
2330
2325
|
|
|
2331
2326
|
|
|
2332
|
-
####
|
|
2327
|
+
#### isObject(obj)
|
|
2333
2328
|
|
|
2334
|
-
|
|
2329
|
+
Checks if the given argument is an object type
|
|
2335
2330
|
|
|
2336
2331
|
|
|
2337
2332
|
|
|
@@ -2340,8 +2335,7 @@ Refines the values of the Ranking column type.
|
|
|
2340
2335
|
|
|
2341
2336
|
| Name | Type | Description | |
|
|
2342
2337
|
| ---- | ---- | ----------- | -------- |
|
|
2343
|
-
|
|
|
2344
|
-
| uiValues | | Object with additional info about the values of the filter. | |
|
|
2338
|
+
| obj | | the variable to check | |
|
|
2345
2339
|
|
|
2346
2340
|
|
|
2347
2341
|
|
|
@@ -2349,17 +2343,18 @@ Refines the values of the Ranking column type.
|
|
|
2349
2343
|
##### Returns
|
|
2350
2344
|
|
|
2351
2345
|
|
|
2352
|
-
-
|
|
2346
|
+
- True: It is an object; False: It is not.
|
|
2353
2347
|
|
|
2354
2348
|
|
|
2355
2349
|
|
|
2356
2350
|
|
|
2357
|
-
### dist/
|
|
2351
|
+
### dist/general/object/mapValues.js
|
|
2358
2352
|
|
|
2359
2353
|
|
|
2360
|
-
####
|
|
2354
|
+
#### mapValues(baseObject, iteratee)
|
|
2361
2355
|
|
|
2362
|
-
|
|
2356
|
+
Invoke iteratee (function) for each object key-value pair
|
|
2357
|
+
and return a mapped object
|
|
2363
2358
|
|
|
2364
2359
|
|
|
2365
2360
|
|
|
@@ -2368,8 +2363,8 @@ Generates a UI filter structure from the old logic structure (v2.0).
|
|
|
2368
2363
|
|
|
2369
2364
|
| Name | Type | Description | |
|
|
2370
2365
|
| ---- | ---- | ----------- | -------- |
|
|
2371
|
-
|
|
|
2372
|
-
|
|
|
2366
|
+
| baseObject | `Object` | Base object. | |
|
|
2367
|
+
| iteratee | `Function` | The executed per iteration. | |
|
|
2373
2368
|
|
|
2374
2369
|
|
|
2375
2370
|
|
|
@@ -2377,17 +2372,18 @@ Generates a UI filter structure from the old logic structure (v2.0).
|
|
|
2377
2372
|
##### Returns
|
|
2378
2373
|
|
|
2379
2374
|
|
|
2380
|
-
-
|
|
2375
|
+
- `Object` New mapped object.
|
|
2381
2376
|
|
|
2382
2377
|
|
|
2383
2378
|
|
|
2384
2379
|
|
|
2385
|
-
### dist/
|
|
2380
|
+
### dist/general/object/mergeDeep.js
|
|
2386
2381
|
|
|
2387
2382
|
|
|
2388
|
-
####
|
|
2383
|
+
#### mergeDeep(obj1, obj2, settings)
|
|
2389
2384
|
|
|
2390
|
-
|
|
2385
|
+
Merges two objects into a new one.
|
|
2386
|
+
The second given argument to the first given argument.
|
|
2391
2387
|
|
|
2392
2388
|
|
|
2393
2389
|
|
|
@@ -2396,79 +2392,9 @@ Transform the old filters structure into the new one
|
|
|
2396
2392
|
|
|
2397
2393
|
| Name | Type | Description | |
|
|
2398
2394
|
| ---- | ---- | ----------- | -------- |
|
|
2399
|
-
|
|
|
2400
|
-
|
|
|
2401
|
-
|
|
2402
|
-
|
|
2403
|
-
|
|
2404
|
-
|
|
2405
|
-
##### Examples
|
|
2406
|
-
|
|
2407
|
-
```javascript
|
|
2408
|
-
|
|
2409
|
-
const oldPreferenceFilters = {
|
|
2410
|
-
"WWXHAULtR-_-xYOQAdpqT__ENABLED": true,
|
|
2411
|
-
"WWXHAULtR-_-xYOQAdpqT__ALL--ENABLED": true,
|
|
2412
|
-
"WWXHAULtR-_-xYOQAdpqT__COLLAPSED": false,
|
|
2413
|
-
"WWXHAULtR-_-xYOQAdpqT__LABEL": "GLOBAL",
|
|
2414
|
-
"WWXHAULtR-_-xYOQAdpqT-_-AK4M8UV2": {
|
|
2415
|
-
"formulaId": null,
|
|
2416
|
-
"panelId": null,
|
|
2417
|
-
"values": [
|
|
2418
|
-
{
|
|
2419
|
-
"EQUALS": [
|
|
2420
|
-
{
|
|
2421
|
-
"id": "AK4M8UV2a0",
|
|
2422
|
-
"value": "A",
|
|
2423
|
-
"enabled": true,
|
|
2424
|
-
"imageUrl": null
|
|
2425
|
-
},
|
|
2426
|
-
{
|
|
2427
|
-
"id": "AK4M8UV2a1",
|
|
2428
|
-
"value": "B",
|
|
2429
|
-
"enabled": true,
|
|
2430
|
-
"imageUrl": null
|
|
2431
|
-
}
|
|
2432
|
-
]
|
|
2433
|
-
}
|
|
2434
|
-
],
|
|
2435
|
-
"bucketId": null,
|
|
2436
|
-
"text": "MC",
|
|
2437
|
-
"title": "MC",
|
|
2438
|
-
"type": "SINGLE_CHOICE",
|
|
2439
|
-
"qid": "AK4M8UV2",
|
|
2440
|
-
"dataset": {
|
|
2441
|
-
"sourceid": "xYOQAdpqT",
|
|
2442
|
-
"name": "Form All Questions",
|
|
2443
|
-
"qrveyid": "xYOQAdpqT",
|
|
2444
|
-
"text": "Form All Questions",
|
|
2445
|
-
"linkid": 0
|
|
2446
|
-
},
|
|
2447
|
-
"enabled": true,
|
|
2448
|
-
"linked": null
|
|
2449
|
-
}
|
|
2450
|
-
};
|
|
2451
|
-
|
|
2452
|
-
const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
|
|
2453
|
-
```
|
|
2454
|
-
|
|
2455
|
-
|
|
2456
|
-
##### Returns
|
|
2457
|
-
|
|
2458
|
-
|
|
2459
|
-
- `Object` an object with the new filters structure
|
|
2460
|
-
|
|
2461
|
-
|
|
2462
|
-
|
|
2463
|
-
|
|
2464
|
-
### dist/filters/classes/FilterInputErrorHandler.js
|
|
2465
|
-
|
|
2466
|
-
|
|
2467
|
-
#### new FilterInputErrorHandler()
|
|
2468
|
-
|
|
2469
|
-
|
|
2470
|
-
|
|
2471
|
-
|
|
2395
|
+
| obj1 | | The target object | |
|
|
2396
|
+
| obj2 | | The object to be merged | |
|
|
2397
|
+
| settings | | Object settings for this function | |
|
|
2472
2398
|
|
|
2473
2399
|
|
|
2474
2400
|
|
|
@@ -2476,17 +2402,13 @@ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
|
|
|
2476
2402
|
##### Returns
|
|
2477
2403
|
|
|
2478
2404
|
|
|
2479
|
-
-
|
|
2480
|
-
|
|
2481
|
-
|
|
2482
|
-
|
|
2405
|
+
- a new merged object
|
|
2483
2406
|
|
|
2484
|
-
### dist/filters/helpers/applyHierarchyForAggFilters.js
|
|
2485
2407
|
|
|
2486
2408
|
|
|
2487
|
-
####
|
|
2409
|
+
#### isValid(obj1, obj2)
|
|
2488
2410
|
|
|
2489
|
-
|
|
2411
|
+
Validates if the two arguments are objects
|
|
2490
2412
|
|
|
2491
2413
|
|
|
2492
2414
|
|
|
@@ -2495,9 +2417,8 @@ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
|
|
|
2495
2417
|
|
|
2496
2418
|
| Name | Type | Description | |
|
|
2497
2419
|
| ---- | ---- | ----------- | -------- |
|
|
2498
|
-
|
|
|
2499
|
-
|
|
|
2500
|
-
| currentScope | | | |
|
|
2420
|
+
| obj1 | | The target object | |
|
|
2421
|
+
| obj2 | | The object to be merged | |
|
|
2501
2422
|
|
|
2502
2423
|
|
|
2503
2424
|
|
|
@@ -2505,17 +2426,13 @@ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
|
|
|
2505
2426
|
##### Returns
|
|
2506
2427
|
|
|
2507
2428
|
|
|
2508
|
-
-
|
|
2509
|
-
|
|
2510
|
-
|
|
2511
|
-
|
|
2429
|
+
- true: they are valid; false: they are not
|
|
2512
2430
|
|
|
2513
|
-
### dist/filters/helpers/getAvailableScopes.js
|
|
2514
2431
|
|
|
2515
2432
|
|
|
2516
|
-
####
|
|
2433
|
+
#### getParamsToMergeDeep(settings)
|
|
2517
2434
|
|
|
2518
|
-
|
|
2435
|
+
Validates and gets the settings with all set parameters.
|
|
2519
2436
|
|
|
2520
2437
|
|
|
2521
2438
|
|
|
@@ -2524,7 +2441,7 @@ Gets Scopes/Scope IDs by given IDs
|
|
|
2524
2441
|
|
|
2525
2442
|
| Name | Type | Description | |
|
|
2526
2443
|
| ---- | ---- | ----------- | -------- |
|
|
2527
|
-
|
|
|
2444
|
+
| settings | | the settings object | |
|
|
2528
2445
|
|
|
2529
2446
|
|
|
2530
2447
|
|
|
@@ -2532,17 +2449,17 @@ Gets Scopes/Scope IDs by given IDs
|
|
|
2532
2449
|
##### Returns
|
|
2533
2450
|
|
|
2534
2451
|
|
|
2535
|
-
- a
|
|
2452
|
+
- a new settings object with all set parameters.
|
|
2536
2453
|
|
|
2537
2454
|
|
|
2538
2455
|
|
|
2539
2456
|
|
|
2540
|
-
### dist/
|
|
2457
|
+
### dist/general/object/objectCopy.js
|
|
2541
2458
|
|
|
2542
2459
|
|
|
2543
|
-
####
|
|
2460
|
+
#### objectCopy(entity, cache)
|
|
2544
2461
|
|
|
2545
|
-
|
|
2462
|
+
Created a new reference of the given argument
|
|
2546
2463
|
|
|
2547
2464
|
|
|
2548
2465
|
|
|
@@ -2551,7 +2468,8 @@ Gets the Scopes IDS for the Available Scope function by any config
|
|
|
2551
2468
|
|
|
2552
2469
|
| Name | Type | Description | |
|
|
2553
2470
|
| ---- | ---- | ----------- | -------- |
|
|
2554
|
-
|
|
|
2471
|
+
| entity | | The variable to be copied | |
|
|
2472
|
+
| cache | | | |
|
|
2555
2473
|
|
|
2556
2474
|
|
|
2557
2475
|
|
|
@@ -2559,17 +2477,17 @@ Gets the Scopes IDS for the Available Scope function by any config
|
|
|
2559
2477
|
##### Returns
|
|
2560
2478
|
|
|
2561
2479
|
|
|
2562
|
-
-
|
|
2480
|
+
- A new reference of the given argument
|
|
2563
2481
|
|
|
2564
2482
|
|
|
2565
2483
|
|
|
2566
2484
|
|
|
2567
|
-
### dist/
|
|
2485
|
+
### dist/general/object/omit.js
|
|
2568
2486
|
|
|
2569
2487
|
|
|
2570
|
-
####
|
|
2488
|
+
#### omit(obj, props)
|
|
2571
2489
|
|
|
2572
|
-
|
|
2490
|
+
return a new Object excluding attributes in _props_ list
|
|
2573
2491
|
|
|
2574
2492
|
|
|
2575
2493
|
|
|
@@ -2578,8 +2496,8 @@ Gets the Scopes IDS for the Available Scope function by any config
|
|
|
2578
2496
|
|
|
2579
2497
|
| Name | Type | Description | |
|
|
2580
2498
|
| ---- | ---- | ----------- | -------- |
|
|
2581
|
-
|
|
|
2582
|
-
|
|
|
2499
|
+
| obj | `Object` | base object | |
|
|
2500
|
+
| props | `Array.<String>` | list of attribute to exclude | |
|
|
2583
2501
|
|
|
2584
2502
|
|
|
2585
2503
|
|
|
@@ -2587,17 +2505,17 @@ Gets the Scopes IDS for the Available Scope function by any config
|
|
|
2587
2505
|
##### Returns
|
|
2588
2506
|
|
|
2589
2507
|
|
|
2590
|
-
-
|
|
2508
|
+
- `Object` clean object
|
|
2591
2509
|
|
|
2592
2510
|
|
|
2593
2511
|
|
|
2594
2512
|
|
|
2595
|
-
### dist/
|
|
2513
|
+
### dist/general/object/pick.js
|
|
2596
2514
|
|
|
2597
2515
|
|
|
2598
|
-
####
|
|
2516
|
+
#### pick(baseObject, keys)
|
|
2599
2517
|
|
|
2600
|
-
|
|
2518
|
+
return a new object just with attributes in _keys_ list
|
|
2601
2519
|
|
|
2602
2520
|
|
|
2603
2521
|
|
|
@@ -2606,8 +2524,8 @@ Get a dataset list from a collection of Qrvey IDs
|
|
|
2606
2524
|
|
|
2607
2525
|
| Name | Type | Description | |
|
|
2608
2526
|
| ---- | ---- | ----------- | -------- |
|
|
2609
|
-
|
|
|
2610
|
-
|
|
|
2527
|
+
| baseObject | `Object` | base object | |
|
|
2528
|
+
| keys | `Array.<String>` | list of attributes to preserve | |
|
|
2611
2529
|
|
|
2612
2530
|
|
|
2613
2531
|
|
|
@@ -2615,17 +2533,17 @@ Get a dataset list from a collection of Qrvey IDs
|
|
|
2615
2533
|
##### Returns
|
|
2616
2534
|
|
|
2617
2535
|
|
|
2618
|
-
-
|
|
2536
|
+
- `Object` new object just with desired attributes
|
|
2619
2537
|
|
|
2620
2538
|
|
|
2621
2539
|
|
|
2622
2540
|
|
|
2623
|
-
### dist/
|
|
2541
|
+
### dist/general/object/serialize.js
|
|
2624
2542
|
|
|
2625
2543
|
|
|
2626
|
-
####
|
|
2544
|
+
#### serialize(obj)
|
|
2627
2545
|
|
|
2628
|
-
|
|
2546
|
+
serialize object to url param
|
|
2629
2547
|
|
|
2630
2548
|
|
|
2631
2549
|
|
|
@@ -2634,8 +2552,7 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
|
|
|
2634
2552
|
|
|
2635
2553
|
| Name | Type | Description | |
|
|
2636
2554
|
| ---- | ---- | ----------- | -------- |
|
|
2637
|
-
|
|
|
2638
|
-
| params | | Object for getting precise data | |
|
|
2555
|
+
| obj | | - Object to be serialized | |
|
|
2639
2556
|
|
|
2640
2557
|
|
|
2641
2558
|
|
|
@@ -2648,12 +2565,12 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
|
|
|
2648
2565
|
|
|
2649
2566
|
|
|
2650
2567
|
|
|
2651
|
-
### dist/
|
|
2568
|
+
### dist/general/string/capitalize.js
|
|
2652
2569
|
|
|
2653
2570
|
|
|
2654
|
-
####
|
|
2571
|
+
#### capitalize(text)
|
|
2655
2572
|
|
|
2656
|
-
|
|
2573
|
+
Upper case the first letter of a given text
|
|
2657
2574
|
|
|
2658
2575
|
|
|
2659
2576
|
|
|
@@ -2662,7 +2579,7 @@ Get a dataset by Qrvey ID
|
|
|
2662
2579
|
|
|
2663
2580
|
| Name | Type | Description | |
|
|
2664
2581
|
| ---- | ---- | ----------- | -------- |
|
|
2665
|
-
|
|
|
2582
|
+
| text | `String` | | |
|
|
2666
2583
|
|
|
2667
2584
|
|
|
2668
2585
|
|
|
@@ -2670,7 +2587,7 @@ Get a dataset by Qrvey ID
|
|
|
2670
2587
|
##### Returns
|
|
2671
2588
|
|
|
2672
2589
|
|
|
2673
|
-
- a
|
|
2590
|
+
- `String` a capitalized text
|
|
2674
2591
|
|
|
2675
2592
|
|
|
2676
2593
|
|
|
@@ -2805,6 +2722,89 @@ Gets the format config
|
|
|
2805
2722
|
|
|
2806
2723
|
|
|
2807
2724
|
|
|
2725
|
+
### dist/services/api/getAllDatasets.api.js
|
|
2726
|
+
|
|
2727
|
+
|
|
2728
|
+
#### getAllDatasets(config, pickDatasets)
|
|
2729
|
+
|
|
2730
|
+
Get a dataset list from a collection of Qrvey IDs
|
|
2731
|
+
|
|
2732
|
+
|
|
2733
|
+
|
|
2734
|
+
|
|
2735
|
+
##### Parameters
|
|
2736
|
+
|
|
2737
|
+
| Name | Type | Description | |
|
|
2738
|
+
| ---- | ---- | ----------- | -------- |
|
|
2739
|
+
| config | | the widget config. Includes the appid and others configuration properties | |
|
|
2740
|
+
| pickDatasets | | Collection of Qrvey IDs for filtering the request | |
|
|
2741
|
+
|
|
2742
|
+
|
|
2743
|
+
|
|
2744
|
+
|
|
2745
|
+
##### Returns
|
|
2746
|
+
|
|
2747
|
+
|
|
2748
|
+
- a promise
|
|
2749
|
+
|
|
2750
|
+
|
|
2751
|
+
|
|
2752
|
+
|
|
2753
|
+
### dist/services/api/getAllQrveys.api.js
|
|
2754
|
+
|
|
2755
|
+
|
|
2756
|
+
#### getAllQrveys(config, params)
|
|
2757
|
+
|
|
2758
|
+
POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
|
|
2759
|
+
|
|
2760
|
+
|
|
2761
|
+
|
|
2762
|
+
|
|
2763
|
+
##### Parameters
|
|
2764
|
+
|
|
2765
|
+
| Name | Type | Description | |
|
|
2766
|
+
| ---- | ---- | ----------- | -------- |
|
|
2767
|
+
| config | | Configuration | |
|
|
2768
|
+
| params | | Object for getting precise data | |
|
|
2769
|
+
|
|
2770
|
+
|
|
2771
|
+
|
|
2772
|
+
|
|
2773
|
+
##### Returns
|
|
2774
|
+
|
|
2775
|
+
|
|
2776
|
+
- `Void`
|
|
2777
|
+
|
|
2778
|
+
|
|
2779
|
+
|
|
2780
|
+
|
|
2781
|
+
### dist/services/api/getDatasetColumns.api.js
|
|
2782
|
+
|
|
2783
|
+
|
|
2784
|
+
#### getDatasetColumns(qrveyid)
|
|
2785
|
+
|
|
2786
|
+
Get a dataset by Qrvey ID
|
|
2787
|
+
|
|
2788
|
+
|
|
2789
|
+
|
|
2790
|
+
|
|
2791
|
+
##### Parameters
|
|
2792
|
+
|
|
2793
|
+
| Name | Type | Description | |
|
|
2794
|
+
| ---- | ---- | ----------- | -------- |
|
|
2795
|
+
| qrveyid | | The Qrvey ID | |
|
|
2796
|
+
|
|
2797
|
+
|
|
2798
|
+
|
|
2799
|
+
|
|
2800
|
+
##### Returns
|
|
2801
|
+
|
|
2802
|
+
|
|
2803
|
+
- a promise
|
|
2804
|
+
|
|
2805
|
+
|
|
2806
|
+
|
|
2807
|
+
|
|
2808
2808
|
### dist/stencil/decorators/Config.js
|
|
2809
2809
|
|
|
2810
2810
|
|
|
@@ -3025,6 +3025,33 @@ Parses a string date and returns a dayjs date
|
|
|
3025
3025
|
|
|
3026
3026
|
|
|
3027
3027
|
|
|
3028
|
+
### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
|
|
3029
|
+
|
|
3030
|
+
|
|
3031
|
+
#### getFilterBuilderGeneralConfig(config)
|
|
3032
|
+
|
|
3033
|
+
Returns a filter builder config object by a any given config
|
|
3034
|
+
|
|
3035
|
+
|
|
3036
|
+
|
|
3037
|
+
|
|
3038
|
+
##### Parameters
|
|
3039
|
+
|
|
3040
|
+
| Name | Type | Description | |
|
|
3041
|
+
| ---- | ---- | ----------- | -------- |
|
|
3042
|
+
| config | | any config object | |
|
|
3043
|
+
|
|
3044
|
+
|
|
3045
|
+
|
|
3046
|
+
|
|
3047
|
+
##### Returns
|
|
3048
|
+
|
|
3049
|
+
|
|
3050
|
+
- The filter builder config object
|
|
3051
|
+
|
|
3052
|
+
|
|
3053
|
+
|
|
3054
|
+
|
|
3028
3055
|
### dist/filters/helpers/backend/buildExpression.js
|
|
3029
3056
|
|
|
3030
3057
|
|
|
@@ -3321,12 +3348,12 @@ Gets filters from the logic by the scopes hierarchy.
|
|
|
3321
3348
|
|
|
3322
3349
|
|
|
3323
3350
|
|
|
3324
|
-
### dist/filters/helpers/
|
|
3351
|
+
### dist/filters/helpers/common/areFiltersEquals.js
|
|
3325
3352
|
|
|
3326
3353
|
|
|
3327
|
-
####
|
|
3354
|
+
#### areFiltersEquals(filter1, filter2)
|
|
3328
3355
|
|
|
3329
|
-
|
|
3356
|
+
Validates if both filters are the same
|
|
3330
3357
|
|
|
3331
3358
|
|
|
3332
3359
|
|
|
@@ -3335,7 +3362,8 @@ Returns a filter builder config object by a any given config
|
|
|
3335
3362
|
|
|
3336
3363
|
| Name | Type | Description | |
|
|
3337
3364
|
| ---- | ---- | ----------- | -------- |
|
|
3338
|
-
|
|
|
3365
|
+
| filter1 | | filter 1 | |
|
|
3366
|
+
| filter2 | | filter 2 | |
|
|
3339
3367
|
|
|
3340
3368
|
|
|
3341
3369
|
|
|
@@ -3343,7 +3371,7 @@ Returns a filter builder config object by a any given config
|
|
|
3343
3371
|
##### Returns
|
|
3344
3372
|
|
|
3345
3373
|
|
|
3346
|
-
-
|
|
3374
|
+
- true: the filters are equal; false: the filters are NOT equal
|
|
3347
3375
|
|
|
3348
3376
|
|
|
3349
3377
|
|
|
@@ -3375,34 +3403,6 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
|
|
|
3375
3403
|
|
|
3376
3404
|
|
|
3377
3405
|
|
|
3378
|
-
### dist/filters/helpers/common/areFiltersEquals.js
|
|
3379
|
-
|
|
3380
|
-
|
|
3381
|
-
#### areFiltersEquals(filter1, filter2)
|
|
3382
|
-
|
|
3383
|
-
Validates if both filters are the same
|
|
3384
|
-
|
|
3385
|
-
|
|
3386
|
-
|
|
3387
|
-
|
|
3388
|
-
##### Parameters
|
|
3389
|
-
|
|
3390
|
-
| Name | Type | Description | |
|
|
3391
|
-
| ---- | ---- | ----------- | -------- |
|
|
3392
|
-
| filter1 | | filter 1 | |
|
|
3393
|
-
| filter2 | | filter 2 | |
|
|
3394
|
-
|
|
3395
|
-
|
|
3396
|
-
|
|
3397
|
-
|
|
3398
|
-
##### Returns
|
|
3399
|
-
|
|
3400
|
-
|
|
3401
|
-
- true: the filters are equal; false: the filters are NOT equal
|
|
3402
|
-
|
|
3403
|
-
|
|
3404
|
-
|
|
3405
|
-
|
|
3406
3406
|
### dist/filters/helpers/common/excludeFiltersByParams.js
|
|
3407
3407
|
|
|
3408
3408
|
|
|
@@ -3495,23 +3495,12 @@ Get an string of the properties of the given filter column.
|
|
|
3495
3495
|
|
|
3496
3496
|
|
|
3497
3497
|
|
|
3498
|
-
### dist/filters/helpers/common/
|
|
3498
|
+
### dist/filters/helpers/common/getFilterLabel.js
|
|
3499
3499
|
|
|
3500
3500
|
|
|
3501
|
-
####
|
|
3501
|
+
#### getFilterLabel(filter)
|
|
3502
3502
|
|
|
3503
|
-
|
|
3504
|
-
The order of the epression ID is:
|
|
3505
|
-
- Scope Type
|
|
3506
|
-
- scopeid
|
|
3507
|
-
- qrveyid
|
|
3508
|
-
- panelid
|
|
3509
|
-
- columnid
|
|
3510
|
-
- validator
|
|
3511
|
-
- property
|
|
3512
|
-
- Column Aggregate
|
|
3513
|
-
- Column Calculation
|
|
3514
|
-
- Optional Index
|
|
3503
|
+
Gets the Filter Label + Column label
|
|
3515
3504
|
|
|
3516
3505
|
|
|
3517
3506
|
|
|
@@ -3520,7 +3509,7 @@ The order of the epression ID is:
|
|
|
3520
3509
|
|
|
3521
3510
|
| Name | Type | Description | |
|
|
3522
3511
|
| ---- | ---- | ----------- | -------- |
|
|
3523
|
-
| filter | | the filter
|
|
3512
|
+
| filter | | the UI filter | |
|
|
3524
3513
|
|
|
3525
3514
|
|
|
3526
3515
|
|
|
@@ -3528,17 +3517,28 @@ The order of the epression ID is:
|
|
|
3528
3517
|
##### Returns
|
|
3529
3518
|
|
|
3530
3519
|
|
|
3531
|
-
- a
|
|
3520
|
+
- a sring label
|
|
3532
3521
|
|
|
3533
3522
|
|
|
3534
3523
|
|
|
3535
3524
|
|
|
3536
|
-
### dist/filters/helpers/common/
|
|
3525
|
+
### dist/filters/helpers/common/getFilterid.js
|
|
3537
3526
|
|
|
3538
3527
|
|
|
3539
|
-
####
|
|
3528
|
+
#### getFilterid(filter)
|
|
3540
3529
|
|
|
3541
|
-
|
|
3530
|
+
Get the Filter ID by the filter structure
|
|
3531
|
+
The order of the epression ID is:
|
|
3532
|
+
- Scope Type
|
|
3533
|
+
- scopeid
|
|
3534
|
+
- qrveyid
|
|
3535
|
+
- panelid
|
|
3536
|
+
- columnid
|
|
3537
|
+
- validator
|
|
3538
|
+
- property
|
|
3539
|
+
- Column Aggregate
|
|
3540
|
+
- Column Calculation
|
|
3541
|
+
- Optional Index
|
|
3542
3542
|
|
|
3543
3543
|
|
|
3544
3544
|
|
|
@@ -3547,7 +3547,7 @@ Gets the Filter Label + Column label
|
|
|
3547
3547
|
|
|
3548
3548
|
| Name | Type | Description | |
|
|
3549
3549
|
| ---- | ---- | ----------- | -------- |
|
|
3550
|
-
| filter | | the
|
|
3550
|
+
| filter | | the filter structure | |
|
|
3551
3551
|
|
|
3552
3552
|
|
|
3553
3553
|
|
|
@@ -3555,7 +3555,7 @@ Gets the Filter Label + Column label
|
|
|
3555
3555
|
##### Returns
|
|
3556
3556
|
|
|
3557
3557
|
|
|
3558
|
-
- a
|
|
3558
|
+
- a text to identify the filter
|
|
3559
3559
|
|
|
3560
3560
|
|
|
3561
3561
|
|
|
@@ -3817,12 +3817,12 @@ Validates if the given validator is a Between type
|
|
|
3817
3817
|
|
|
3818
3818
|
|
|
3819
3819
|
|
|
3820
|
-
### dist/filters/helpers/common/
|
|
3820
|
+
### dist/filters/helpers/common/isDateDistinctProperty.js
|
|
3821
3821
|
|
|
3822
3822
|
|
|
3823
|
-
####
|
|
3823
|
+
#### isDateDistinctProperty(column, property)
|
|
3824
3824
|
|
|
3825
|
-
|
|
3825
|
+
Determines if the filter column and property is a distinct group dates type
|
|
3826
3826
|
|
|
3827
3827
|
|
|
3828
3828
|
|
|
@@ -3831,7 +3831,8 @@ Validates if the given validator is a In type
|
|
|
3831
3831
|
|
|
3832
3832
|
| Name | Type | Description | |
|
|
3833
3833
|
| ---- | ---- | ----------- | -------- |
|
|
3834
|
-
|
|
|
3834
|
+
| column | | The filter column | |
|
|
3835
|
+
| property | | The filter property | |
|
|
3835
3836
|
|
|
3836
3837
|
|
|
3837
3838
|
|
|
@@ -3839,17 +3840,17 @@ Validates if the given validator is a In type
|
|
|
3839
3840
|
##### Returns
|
|
3840
3841
|
|
|
3841
3842
|
|
|
3842
|
-
-
|
|
3843
|
+
- True if the given property is included from distinct group dates type
|
|
3843
3844
|
|
|
3844
3845
|
|
|
3845
3846
|
|
|
3846
3847
|
|
|
3847
|
-
### dist/filters/helpers/common/
|
|
3848
|
+
### dist/filters/helpers/common/isInValidator.js
|
|
3848
3849
|
|
|
3849
3850
|
|
|
3850
|
-
####
|
|
3851
|
+
#### isInValidator(validator)
|
|
3851
3852
|
|
|
3852
|
-
|
|
3853
|
+
Validates if the given validator is a In type
|
|
3853
3854
|
|
|
3854
3855
|
|
|
3855
3856
|
|
|
@@ -3858,8 +3859,7 @@ Determines if the filter column and property is a distinct group dates type
|
|
|
3858
3859
|
|
|
3859
3860
|
| Name | Type | Description | |
|
|
3860
3861
|
| ---- | ---- | ----------- | -------- |
|
|
3861
|
-
|
|
|
3862
|
-
| property | | The filter property | |
|
|
3862
|
+
| validator | | The validator | |
|
|
3863
3863
|
|
|
3864
3864
|
|
|
3865
3865
|
|
|
@@ -3867,7 +3867,7 @@ Determines if the filter column and property is a distinct group dates type
|
|
|
3867
3867
|
##### Returns
|
|
3868
3868
|
|
|
3869
3869
|
|
|
3870
|
-
-
|
|
3870
|
+
- true: it is a In validator; false: it is not a In validator
|
|
3871
3871
|
|
|
3872
3872
|
|
|
3873
3873
|
|
|
@@ -4082,10 +4082,10 @@ Gets a new value structure array by merging two value structures
|
|
|
4082
4082
|
|
|
4083
4083
|
|
|
4084
4084
|
|
|
4085
|
-
### dist/filters/helpers/common/
|
|
4085
|
+
### dist/filters/helpers/common/resolveDatasetConditions.js
|
|
4086
4086
|
|
|
4087
4087
|
|
|
4088
|
-
####
|
|
4088
|
+
#### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
|
|
4089
4089
|
|
|
4090
4090
|
Resolves the conditions by given params
|
|
4091
4091
|
|
|
@@ -4096,8 +4096,8 @@ Resolves the conditions by given params
|
|
|
4096
4096
|
|
|
4097
4097
|
| Name | Type | Description | |
|
|
4098
4098
|
| ---- | ---- | ----------- | -------- |
|
|
4099
|
-
| filter | | The
|
|
4100
|
-
| params | | given parameters to validate the
|
|
4099
|
+
| filter | | The dataset structure | |
|
|
4100
|
+
| params | | given parameters to validate the dataset | |
|
|
4101
4101
|
| letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined | |
|
|
4102
4102
|
| letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. | |
|
|
4103
4103
|
|
|
@@ -4112,10 +4112,10 @@ Resolves the conditions by given params
|
|
|
4112
4112
|
|
|
4113
4113
|
|
|
4114
4114
|
|
|
4115
|
-
### dist/filters/helpers/common/
|
|
4115
|
+
### dist/filters/helpers/common/resolveFilterConditions.js
|
|
4116
4116
|
|
|
4117
4117
|
|
|
4118
|
-
####
|
|
4118
|
+
#### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
|
|
4119
4119
|
|
|
4120
4120
|
Resolves the conditions by given params
|
|
4121
4121
|
|
|
@@ -4126,8 +4126,8 @@ Resolves the conditions by given params
|
|
|
4126
4126
|
|
|
4127
4127
|
| Name | Type | Description | |
|
|
4128
4128
|
| ---- | ---- | ----------- | -------- |
|
|
4129
|
-
| filter | | The
|
|
4130
|
-
| params | | given parameters to validate the
|
|
4129
|
+
| filter | | The filter | |
|
|
4130
|
+
| params | | given parameters to validate the filter | |
|
|
4131
4131
|
| letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined | |
|
|
4132
4132
|
| letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. | |
|
|
4133
4133
|
|
|
@@ -4199,12 +4199,12 @@ Excludes Aggregate Filters in the Flattened UI Filters array
|
|
|
4199
4199
|
|
|
4200
4200
|
|
|
4201
4201
|
|
|
4202
|
-
### dist/filters/helpers/ui/
|
|
4202
|
+
### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
|
|
4203
4203
|
|
|
4204
4204
|
|
|
4205
|
-
####
|
|
4205
|
+
#### excludeUIFlatFiltersByScopes(uFilters, scopes)
|
|
4206
4206
|
|
|
4207
|
-
|
|
4207
|
+
Excludes and returns a UI Flat Filters without filters by the given scopes
|
|
4208
4208
|
|
|
4209
4209
|
|
|
4210
4210
|
|
|
@@ -4213,7 +4213,8 @@ Gets the label of the filter property
|
|
|
4213
4213
|
|
|
4214
4214
|
| Name | Type | Description | |
|
|
4215
4215
|
| ---- | ---- | ----------- | -------- |
|
|
4216
|
-
|
|
|
4216
|
+
| uFilters | | The Flatten UI Filters | |
|
|
4217
|
+
| scopes | | collection of scopes types | |
|
|
4217
4218
|
|
|
4218
4219
|
|
|
4219
4220
|
|
|
@@ -4221,17 +4222,17 @@ Gets the label of the filter property
|
|
|
4221
4222
|
##### Returns
|
|
4222
4223
|
|
|
4223
4224
|
|
|
4224
|
-
-
|
|
4225
|
+
- The new array of UI Flattened filters
|
|
4225
4226
|
|
|
4226
4227
|
|
|
4227
4228
|
|
|
4228
4229
|
|
|
4229
|
-
### dist/filters/helpers/ui/
|
|
4230
|
+
### dist/filters/helpers/ui/getFilterPropertyLabel.js
|
|
4230
4231
|
|
|
4231
4232
|
|
|
4232
|
-
####
|
|
4233
|
+
#### getFilterPropertyLabel(filter)
|
|
4233
4234
|
|
|
4234
|
-
|
|
4235
|
+
Gets the label of the filter property
|
|
4235
4236
|
|
|
4236
4237
|
|
|
4237
4238
|
|
|
@@ -4240,8 +4241,7 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
|
|
|
4240
4241
|
|
|
4241
4242
|
| Name | Type | Description | |
|
|
4242
4243
|
| ---- | ---- | ----------- | -------- |
|
|
4243
|
-
|
|
|
4244
|
-
| scopes | | collection of scopes types | |
|
|
4244
|
+
| filter | | The UI Filter | |
|
|
4245
4245
|
|
|
4246
4246
|
|
|
4247
4247
|
|
|
@@ -4249,7 +4249,7 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
|
|
|
4249
4249
|
##### Returns
|
|
4250
4250
|
|
|
4251
4251
|
|
|
4252
|
-
-
|
|
4252
|
+
- a string of the filter property label
|
|
4253
4253
|
|
|
4254
4254
|
|
|
4255
4255
|
|