@qrvey/utils 1.2.4 → 1.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/README.md +569 -569
  2. package/dist/charts/helpers/index.d.ts +3 -0
  3. package/dist/charts/helpers/index.js +3 -0
  4. package/dist/charts/helpers/isExpandableTableChart.d.ts +1 -0
  5. package/dist/charts/helpers/isExpandableTableChart.js +4 -0
  6. package/dist/charts/helpers/isSimpleTableChart.d.ts +1 -0
  7. package/dist/charts/helpers/isSimpleTableChart.js +5 -0
  8. package/dist/charts/helpers/isTableChart.d.ts +1 -0
  9. package/dist/charts/helpers/isTableChart.js +4 -0
  10. package/dist/cjs/charts/helpers/index.d.ts +3 -0
  11. package/dist/cjs/charts/helpers/index.js +15 -0
  12. package/dist/cjs/charts/helpers/isExpandableTableChart.d.ts +1 -0
  13. package/dist/cjs/charts/helpers/isExpandableTableChart.js +8 -0
  14. package/dist/cjs/charts/helpers/isSimpleTableChart.d.ts +1 -0
  15. package/dist/cjs/charts/helpers/isSimpleTableChart.js +9 -0
  16. package/dist/cjs/charts/helpers/isTableChart.d.ts +1 -0
  17. package/dist/cjs/charts/helpers/isTableChart.js +8 -0
  18. package/dist/cjs/constants/Charts.Const.d.ts +1 -0
  19. package/dist/cjs/constants/Charts.Const.js +1 -0
  20. package/dist/cjs/filters/adapters/UIToOldLogic.js +1 -0
  21. package/dist/cjs/filters/adapters/flatUIToOldLogic.js +3 -2
  22. package/dist/cjs/filters/adapters/logicToFlatUI.js +1 -1
  23. package/dist/constants/Charts.Const.d.ts +1 -0
  24. package/dist/constants/Charts.Const.js +1 -0
  25. package/dist/filters/adapters/UIToOldLogic.js +1 -0
  26. package/dist/filters/adapters/flatUIToOldLogic.js +3 -2
  27. package/dist/filters/adapters/logicToFlatUI.js +1 -1
  28. package/package.json +1 -1
  29. package/src/charts/helpers/index.ts +3 -0
  30. package/src/charts/helpers/isExpandableTableChart.ts +5 -0
  31. package/src/charts/helpers/isSimpleTableChart.ts +5 -0
  32. package/src/charts/helpers/isTableChart.ts +5 -0
  33. package/src/constants/Charts.Const.ts +1 -0
  34. package/src/filters/adapters/UIToOldLogic.ts +2 -0
  35. package/src/filters/adapters/flatUIToOldLogic.ts +4 -2
  36. package/src/filters/adapters/logicToFlatUI.ts +1 -1
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.4*
1
+ # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.8*
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/helpers/getDateByDateFormat.js
83
+ ### dist/dates/adapters/mdyDateToDate.js
84
84
 
85
85
 
86
- #### getDateByDateFormat(date, format, time)
86
+ #### mdyDateToDate(monthYearDate, time)
87
87
 
88
- Gets a Date Object instance by a Date format
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
- | date | | String with a formatted date |   |
98
- | format | | The date format |   |
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
- - a Date object, milisecond time or the same value if date format does not match.
106
+ - The date object or the date in milliseconds
108
107
 
109
108
 
110
109
 
111
110
 
112
- ### dist/dates/helpers/getDateFormatByProperty.js
111
+ ### dist/dates/adapters/monthYearToDate.js
113
112
 
114
113
 
115
- #### getDateFormatByProperty(property)
114
+ #### monthYearToDate(monthYearDate, time)
116
115
 
117
- Gets the date format by the given property
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
- | property | | The Column Property |   |
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 format
134
+ - The date object or the date in milliseconds
135
135
 
136
136
 
137
137
 
138
138
 
139
- ### dist/dates/helpers/getDateFormatRegularExpressionInArray.js
139
+ ### dist/dates/adapters/quarterYearToDate.js
140
140
 
141
141
 
142
- #### getDateFormatRegularExpressionInArray(dateFormat)
142
+ #### quarterYearToDate(quarterYearDate, time)
143
143
 
144
- Gets an array of regular expressions by the given date format
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
- | dateFormat | | the date format |   |
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
- - an array of regular expressions
162
+ - The date object or the date in milliseconds
162
163
 
163
164
 
164
165
 
165
166
 
166
- ### dist/dates/helpers/getSeparatorByDateFormat.js
167
+ ### dist/dates/adapters/weekYearToDate.js
167
168
 
168
169
 
169
- #### getSeparatorByDateFormat(format)
170
+ #### weekYearToDate(date, time)
170
171
 
171
- Gets the separator of the date format
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
- | format | | the date format |   |
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
- - a separator string
190
+ - The date object or the date in milliseconds
189
191
 
190
192
 
191
193
 
192
194
 
193
- ### dist/dates/helpers/getWeek.js
195
+ ### dist/dates/adapters/yearToDate.js
194
196
 
195
197
 
196
- #### getWeek(date)
198
+ #### yearToDate(yearDate, time)
197
199
 
198
- Gets the week number of the year
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
- | date | | the date object |   |
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
- - an object with the week, month and year.
218
+ - The date object or the date in milliseconds
217
219
 
218
220
 
219
221
 
220
222
 
221
- ### dist/dates/helpers/validateDate.js
223
+ ### dist/dates/helpers/getDateByDateFormat.js
222
224
 
223
225
 
224
- #### validateDate(date, format)
226
+ #### getDateByDateFormat(date, format, time)
225
227
 
226
- Validate a string date depending on giving format
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 of date |   |
239
- | format | | String of the format to validate |   |
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
- - True if it is valid or not. Undefined if date is undefined
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/validateDateByDateFormat.js
252
+ ### dist/dates/helpers/getDateFormatByProperty.js
253
253
 
254
254
 
255
- #### validateDateByDateFormat(date, dateForma)
255
+ #### getDateFormatByProperty(property)
256
256
 
257
- Validates the given string as Date by its date format.
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
- | date | | a string to validate as date form |   |
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
- - true: the string is a valida date
274
+ - The date format
276
275
 
277
276
 
278
277
 
279
278
 
280
- ### dist/dates/adapters/mdyDateToDate.js
279
+ ### dist/dates/helpers/getDateFormatRegularExpressionInArray.js
281
280
 
282
281
 
283
- #### mdyDateToDate(monthYearDate, time)
282
+ #### getDateFormatRegularExpressionInArray(dateFormat)
284
283
 
285
- Transforms String Date from a [mm/dd/yyyy] format to Date object.
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
- | monthYearDate | | String of [mm/dd/yyyy] date |   |
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
- - The date object or the date in milliseconds
301
+ - an array of regular expressions
304
302
 
305
303
 
306
304
 
307
305
 
308
- ### dist/dates/adapters/monthYearToDate.js
306
+ ### dist/dates/helpers/getSeparatorByDateFormat.js
309
307
 
310
308
 
311
- #### monthYearToDate(monthYearDate, time)
309
+ #### getSeparatorByDateFormat(format)
312
310
 
313
- Transforms String Date from a [Month Year] format to Date object.
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
- | monthYearDate | | String of [Month Year] date |   |
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
- - The date object or the date in milliseconds
328
+ - a separator string
332
329
 
333
330
 
334
331
 
335
332
 
336
- ### dist/dates/adapters/quarterYearToDate.js
333
+ ### dist/dates/helpers/getWeek.js
337
334
 
338
335
 
339
- #### quarterYearToDate(quarterYearDate, time)
336
+ #### getWeek(date)
340
337
 
341
- Transforms String Date from a [Quarter Year] format to Date object.
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
- | quarterYearDate | | String of [Quarter Year] date |   |
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
- - The date object or the date in milliseconds
356
+ - an object with the week, month and year.
360
357
 
361
358
 
362
359
 
363
360
 
364
- ### dist/dates/adapters/weekYearToDate.js
361
+ ### dist/dates/helpers/validateDate.js
365
362
 
366
363
 
367
- #### weekYearToDate(date, time)
364
+ #### validateDate(date, format)
368
365
 
369
- Transforms String Date from a [Week Year] format to Date object.
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 [Week Year] date |   |
379
- | time | | Flag to parse the object date to milliseconds. |   |
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
- - The date object or the date in milliseconds
387
+ - True if it is valid or not. Undefined if date is undefined
388
388
 
389
389
 
390
390
 
391
391
 
392
- ### dist/dates/adapters/yearToDate.js
392
+ ### dist/dates/helpers/validateDateByDateFormat.js
393
393
 
394
394
 
395
- #### yearToDate(yearDate, time)
395
+ #### validateDateByDateFormat(date, dateForma)
396
396
 
397
- Transforms String Date from a [Year] format to Date object.
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
- | yearDate | | String of [Year] date |   |
407
- | time | | Flag to parse the object date to milliseconds. |   |
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
- - The date object or the date in milliseconds
415
+ - true: the string is a valida date
416
416
 
417
417
 
418
418
 
@@ -688,6 +688,26 @@ Output:
688
688
 
689
689
 
690
690
 
691
+ ### dist/filters/classes/FilterInputErrorHandler.js
692
+
693
+
694
+ #### new FilterInputErrorHandler()
695
+
696
+
697
+
698
+
699
+
700
+
701
+
702
+
703
+ ##### Returns
704
+
705
+
706
+ - `Void`
707
+
708
+
709
+
710
+
691
711
  ### dist/filters/adapters/FDToFlatUI.js
692
712
 
693
713
 
@@ -946,6 +966,34 @@ Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
946
966
 
947
967
 
948
968
 
969
+ ### dist/filters/adapters/adaptDateGroupingProperty.js
970
+
971
+
972
+ #### adaptDateGroupingProperty(property)
973
+
974
+ [TODO: For 2022, eliminate this adapter]
975
+ Get the new property base on the old date grouping properties
976
+
977
+
978
+
979
+
980
+ ##### Parameters
981
+
982
+ | Name | Type | Description | |
983
+ | ---- | ---- | ----------- | -------- |
984
+ | property | | |   |
985
+
986
+
987
+
988
+
989
+ ##### Returns
990
+
991
+
992
+ -
993
+
994
+
995
+
996
+
949
997
  ### dist/filters/adapters/adaptFilterData.js
950
998
 
951
999
 
@@ -975,13 +1023,13 @@ Checks and adapts the v2.0 Filter Data Structure to the v2.1
975
1023
 
976
1024
 
977
1025
 
978
- ### dist/filters/adapters/adaptDateGroupingProperty.js
1026
+ ### dist/filters/adapters/adaptFilterValues.js
979
1027
 
980
1028
 
981
- #### adaptDateGroupingProperty(property)
1029
+ #### adaptFilterValues(filter)
982
1030
 
983
1031
  [TODO: For 2022, eliminate this adapter]
984
- Get the new property base on the old date grouping properties
1032
+ Gets an adapted filter value array. Validates the enabled property and sets
985
1033
 
986
1034
 
987
1035
 
@@ -990,7 +1038,7 @@ Get the new property base on the old date grouping properties
990
1038
 
991
1039
  | Name | Type | Description | |
992
1040
  | ---- | ---- | ----------- | -------- |
993
- | property | | |   |
1041
+ | filter | | The filter |   |
994
1042
 
995
1043
 
996
1044
 
@@ -998,7 +1046,7 @@ Get the new property base on the old date grouping properties
998
1046
  ##### Returns
999
1047
 
1000
1048
 
1001
- -
1049
+ - A new value array with the filled properties.
1002
1050
 
1003
1051
 
1004
1052
 
@@ -1124,34 +1172,6 @@ Gets an filter structure for the filter data
1124
1172
 
1125
1173
 
1126
1174
 
1127
- ### dist/filters/adapters/adaptFilterValues.js
1128
-
1129
-
1130
- #### adaptFilterValues(filter)
1131
-
1132
- [TODO: For 2022, eliminate this adapter]
1133
- Gets an adapted filter value array. Validates the enabled property and sets
1134
-
1135
-
1136
-
1137
-
1138
- ##### Parameters
1139
-
1140
- | Name | Type | Description | |
1141
- | ---- | ---- | ----------- | -------- |
1142
- | filter | | The filter |   |
1143
-
1144
-
1145
-
1146
-
1147
- ##### Returns
1148
-
1149
-
1150
- - A new value array with the filled properties.
1151
-
1152
-
1153
-
1154
-
1155
1175
  ### dist/filters/adapters/flatUIToLogic.js
1156
1176
 
1157
1177
 
@@ -1538,26 +1558,6 @@ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
1538
1558
 
1539
1559
 
1540
1560
 
1541
- ### dist/filters/classes/FilterInputErrorHandler.js
1542
-
1543
-
1544
- #### new FilterInputErrorHandler()
1545
-
1546
-
1547
-
1548
-
1549
-
1550
-
1551
-
1552
-
1553
- ##### Returns
1554
-
1555
-
1556
- - `Void`
1557
-
1558
-
1559
-
1560
-
1561
1561
  ### dist/filters/helpers/applyHierarchyForAggFilters.js
1562
1562
 
1563
1563
 
@@ -1756,12 +1756,12 @@ Flat deeply an array
1756
1756
 
1757
1757
 
1758
1758
 
1759
- ### dist/general/array/getLastIndexFromArray.js
1759
+ ### dist/general/array/getFirstIndexFromArray.js
1760
1760
 
1761
1761
 
1762
- #### getLastIndexFromArray(array, callback)
1762
+ #### getFirstIndexFromArray(array, callback)
1763
1763
 
1764
- Gets the last index from the array by a callback condition
1764
+ Gets the first index from the array by a callback condition
1765
1765
 
1766
1766
 
1767
1767
 
@@ -1779,17 +1779,17 @@ Gets the last index from the array by a callback condition
1779
1779
  ##### Returns
1780
1780
 
1781
1781
 
1782
- - the last index of the array. -1 when the condition is not satisfied
1782
+ - the first index of the array. -1 when the condition is not satisfied
1783
1783
 
1784
1784
 
1785
1785
 
1786
1786
 
1787
- ### dist/general/array/getFirstIndexFromArray.js
1787
+ ### dist/general/array/getLastIndexFromArray.js
1788
1788
 
1789
1789
 
1790
- #### getFirstIndexFromArray(array, callback)
1790
+ #### getLastIndexFromArray(array, callback)
1791
1791
 
1792
- Gets the first index from the array by a callback condition
1792
+ Gets the last index from the array by a callback condition
1793
1793
 
1794
1794
 
1795
1795
 
@@ -1807,7 +1807,7 @@ Gets the first index from the array by a callback condition
1807
1807
  ##### Returns
1808
1808
 
1809
1809
 
1810
- - the first index of the array. -1 when the condition is not satisfied
1810
+ - the last index of the array. -1 when the condition is not satisfied
1811
1811
 
1812
1812
 
1813
1813
 
@@ -2009,14 +2009,12 @@ return a Promise that is resolved when the script is loaded
2009
2009
 
2010
2010
 
2011
2011
 
2012
- ### dist/general/mix/isNaNV2.js
2012
+ ### dist/general/mix/isEmpty.js
2013
2013
 
2014
2014
 
2015
- #### isNaNV2(variable)
2015
+ #### isEmpty(variable, includeFalsy)
2016
2016
 
2017
- Validates if the recieved number is NaN type.
2018
- This function recieves any variable but will return false.
2019
- Validates if variable is null, undefined, or an empty string, also, the function uses isNaN native function.
2017
+ Validates if the given argument is empty
2020
2018
 
2021
2019
 
2022
2020
 
@@ -2025,7 +2023,8 @@ Validates if variable is null, undefined, or an empty string, also, the function
2025
2023
 
2026
2024
  | Name | Type | Description | |
2027
2025
  | ---- | ---- | ----------- | -------- |
2028
- | variable | | the variable to validate |   |
2026
+ | variable | | the given variable |   |
2027
+ | includeFalsy | | flag to determine include the falsy variables into the validation |   |
2029
2028
 
2030
2029
 
2031
2030
 
@@ -2033,17 +2032,19 @@ Validates if variable is null, undefined, or an empty string, also, the function
2033
2032
  ##### Returns
2034
2033
 
2035
2034
 
2036
- - True if variable is a NaN or false otherwise
2035
+ - true: the given argument is empty; false: is not.
2037
2036
 
2038
2037
 
2039
2038
 
2040
2039
 
2041
- ### dist/general/mix/isEmpty.js
2040
+ ### dist/general/mix/isNaNV2.js
2042
2041
 
2043
2042
 
2044
- #### isEmpty(variable, includeFalsy)
2043
+ #### isNaNV2(variable)
2045
2044
 
2046
- Validates if the given argument is empty
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.
2047
2048
 
2048
2049
 
2049
2050
 
@@ -2052,8 +2053,7 @@ Validates if the given argument is empty
2052
2053
 
2053
2054
  | Name | Type | Description | |
2054
2055
  | ---- | ---- | ----------- | -------- |
2055
- | variable | | the given variable |   |
2056
- | includeFalsy | | flag to determine include the falsy variables into the validation |   |
2056
+ | variable | | the variable to validate |   |
2057
2057
 
2058
2058
 
2059
2059
 
@@ -2061,7 +2061,7 @@ Validates if the given argument is empty
2061
2061
  ##### Returns
2062
2062
 
2063
2063
 
2064
- - true: the given argument is empty; false: is not.
2064
+ - True if variable is a NaN or false otherwise
2065
2065
 
2066
2066
 
2067
2067
 
@@ -2321,13 +2321,12 @@ _hasProperty(ob1, prop2) // false
2321
2321
 
2322
2322
 
2323
2323
 
2324
- ### dist/general/object/mapValues.js
2324
+ ### dist/general/object/isObject.js
2325
2325
 
2326
2326
 
2327
- #### mapValues(baseObject, iteratee)
2327
+ #### isObject(obj)
2328
2328
 
2329
- Invoke iteratee (function) for each object key-value pair
2330
- and return a mapped object
2329
+ Checks if the given argument is an object type
2331
2330
 
2332
2331
 
2333
2332
 
@@ -2336,8 +2335,7 @@ and return a mapped object
2336
2335
 
2337
2336
  | Name | Type | Description | |
2338
2337
  | ---- | ---- | ----------- | -------- |
2339
- | baseObject | `Object` | Base object. |   |
2340
- | iteratee | `Function` | The executed per iteration. |   |
2338
+ | obj | | the variable to check |   |
2341
2339
 
2342
2340
 
2343
2341
 
@@ -2345,17 +2343,18 @@ and return a mapped object
2345
2343
  ##### Returns
2346
2344
 
2347
2345
 
2348
- - `Object` New mapped object.
2346
+ - True: It is an object; False: It is not.
2349
2347
 
2350
2348
 
2351
2349
 
2352
2350
 
2353
- ### dist/general/object/isObject.js
2351
+ ### dist/general/object/mapValues.js
2354
2352
 
2355
2353
 
2356
- #### isObject(obj)
2354
+ #### mapValues(baseObject, iteratee)
2357
2355
 
2358
- Checks if the given argument is an object type
2356
+ Invoke iteratee (function) for each object key-value pair
2357
+ and return a mapped object
2359
2358
 
2360
2359
 
2361
2360
 
@@ -2364,7 +2363,8 @@ Checks if the given argument is an object type
2364
2363
 
2365
2364
  | Name | Type | Description | |
2366
2365
  | ---- | ---- | ----------- | -------- |
2367
- | obj | | the variable to check |   |
2366
+ | baseObject | `Object` | Base object. |   |
2367
+ | iteratee | `Function` | The executed per iteration. |   |
2368
2368
 
2369
2369
 
2370
2370
 
@@ -2372,7 +2372,7 @@ Checks if the given argument is an object type
2372
2372
  ##### Returns
2373
2373
 
2374
2374
 
2375
- - True: It is an object; False: It is not.
2375
+ - `Object` New mapped object.
2376
2376
 
2377
2377
 
2378
2378
 
@@ -2619,49 +2619,47 @@ Get an string of the properties of the given column.
2619
2619
 
2620
2620
 
2621
2621
 
2622
- ### dist/services/api/getAllDatasets.api.js
2623
-
2624
-
2625
- #### getAllDatasets(qrveyids)
2622
+ ### dist/stencil/decorators/Config.js
2626
2623
 
2627
- Get a dataset list from a collection of Qrvey IDs
2628
2624
 
2625
+ #### Config()
2629
2626
 
2627
+ Stencil.js - Prop Decorator
2628
+ Get and Parse the Widget Configuration Object and also provide the ability to get properties in different case styles such as: lower, upper, camel and pascal
2629
+ But for this, is required ask for a property in `snake_case` style
2630
2630
 
2631
2631
 
2632
- ##### Parameters
2633
2632
 
2634
- | Name | Type | Description | |
2635
- | ---- | ---- | ----------- | -------- |
2636
- | qrveyids | | Collection of Qrvey IDs |   |
2637
2633
 
2638
2634
 
2639
2635
 
2636
+ ##### Examples
2640
2637
 
2641
- ##### Returns
2638
+ ```javascript
2639
+ \ @Config() @Prop() settings;
2642
2640
 
2641
+ someMethod() {
2642
+ this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
2643
+ }
2644
+ ```
2643
2645
 
2644
- - a promise
2645
2646
 
2647
+ ##### Returns
2646
2648
 
2647
2649
 
2650
+ - `Void`
2648
2651
 
2649
- ### dist/services/api/getAllQrveys.api.js
2650
2652
 
2651
2653
 
2652
- #### getAllQrveys(config, params)
2653
2654
 
2654
- POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
2655
+ ### dist/stencil/util/createRef.js
2655
2656
 
2656
2657
 
2658
+ #### createRef()
2657
2659
 
2660
+ lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
2658
2661
 
2659
- ##### Parameters
2660
2662
 
2661
- | Name | Type | Description | |
2662
- | ---- | ---- | ----------- | -------- |
2663
- | config | | Configuration |   |
2664
- | params | | Object for getting precise data |   |
2665
2663
 
2666
2664
 
2667
2665
 
@@ -2669,17 +2667,21 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
2669
2667
  ##### Returns
2670
2668
 
2671
2669
 
2672
- - `Void`
2670
+ - function - Function to use in ref prop in html elements
2673
2671
 
2674
2672
 
2675
2673
 
2676
2674
 
2677
- ### dist/services/api/getDatasetColumns.api.js
2675
+ ### dist/stencil/util/getConfig.js
2678
2676
 
2679
2677
 
2680
- #### getDatasetColumns(qrveyid)
2678
+ #### getConfig(cfg)
2681
2679
 
2682
- Get a dataset by Qrvey ID
2680
+ verify the Config object type and try to return a parsed Object
2681
+ - In case _cfg_ is a string, first try to make a JSON parse in other case
2682
+ try to find this string as a variable on Windows object
2683
+ - If _cfg_ is a fuction, tis is invoked and parsed
2684
+ - Finally, if is an object, _cfg_ is inmediatly returned
2683
2685
 
2684
2686
 
2685
2687
 
@@ -2688,7 +2690,7 @@ Get a dataset by Qrvey ID
2688
2690
 
2689
2691
  | Name | Type | Description | |
2690
2692
  | ---- | ---- | ----------- | -------- |
2691
- | qrveyid | | The Qrvey ID |   |
2693
+ | cfg | | |   |
2692
2694
 
2693
2695
 
2694
2696
 
@@ -2696,54 +2698,44 @@ Get a dataset by Qrvey ID
2696
2698
  ##### Returns
2697
2699
 
2698
2700
 
2699
- - a promise
2700
-
2701
+ - `Void`
2701
2702
 
2702
2703
 
2703
2704
 
2704
- ### dist/stencil/decorators/Config.js
2705
2705
 
2706
+ ### dist/services/api/getAllDatasets.api.js
2706
2707
 
2707
- #### Config()
2708
2708
 
2709
- Stencil.js - Prop Decorator
2710
- Get and Parse the Widget Configuration Object and also provide the ability to get properties in different case styles such as: lower, upper, camel and pascal
2711
- But for this, is required ask for a property in `snake_case` style
2709
+ #### getAllDatasets(qrveyids)
2712
2710
 
2711
+ Get a dataset list from a collection of Qrvey IDs
2713
2712
 
2714
2713
 
2715
2714
 
2716
2715
 
2716
+ ##### Parameters
2717
2717
 
2718
- ##### Examples
2718
+ | Name | Type | Description | |
2719
+ | ---- | ---- | ----------- | -------- |
2720
+ | qrveyids | | Collection of Qrvey IDs |   |
2719
2721
 
2720
- ```javascript
2721
- \ @Config() @Prop() settings;
2722
2722
 
2723
- someMethod() {
2724
- this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
2725
- }
2726
- ```
2727
2723
 
2728
2724
 
2729
2725
  ##### Returns
2730
2726
 
2731
2727
 
2732
- - `Void`
2728
+ - a promise
2733
2729
 
2734
2730
 
2735
2731
 
2736
2732
 
2737
- ### dist/stencil/util/getConfig.js
2733
+ ### dist/services/api/getAllQrveys.api.js
2738
2734
 
2739
2735
 
2740
- #### getConfig(cfg)
2736
+ #### getAllQrveys(config, params)
2741
2737
 
2742
- verify the Config object type and try to return a parsed Object
2743
- - In case _cfg_ is a string, first try to make a JSON parse in other case
2744
- try to find this string as a variable on Windows object
2745
- - If _cfg_ is a fuction, tis is invoked and parsed
2746
- - Finally, if is an object, _cfg_ is inmediatly returned
2738
+ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
2747
2739
 
2748
2740
 
2749
2741
 
@@ -2752,7 +2744,8 @@ try to find this string as a variable on Windows object
2752
2744
 
2753
2745
  | Name | Type | Description | |
2754
2746
  | ---- | ---- | ----------- | -------- |
2755
- | cfg | | |   |
2747
+ | config | | Configuration |   |
2748
+ | params | | Object for getting precise data |   |
2756
2749
 
2757
2750
 
2758
2751
 
@@ -2765,22 +2758,29 @@ try to find this string as a variable on Windows object
2765
2758
 
2766
2759
 
2767
2760
 
2768
- ### dist/stencil/util/createRef.js
2761
+ ### dist/services/api/getDatasetColumns.api.js
2769
2762
 
2770
2763
 
2771
- #### createRef()
2764
+ #### getDatasetColumns(qrveyid)
2765
+
2766
+ Get a dataset by Qrvey ID
2772
2767
 
2773
- lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
2774
2768
 
2775
2769
 
2776
2770
 
2771
+ ##### Parameters
2772
+
2773
+ | Name | Type | Description | |
2774
+ | ---- | ---- | ----------- | -------- |
2775
+ | qrveyid | | The Qrvey ID |   |
2776
+
2777
2777
 
2778
2778
 
2779
2779
 
2780
2780
  ##### Returns
2781
2781
 
2782
2782
 
2783
- - function - Function to use in ref prop in html elements
2783
+ - a promise
2784
2784
 
2785
2785
 
2786
2786
 
@@ -2921,13 +2921,12 @@ Parses a string date and returns a dayjs date
2921
2921
 
2922
2922
 
2923
2923
 
2924
- ### dist/filters/helpers/backend/buildExpression.js
2924
+ ### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
2925
2925
 
2926
2926
 
2927
- #### buildExpression(filter)
2927
+ #### getFilterBuilderGeneralConfig(config)
2928
2928
 
2929
- Builds filter expression by the filter data.
2930
- - If the resulting value array is empty the enabled property will be false.
2929
+ Returns a filter builder config object by a any given config
2931
2930
 
2932
2931
 
2933
2932
 
@@ -2936,7 +2935,7 @@ Builds filter expression by the filter data.
2936
2935
 
2937
2936
  | Name | Type | Description | |
2938
2937
  | ---- | ---- | ----------- | -------- |
2939
- | filter | | The filter to transform |   |
2938
+ | config | | any config object |   |
2940
2939
 
2941
2940
 
2942
2941
 
@@ -2944,17 +2943,17 @@ Builds filter expression by the filter data.
2944
2943
  ##### Returns
2945
2944
 
2946
2945
 
2947
- - a filter expression
2946
+ - The filter builder config object
2948
2947
 
2949
2948
 
2950
2949
 
2951
2950
 
2952
- ### dist/filters/helpers/backend/buildUserFilters.js
2951
+ ### dist/filters/helpers/common/areFiltersEquals.js
2953
2952
 
2954
2953
 
2955
- #### buildUserFilters(userFilters)
2954
+ #### areFiltersEquals(filter1, filter2)
2956
2955
 
2957
- Transform user Filters array into Filter Logic structure
2956
+ Validates if both filters are the same
2958
2957
 
2959
2958
 
2960
2959
 
@@ -2963,7 +2962,8 @@ Transform user Filters array into Filter Logic structure
2963
2962
 
2964
2963
  | Name | Type | Description | |
2965
2964
  | ---- | ---- | ----------- | -------- |
2966
- | userFilters | | The filters that the user defined. |   |
2965
+ | filter1 | | filter 1 |   |
2966
+ | filter2 | | filter 2 |   |
2967
2967
 
2968
2968
 
2969
2969
 
@@ -2971,17 +2971,17 @@ Transform user Filters array into Filter Logic structure
2971
2971
  ##### Returns
2972
2972
 
2973
2973
 
2974
- - The filter logic for the given user filters. if No a given object is recieved, it will return an empty array.
2975
-
2974
+ - true: the filters are equal; false: the filters are NOT equal
2976
2975
 
2977
2976
 
2978
2977
 
2979
- ### dist/filters/helpers/backend/getAggFiltersBySummaryIndex.js
2980
2978
 
2979
+ ### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
2981
2980
 
2982
- #### getAggFiltersBySummaryIndex(aggFilters, summaryIndex)
2983
2981
 
2982
+ #### excludeFiltersByAggregateColumn(filterData)
2984
2983
 
2984
+ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
2985
2985
 
2986
2986
 
2987
2987
 
@@ -2990,8 +2990,7 @@ Transform user Filters array into Filter Logic structure
2990
2990
 
2991
2991
  | Name | Type | Description | |
2992
2992
  | ---- | ---- | ----------- | -------- |
2993
- | aggFilters | | |   |
2994
- | summaryIndex | | |   |
2993
+ | filterData | | The filter data object |   |
2995
2994
 
2996
2995
 
2997
2996
 
@@ -2999,17 +2998,26 @@ Transform user Filters array into Filter Logic structure
2999
2998
  ##### Returns
3000
2999
 
3001
3000
 
3002
- -
3001
+ - The new filter data object that were excluded the aggregate filters
3003
3002
 
3004
3003
 
3005
3004
 
3006
3005
 
3007
- ### dist/filters/helpers/backend/getBackendGroupValue.js
3006
+ ### dist/filters/helpers/common/excludeFiltersByParams.js
3008
3007
 
3009
3008
 
3010
- #### getBackendGroupValue(filter)
3009
+ #### excludeFiltersByParams(filterData, params)
3011
3010
 
3012
- Gets a group value for the backend logic structure
3011
+ Excludes filters from the given Filters.
3012
+ The validation to filter the stored filter is depending on:
3013
+ - Column
3014
+ - Qrvey ID
3015
+ - Scope type
3016
+ - Scope ID
3017
+ - Panel ID
3018
+ - Validator type
3019
+ - Property type
3020
+ - Enabled flags
3013
3021
 
3014
3022
 
3015
3023
 
@@ -3018,7 +3026,8 @@ Gets a group value for the backend logic structure
3018
3026
 
3019
3027
  | Name | Type | Description | |
3020
3028
  | ---- | ---- | ----------- | -------- |
3021
- | filter | | The filter |   |
3029
+ | filterData | | The Filter Data or the UI Filter Data |   |
3030
+ | params | | given parameters to validate the filter data |   |
3022
3031
 
3023
3032
 
3024
3033
 
@@ -3026,17 +3035,17 @@ Gets a group value for the backend logic structure
3026
3035
  ##### Returns
3027
3036
 
3028
3037
 
3029
- - a property
3038
+ - a new Filter object structure
3030
3039
 
3031
3040
 
3032
3041
 
3033
3042
 
3034
- ### dist/filters/helpers/backend/getBackendProperty.js
3043
+ ### dist/filters/helpers/common/excludeFiltersByScopes.js
3035
3044
 
3036
3045
 
3037
- #### getBackendProperty(filter)
3046
+ #### excludeFiltersByScopes(filterData, scopes)
3038
3047
 
3039
- Gets a property for the logic structure
3048
+ Excludes and returns a filter data without filters by the given scopes
3040
3049
 
3041
3050
 
3042
3051
 
@@ -3045,7 +3054,8 @@ Gets a property for the logic structure
3045
3054
 
3046
3055
  | Name | Type | Description | |
3047
3056
  | ---- | ---- | ----------- | -------- |
3048
- | filter | | The filter |   |
3057
+ | filterData | | The Filter Data |   |
3058
+ | scopes | | collection of scopes to be as filtering parameters |   |
3049
3059
 
3050
3060
 
3051
3061
 
@@ -3053,17 +3063,17 @@ Gets a property for the logic structure
3053
3063
  ##### Returns
3054
3064
 
3055
3065
 
3056
- - a property
3066
+ - The new Filter Data without filters by the given scopes.
3057
3067
 
3058
3068
 
3059
3069
 
3060
3070
 
3061
- ### dist/filters/helpers/backend/getBackendValidator.js
3071
+ ### dist/filters/helpers/common/getFilterColumnLabel.js
3062
3072
 
3063
3073
 
3064
- #### getBackendValidator(validator)
3074
+ #### getFilterColumnLabel(column)
3065
3075
 
3066
- Gets the Validator that is used in requests
3076
+ Get an string of the properties of the given filter column.
3067
3077
 
3068
3078
 
3069
3079
 
@@ -3072,7 +3082,7 @@ Gets the Validator that is used in requests
3072
3082
 
3073
3083
  | Name | Type | Description | |
3074
3084
  | ---- | ---- | ----------- | -------- |
3075
- | validator | | Filter Validator used in UI |   |
3085
+ | column | | The filter column |   |
3076
3086
 
3077
3087
 
3078
3088
 
@@ -3080,17 +3090,17 @@ Gets the Validator that is used in requests
3080
3090
  ##### Returns
3081
3091
 
3082
3092
 
3083
- - Filter Validator used in Backend
3093
+ - an string with the property, aggregate or calculation label.
3084
3094
 
3085
3095
 
3086
3096
 
3087
3097
 
3088
- ### dist/filters/helpers/backend/getBackendValues.js
3098
+ ### dist/filters/helpers/common/getFilterLabel.js
3089
3099
 
3090
3100
 
3091
- #### getBackendValues(filter)
3101
+ #### getFilterLabel(filter)
3092
3102
 
3093
- Gets the expresion values in the logic format
3103
+ Gets the Filter Label + Column label
3094
3104
 
3095
3105
 
3096
3106
 
@@ -3099,7 +3109,7 @@ Gets the expresion values in the logic format
3099
3109
 
3100
3110
  | Name | Type | Description | |
3101
3111
  | ---- | ---- | ----------- | -------- |
3102
- | filter | | The filter structure |   |
3112
+ | filter | | the UI filter |   |
3103
3113
 
3104
3114
 
3105
3115
 
@@ -3107,23 +3117,37 @@ Gets the expresion values in the logic format
3107
3117
  ##### Returns
3108
3118
 
3109
3119
 
3110
- - A collection of backend expression value
3111
-
3112
-
3120
+ - a sring label
3113
3121
 
3114
- #### getResultValues(values, filter)
3115
3122
 
3116
- Gets the expression values. Depending on the column type
3117
3123
 
3118
3124
 
3125
+ ### dist/filters/helpers/common/getFilterid.js
3119
3126
 
3120
3127
 
3121
- ##### Parameters
3128
+ #### getFilterid(filter)
3122
3129
 
3123
- | Name | Type | Description | |
3130
+ Get the Filter ID by the filter structure
3131
+ The order of the epression ID is:
3132
+ - Scope Type
3133
+ - scopeid
3134
+ - qrveyid
3135
+ - panelid
3136
+ - columnid
3137
+ - validator
3138
+ - property
3139
+ - Column Aggregate
3140
+ - Column Calculation
3141
+ - Optional Index
3142
+
3143
+
3144
+
3145
+
3146
+ ##### Parameters
3147
+
3148
+ | Name | Type | Description | |
3124
3149
  | ---- | ---- | ----------- | -------- |
3125
- | values | | a collection of filter values |   |
3126
- | filter | | The filter structure |   |
3150
+ | filter | | the filter structure |   |
3127
3151
 
3128
3152
 
3129
3153
 
@@ -3131,13 +3155,17 @@ Gets the expression values. Depending on the column type
3131
3155
  ##### Returns
3132
3156
 
3133
3157
 
3134
- -
3158
+ - a text to identify the filter
3135
3159
 
3136
3160
 
3137
3161
 
3138
- #### getRankingValues(values, rankingGroupIndex)
3139
3162
 
3140
- Gets the Ranking values.
3163
+ ### dist/filters/helpers/common/getFiltersByAggregateColumn.js
3164
+
3165
+
3166
+ #### getFiltersByAggregateColumn(filterData)
3167
+
3168
+ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
3141
3169
 
3142
3170
 
3143
3171
 
@@ -3146,8 +3174,7 @@ Gets the Ranking values.
3146
3174
 
3147
3175
  | Name | Type | Description | |
3148
3176
  | ---- | ---- | ----------- | -------- |
3149
- | values | | a collection of filter values in the ranking structure |   |
3150
- | rankingGroupIndex | | determine the value by this index to build and return it |   |
3177
+ | filterData | | The filter data object |   |
3151
3178
 
3152
3179
 
3153
3180
 
@@ -3155,17 +3182,26 @@ Gets the Ranking values.
3155
3182
  ##### Returns
3156
3183
 
3157
3184
 
3158
- - Expression values for ranking
3185
+ - The new filter data object that were get the aggregate filters
3159
3186
 
3160
3187
 
3161
3188
 
3162
3189
 
3163
- ### dist/filters/helpers/backend/getLogicByScopes.js
3190
+ ### dist/filters/helpers/common/getFiltersByParams.js
3164
3191
 
3165
3192
 
3166
- #### getLogicByScopes(logics, scopes)
3193
+ #### getFiltersByParams(filterData, params)
3167
3194
 
3168
- Gets the filters from logic data by Scopes/Scope IDs.
3195
+ Gets filters from the given params.
3196
+ The validation to filter the stored filter is depending on:
3197
+ - Column
3198
+ - Qrvey ID
3199
+ - Scope type
3200
+ - Scope ID
3201
+ - Panel ID
3202
+ - Validator type
3203
+ - Property type
3204
+ - Enabled flags
3169
3205
 
3170
3206
 
3171
3207
 
@@ -3174,8 +3210,8 @@ Gets the filters from logic data by Scopes/Scope IDs.
3174
3210
 
3175
3211
  | Name | Type | Description | |
3176
3212
  | ---- | ---- | ----------- | -------- |
3177
- | logics | | The logic array |   |
3178
- | scopes | | The collection of Scopes/Scope IDs |   |
3213
+ | filterData | | The Filter Data or the UI Filter Data |   |
3214
+ | params | | given parameters to validate the dataset |   |
3179
3215
 
3180
3216
 
3181
3217
 
@@ -3183,17 +3219,17 @@ Gets the filters from logic data by Scopes/Scope IDs.
3183
3219
  ##### Returns
3184
3220
 
3185
3221
 
3186
- - a new Logic array
3222
+ - a new Filter object structure
3187
3223
 
3188
3224
 
3189
3225
 
3190
3226
 
3191
- ### dist/filters/helpers/backend/getLogicByScopesHierarchy.js
3227
+ ### dist/filters/helpers/common/getFiltersByScopes.js
3192
3228
 
3193
3229
 
3194
- #### getLogicByScopesHierarchy(filterData, scopes, currentScope)
3230
+ #### getFiltersByScopes(filterData, scopes)
3195
3231
 
3196
- Gets filters from the logic by the scopes hierarchy.
3232
+ Filters and gets a Filter Data by the given scopes
3197
3233
 
3198
3234
 
3199
3235
 
@@ -3202,9 +3238,8 @@ Gets filters from the logic by the scopes hierarchy.
3202
3238
 
3203
3239
  | Name | Type | Description | |
3204
3240
  | ---- | ---- | ----------- | -------- |
3205
- | filterData | | |   |
3206
- | scopes | | |   |
3207
- | currentScope | | |   |
3241
+ | filterData | | The Filter Data |   |
3242
+ | scopes | | collection of scopes types |   |
3208
3243
 
3209
3244
 
3210
3245
 
@@ -3212,17 +3247,17 @@ Gets filters from the logic by the scopes hierarchy.
3212
3247
  ##### Returns
3213
3248
 
3214
3249
 
3215
- - a new array of Logic
3250
+ - The new Filter Data
3216
3251
 
3217
3252
 
3218
3253
 
3219
3254
 
3220
- ### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
3255
+ ### dist/filters/helpers/common/getFiltersByScopesIds.js
3221
3256
 
3222
3257
 
3223
- #### getFilterBuilderGeneralConfig(config)
3258
+ #### getFiltersByScopesIds(filterData, scopes)
3224
3259
 
3225
- Returns a filter builder config object by a any given config
3260
+ Gets filters from Filter Data by Scopes/Scope IDs.
3226
3261
 
3227
3262
 
3228
3263
 
@@ -3231,7 +3266,8 @@ Returns a filter builder config object by a any given config
3231
3266
 
3232
3267
  | Name | Type | Description | |
3233
3268
  | ---- | ---- | ----------- | -------- |
3234
- | config | | any config object |   |
3269
+ | filterData | | The filter data |   |
3270
+ | scopes | | The collection of Scopes/Scope IDs |   |
3235
3271
 
3236
3272
 
3237
3273
 
@@ -3239,17 +3275,17 @@ Returns a filter builder config object by a any given config
3239
3275
  ##### Returns
3240
3276
 
3241
3277
 
3242
- - The filter builder config object
3278
+ - a new Filter Data
3243
3279
 
3244
3280
 
3245
3281
 
3246
3282
 
3247
- ### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
3283
+ ### dist/filters/helpers/common/getFiltersByVisibility.js
3248
3284
 
3249
3285
 
3250
- #### excludeUIFiltersByAggregate(uFilters)
3286
+ #### getFiltersByVisibility(filterData, scopes)
3251
3287
 
3252
- Excludes Aggregate Filters in the Flattened UI Filters array
3288
+ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
3253
3289
 
3254
3290
 
3255
3291
 
@@ -3258,7 +3294,8 @@ Excludes Aggregate Filters in the Flattened UI Filters array
3258
3294
 
3259
3295
  | Name | Type | Description | |
3260
3296
  | ---- | ---- | ----------- | -------- |
3261
- | uFilters | | Collection of Flat UI Filters |   |
3297
+ | filterData | | a Filter Data or UI Filter Data |   |
3298
+ | scopes | | a Scopes/Scope IDs array |   |
3262
3299
 
3263
3300
 
3264
3301
 
@@ -3266,17 +3303,17 @@ Excludes Aggregate Filters in the Flattened UI Filters array
3266
3303
  ##### Returns
3267
3304
 
3268
3305
 
3269
- - a new Flat UI Filters that were excluded the aggregate filters
3306
+ - a new Filter Data
3270
3307
 
3271
3308
 
3272
3309
 
3273
3310
 
3274
- ### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
3311
+ ### dist/filters/helpers/common/getMergeFiltersSettings.js
3275
3312
 
3276
3313
 
3277
- #### excludeUIFlatFiltersByScopes(uFilters, scopes)
3314
+ #### getMergeFiltersSettings(settings)
3278
3315
 
3279
- Excludes and returns a UI Flat Filters without filters by the given scopes
3316
+ Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
3280
3317
 
3281
3318
 
3282
3319
 
@@ -3285,8 +3322,7 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
3285
3322
 
3286
3323
  | Name | Type | Description | |
3287
3324
  | ---- | ---- | ----------- | -------- |
3288
- | uFilters | | The Flatten UI Filters |   |
3289
- | scopes | | collection of scopes types |   |
3325
+ | settings | | an object to the MergeFilters settings |   |
3290
3326
 
3291
3327
 
3292
3328
 
@@ -3294,17 +3330,17 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
3294
3330
  ##### Returns
3295
3331
 
3296
3332
 
3297
- - The new array of UI Flattened filters
3333
+ - a new MergeFilters settings object.
3298
3334
 
3299
3335
 
3300
3336
 
3301
3337
 
3302
- ### dist/filters/helpers/ui/getFilterPropertyLabel.js
3338
+ ### dist/filters/helpers/common/getParamsToGetFilterSettings.js
3303
3339
 
3304
3340
 
3305
- #### getFilterPropertyLabel(filter)
3341
+ #### getParamsToGetFilterSettings(settings)
3306
3342
 
3307
- Gets the label of the filter property
3343
+ Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
3308
3344
 
3309
3345
 
3310
3346
 
@@ -3313,7 +3349,7 @@ Gets the label of the filter property
3313
3349
 
3314
3350
  | Name | Type | Description | |
3315
3351
  | ---- | ---- | ----------- | -------- |
3316
- | filter | | The UI Filter |   |
3352
+ | settings | | an object to the ParamsToGetFilter settings |   |
3317
3353
 
3318
3354
 
3319
3355
 
@@ -3321,17 +3357,17 @@ Gets the label of the filter property
3321
3357
  ##### Returns
3322
3358
 
3323
3359
 
3324
- - a string of the filter property label
3360
+ - a new ParamsToGetFilter settings object.
3325
3361
 
3326
3362
 
3327
3363
 
3328
3364
 
3329
- ### dist/filters/helpers/ui/getOutputFormatByColumn.js
3365
+ ### dist/filters/helpers/common/haveFiltersByDataset.js
3330
3366
 
3331
3367
 
3332
- #### getOutputFormatByColumn(column, datasets)
3368
+ #### haveFiltersByDataset(filterData, qrveyid)
3333
3369
 
3334
- Gets output format object from Datasets by the given column. Item of the datasets array must have outputformat item in order to be returned
3370
+ Validates if the filter data has filters by a dataset ID (Qrvey ID).
3335
3371
 
3336
3372
 
3337
3373
 
@@ -3340,8 +3376,8 @@ Gets output format object from Datasets by the given column. Item of the dataset
3340
3376
 
3341
3377
  | Name | Type | Description | |
3342
3378
  | ---- | ---- | ----------- | -------- |
3343
- | column | | The column |   |
3344
- | datasets | | array of datasets |   |
3379
+ | filterData | | the filter data or the UI filter data. |   |
3380
+ | qrveyid | | The Qrvey ID |   |
3345
3381
 
3346
3382
 
3347
3383
 
@@ -3349,56 +3385,54 @@ Gets output format object from Datasets by the given column. Item of the dataset
3349
3385
  ##### Returns
3350
3386
 
3351
3387
 
3352
- - The output format object
3388
+ - true: the filter data has filters by the Qrvey ID
3353
3389
 
3354
3390
 
3355
3391
 
3356
3392
 
3357
- ### dist/filters/helpers/ui/getUIFlatFilterByParams.js
3393
+ ### dist/filters/helpers/common/isBetweenValidator.js
3358
3394
 
3359
3395
 
3360
- #### getUIFlatFilterByParams()
3396
+ #### isBetweenValidator(validator)
3397
+
3398
+ Validates if the given validator is a Between type
3361
3399
 
3362
- Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
3363
- The validation to filter the stored filter is depending on:
3364
- - Column
3365
- - Qrvey ID,
3366
- - Scope type
3367
- - Scope ID
3368
- - Panel ID
3369
- - Validator type
3370
- - Property type
3371
3400
 
3372
3401
 
3373
3402
 
3403
+ ##### Parameters
3404
+
3405
+ | Name | Type | Description | |
3406
+ | ---- | ---- | ----------- | -------- |
3407
+ | validator | | The validator |   |
3408
+
3374
3409
 
3375
3410
 
3376
3411
 
3377
3412
  ##### Returns
3378
3413
 
3379
3414
 
3380
- - The index of the uFilter array or the Filter object s
3415
+ - true: it is a between validator; false: it is not a between validator
3381
3416
 
3382
3417
 
3383
3418
 
3384
3419
 
3385
- ### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
3420
+ ### dist/filters/helpers/common/isDateDistinctProperty.js
3421
+
3422
+
3423
+ #### isDateDistinctProperty(column, property)
3424
+
3425
+ Determines if the filter column and property is a distinct group dates type
3386
3426
 
3387
3427
 
3388
- #### getUIFlatFiltersByParams()
3389
3428
 
3390
- Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
3391
- The validation to filter the stored filter is depending on:
3392
- - Column
3393
- - Qrvey ID,
3394
- - Scope type
3395
- - Scope ID
3396
- - Panel ID
3397
- - Validator type
3398
- - Property type
3399
- - Enabled flags
3400
3429
 
3430
+ ##### Parameters
3401
3431
 
3432
+ | Name | Type | Description | |
3433
+ | ---- | ---- | ----------- | -------- |
3434
+ | column | | The filter column |   |
3435
+ | property | | The filter property |   |
3402
3436
 
3403
3437
 
3404
3438
 
@@ -3406,17 +3440,17 @@ The validation to filter the stored filter is depending on:
3406
3440
  ##### Returns
3407
3441
 
3408
3442
 
3409
- - The index of the uFilter array or the Filter object s
3443
+ - True if the given property is included from distinct group dates type
3410
3444
 
3411
3445
 
3412
3446
 
3413
3447
 
3414
- ### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
3448
+ ### dist/filters/helpers/common/isInValidator.js
3415
3449
 
3416
3450
 
3417
- #### getUIFlatFiltersByScopes(uFilters, scopes)
3451
+ #### isInValidator(validator)
3418
3452
 
3419
- Filters and gets a UI Flatten Filters by the given scopes
3453
+ Validates if the given validator is a In type
3420
3454
 
3421
3455
 
3422
3456
 
@@ -3425,8 +3459,7 @@ Filters and gets a UI Flatten Filters by the given scopes
3425
3459
 
3426
3460
  | Name | Type | Description | |
3427
3461
  | ---- | ---- | ----------- | -------- |
3428
- | uFilters | | The Flatten UI Filters |   |
3429
- | scopes | | collection of scopes types |   |
3462
+ | validator | | The validator |   |
3430
3463
 
3431
3464
 
3432
3465
 
@@ -3434,17 +3467,17 @@ Filters and gets a UI Flatten Filters by the given scopes
3434
3467
  ##### Returns
3435
3468
 
3436
3469
 
3437
- - The new array of UI Flattened filters
3438
-
3470
+ - true: it is a In validator; false: it is not a In validator
3439
3471
 
3440
3472
 
3441
3473
 
3442
- ### dist/filters/helpers/ui/getUIValues.js
3443
3474
 
3475
+ ### dist/filters/helpers/common/isNullValidator.js
3444
3476
 
3445
- #### getUIValues(filter, addEnableds, rankingGroupIndex)
3446
3477
 
3478
+ #### isNullValidator(validator)
3447
3479
 
3480
+ Checks if the given validator is a Null type.
3448
3481
 
3449
3482
 
3450
3483
 
@@ -3453,9 +3486,7 @@ Filters and gets a UI Flatten Filters by the given scopes
3453
3486
 
3454
3487
  | Name | Type | Description | |
3455
3488
  | ---- | ---- | ----------- | -------- |
3456
- | filter | | |   |
3457
- | addEnableds | | |   |
3458
- | rankingGroupIndex | | |   |
3489
+ | validator | | The Filter Validator |   |
3459
3490
 
3460
3491
 
3461
3492
 
@@ -3463,17 +3494,17 @@ Filters and gets a UI Flatten Filters by the given scopes
3463
3494
  ##### Returns
3464
3495
 
3465
3496
 
3466
- -
3497
+ - True: It is a Null Validator; False: It is not a Null Validator.
3467
3498
 
3468
3499
 
3469
3500
 
3470
3501
 
3471
- ### dist/filters/helpers/ui/resolveUIFlatFiltersByParams.js
3502
+ ### dist/filters/helpers/common/isRangeValidator.js
3472
3503
 
3473
3504
 
3474
- #### resolveUIFlatFilterByParams(filter, params)
3505
+ #### isRangeValidator(validator)
3475
3506
 
3476
- Resolves conditions between UI flattened filter and given parameters
3507
+ Validates if the given validator is a Range type. Range type means the value has min and max values to filter
3477
3508
 
3478
3509
 
3479
3510
 
@@ -3482,8 +3513,7 @@ Resolves conditions between UI flattened filter and given parameters
3482
3513
 
3483
3514
  | Name | Type | Description | |
3484
3515
  | ---- | ---- | ----------- | -------- |
3485
- | filter | | UI Flatten Filter |   |
3486
- | params | | Parameters to validate |   |
3516
+ | validator | | The filter validator |   |
3487
3517
 
3488
3518
 
3489
3519
 
@@ -3491,17 +3521,17 @@ Resolves conditions between UI flattened filter and given parameters
3491
3521
  ##### Returns
3492
3522
 
3493
3523
 
3494
- - true: the conditions are satisfied.
3524
+ - true: it is a range validator
3495
3525
 
3496
3526
 
3497
3527
 
3498
3528
 
3499
- ### dist/filters/helpers/common/areFiltersEquals.js
3529
+ ### dist/filters/helpers/common/isRegularValidator.js
3500
3530
 
3501
3531
 
3502
- #### areFiltersEquals(filter1, filter2)
3532
+ #### isRegularValidator(validator)
3503
3533
 
3504
- Validates if both filters are the same
3534
+ Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
3505
3535
 
3506
3536
 
3507
3537
 
@@ -3510,8 +3540,7 @@ Validates if both filters are the same
3510
3540
 
3511
3541
  | Name | Type | Description | |
3512
3542
  | ---- | ---- | ----------- | -------- |
3513
- | filter1 | | filter 1 |   |
3514
- | filter2 | | filter 2 |   |
3543
+ | validator | | The filter validator |   |
3515
3544
 
3516
3545
 
3517
3546
 
@@ -3519,17 +3548,17 @@ Validates if both filters are the same
3519
3548
  ##### Returns
3520
3549
 
3521
3550
 
3522
- - true: the filters are equal; false: the filters are NOT equal
3551
+ - true: it is a range validator
3523
3552
 
3524
3553
 
3525
3554
 
3526
3555
 
3527
- ### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
3556
+ ### dist/filters/helpers/common/mergeFilters.js
3528
3557
 
3529
3558
 
3530
- #### excludeFiltersByAggregateColumn(filterData)
3559
+ #### mergeFilters(filterData1, filterData2, overwriteValues)
3531
3560
 
3532
- Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
3561
+ Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
3533
3562
 
3534
3563
 
3535
3564
 
@@ -3538,7 +3567,9 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
3538
3567
 
3539
3568
  | Name | Type | Description | |
3540
3569
  | ---- | ---- | ----------- | -------- |
3541
- | filterData | | The filter data object |   |
3570
+ | filterData1 | | The target filter data |   |
3571
+ | filterData2 | | the filter data to be merged |   |
3572
+ | overwriteValues | | Flag to overwrite or not the filter values |   |
3542
3573
 
3543
3574
 
3544
3575
 
@@ -3546,26 +3577,13 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
3546
3577
  ##### Returns
3547
3578
 
3548
3579
 
3549
- - The new filter data object that were excluded the aggregate filters
3550
-
3551
-
3552
-
3580
+ - a new filter data structure
3553
3581
 
3554
- ### dist/filters/helpers/common/excludeFiltersByParams.js
3555
3582
 
3556
3583
 
3557
- #### excludeFiltersByParams(filterData, params)
3584
+ #### mergeScopes(scopes1, scopes2, overwriteValues)
3558
3585
 
3559
- Excludes filters from the given Filters.
3560
- The validation to filter the stored filter is depending on:
3561
- - Column
3562
- - Qrvey ID
3563
- - Scope type
3564
- - Scope ID
3565
- - Panel ID
3566
- - Validator type
3567
- - Property type
3568
- - Enabled flags
3586
+ Gets a new scope structure array by merging two scope structures
3569
3587
 
3570
3588
 
3571
3589
 
@@ -3574,8 +3592,9 @@ The validation to filter the stored filter is depending on:
3574
3592
 
3575
3593
  | Name | Type | Description | |
3576
3594
  | ---- | ---- | ----------- | -------- |
3577
- | filterData | | The Filter Data or the UI Filter Data |   |
3578
- | params | | given parameters to validate the filter data |   |
3595
+ | scopes1 | | the target scope structure |   |
3596
+ | scopes2 | | the scope to be merged |   |
3597
+ | overwriteValues | | Flag to overwrite or not the filter values |   |
3579
3598
 
3580
3599
 
3581
3600
 
@@ -3583,17 +3602,13 @@ The validation to filter the stored filter is depending on:
3583
3602
  ##### Returns
3584
3603
 
3585
3604
 
3586
- - a new Filter object structure
3587
-
3588
-
3589
-
3605
+ - a new scope structure array
3590
3606
 
3591
- ### dist/filters/helpers/common/excludeFiltersByScopes.js
3592
3607
 
3593
3608
 
3594
- #### excludeFiltersByScopes(filterData, scopes)
3609
+ #### mergeDatasets(datasets1, datasets2, overwriteValues)
3595
3610
 
3596
- Excludes and returns a filter data without filters by the given scopes
3611
+ Gets a new dataset structure array by merging two dataset structures
3597
3612
 
3598
3613
 
3599
3614
 
@@ -3602,8 +3617,9 @@ Excludes and returns a filter data without filters by the given scopes
3602
3617
 
3603
3618
  | Name | Type | Description | |
3604
3619
  | ---- | ---- | ----------- | -------- |
3605
- | filterData | | The Filter Data |   |
3606
- | scopes | | collection of scopes to be as filtering parameters |   |
3620
+ | datasets1 | | the target dataset structure |   |
3621
+ | datasets2 | | the dataset to be merged |   |
3622
+ | overwriteValues | | Flag to overwrite or not the filter values |   |
3607
3623
 
3608
3624
 
3609
3625
 
@@ -3611,17 +3627,13 @@ Excludes and returns a filter data without filters by the given scopes
3611
3627
  ##### Returns
3612
3628
 
3613
3629
 
3614
- - The new Filter Data without filters by the given scopes.
3615
-
3616
-
3617
-
3630
+ - a new dataset structure array
3618
3631
 
3619
- ### dist/filters/helpers/common/getFilterColumnLabel.js
3620
3632
 
3621
3633
 
3622
- #### getFilterColumnLabel(column)
3634
+ #### mergeFilterss(filters1, filters2, overwriteValues)
3623
3635
 
3624
- Get an string of the properties of the given filter column.
3636
+ Gets a new filter structure array by merging two filter structures
3625
3637
 
3626
3638
 
3627
3639
 
@@ -3630,7 +3642,9 @@ Get an string of the properties of the given filter column.
3630
3642
 
3631
3643
  | Name | Type | Description | |
3632
3644
  | ---- | ---- | ----------- | -------- |
3633
- | column | | The filter column |   |
3645
+ | filters1 | | the target filter structure |   |
3646
+ | filters2 | | the filter to be merged |   |
3647
+ | overwriteValues | | Flag to overwrite or not the filter values |   |
3634
3648
 
3635
3649
 
3636
3650
 
@@ -3638,17 +3652,13 @@ Get an string of the properties of the given filter column.
3638
3652
  ##### Returns
3639
3653
 
3640
3654
 
3641
- - an string with the property, aggregate or calculation label.
3642
-
3643
-
3644
-
3655
+ - a new filter structure array
3645
3656
 
3646
- ### dist/filters/helpers/common/getFilterLabel.js
3647
3657
 
3648
3658
 
3649
- #### getFilterLabel(filter)
3659
+ #### mergeValues(filter1, filter2, overwrite)
3650
3660
 
3651
- Gets the Filter Label + Column label
3661
+ Gets a new value structure array by merging two value structures
3652
3662
 
3653
3663
 
3654
3664
 
@@ -3657,7 +3667,9 @@ Gets the Filter Label + Column label
3657
3667
 
3658
3668
  | Name | Type | Description | |
3659
3669
  | ---- | ---- | ----------- | -------- |
3660
- | filter | | the UI filter |   |
3670
+ | filter1 | | the target filter structure |   |
3671
+ | filter2 | | the filter to be used to merge the values |   |
3672
+ | overwrite | | Flag to overwrite or not the filter values |   |
3661
3673
 
3662
3674
 
3663
3675
 
@@ -3665,28 +3677,17 @@ Gets the Filter Label + Column label
3665
3677
  ##### Returns
3666
3678
 
3667
3679
 
3668
- - a sring label
3680
+ - a new value structure array
3669
3681
 
3670
3682
 
3671
3683
 
3672
3684
 
3673
- ### dist/filters/helpers/common/getFilterid.js
3685
+ ### dist/filters/helpers/common/resolveDatasetConditions.js
3674
3686
 
3675
3687
 
3676
- #### getFilterid(filter)
3688
+ #### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
3677
3689
 
3678
- Get the Filter ID by the filter structure
3679
- The order of the epression ID is:
3680
- - Scope Type
3681
- - scopeid
3682
- - qrveyid
3683
- - panelid
3684
- - columnid
3685
- - validator
3686
- - property
3687
- - Column Aggregate
3688
- - Column Calculation
3689
- - Optional Index
3690
+ Resolves the conditions by given params
3690
3691
 
3691
3692
 
3692
3693
 
@@ -3695,7 +3696,10 @@ The order of the epression ID is:
3695
3696
 
3696
3697
  | Name | Type | Description | |
3697
3698
  | ---- | ---- | ----------- | -------- |
3698
- | filter | | the filter structure |   |
3699
+ | filter | | The dataset structure |   |
3700
+ | params | | given parameters to validate the dataset |   |
3701
+ | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined |   |
3702
+ | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. |   |
3699
3703
 
3700
3704
 
3701
3705
 
@@ -3703,17 +3707,17 @@ The order of the epression ID is:
3703
3707
  ##### Returns
3704
3708
 
3705
3709
 
3706
- - a text to identify the filter
3710
+ - true: the condition is satisfied
3707
3711
 
3708
3712
 
3709
3713
 
3710
3714
 
3711
- ### dist/filters/helpers/common/getFiltersByAggregateColumn.js
3715
+ ### dist/filters/helpers/common/resolveFilterConditions.js
3712
3716
 
3713
3717
 
3714
- #### getFiltersByAggregateColumn(filterData)
3718
+ #### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
3715
3719
 
3716
- Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
3720
+ Resolves the conditions by given params
3717
3721
 
3718
3722
 
3719
3723
 
@@ -3722,7 +3726,10 @@ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggr
3722
3726
 
3723
3727
  | Name | Type | Description | |
3724
3728
  | ---- | ---- | ----------- | -------- |
3725
- | filterData | | The filter data object |   |
3729
+ | filter | | The filter |   |
3730
+ | params | | given parameters to validate the filter |   |
3731
+ | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined |   |
3732
+ | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. |   |
3726
3733
 
3727
3734
 
3728
3735
 
@@ -3730,26 +3737,17 @@ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggr
3730
3737
  ##### Returns
3731
3738
 
3732
3739
 
3733
- - The new filter data object that were get the aggregate filters
3740
+ - true: the condition is satisfied
3734
3741
 
3735
3742
 
3736
3743
 
3737
3744
 
3738
- ### dist/filters/helpers/common/getFiltersByParams.js
3745
+ ### dist/filters/helpers/common/resolveScopeConditions.js
3739
3746
 
3740
3747
 
3741
- #### getFiltersByParams(filterData, params)
3748
+ #### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
3742
3749
 
3743
- Gets filters from the given params.
3744
- The validation to filter the stored filter is depending on:
3745
- - Column
3746
- - Qrvey ID
3747
- - Scope type
3748
- - Scope ID
3749
- - Panel ID
3750
- - Validator type
3751
- - Property type
3752
- - Enabled flags
3750
+ Resolves the conditions by given params
3753
3751
 
3754
3752
 
3755
3753
 
@@ -3758,8 +3756,10 @@ The validation to filter the stored filter is depending on:
3758
3756
 
3759
3757
  | Name | Type | Description | |
3760
3758
  | ---- | ---- | ----------- | -------- |
3761
- | filterData | | The Filter Data or the UI Filter Data |   |
3762
- | params | | given parameters to validate the dataset |   |
3759
+ | filter | | The filter scope structure |   |
3760
+ | params | | given parameters to validate the filter |   |
3761
+ | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined |   |
3762
+ | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. |   |
3763
3763
 
3764
3764
 
3765
3765
 
@@ -3767,17 +3767,18 @@ The validation to filter the stored filter is depending on:
3767
3767
  ##### Returns
3768
3768
 
3769
3769
 
3770
- - a new Filter object structure
3770
+ - true: the condition is satisfied
3771
3771
 
3772
3772
 
3773
3773
 
3774
3774
 
3775
- ### dist/filters/helpers/common/getFiltersByScopes.js
3775
+ ### dist/filters/helpers/backend/buildExpression.js
3776
3776
 
3777
3777
 
3778
- #### getFiltersByScopes(filterData, scopes)
3778
+ #### buildExpression(filter)
3779
3779
 
3780
- Filters and gets a Filter Data by the given scopes
3780
+ Builds filter expression by the filter data.
3781
+ - If the resulting value array is empty the enabled property will be false.
3781
3782
 
3782
3783
 
3783
3784
 
@@ -3785,9 +3786,8 @@ Filters and gets a Filter Data by the given scopes
3785
3786
  ##### Parameters
3786
3787
 
3787
3788
  | Name | Type | Description | |
3788
- | ---- | ---- | ----------- | -------- |
3789
- | filterData | | The Filter Data |   |
3790
- | scopes | | collection of scopes types |   |
3789
+ | ---- | ---- | ----------- | -------- |
3790
+ | filter | | The filter to transform |   |
3791
3791
 
3792
3792
 
3793
3793
 
@@ -3795,17 +3795,17 @@ Filters and gets a Filter Data by the given scopes
3795
3795
  ##### Returns
3796
3796
 
3797
3797
 
3798
- - The new Filter Data
3798
+ - a filter expression
3799
3799
 
3800
3800
 
3801
3801
 
3802
3802
 
3803
- ### dist/filters/helpers/common/getFiltersByScopesIds.js
3803
+ ### dist/filters/helpers/backend/buildUserFilters.js
3804
3804
 
3805
3805
 
3806
- #### getFiltersByScopesIds(filterData, scopes)
3806
+ #### buildUserFilters(userFilters)
3807
3807
 
3808
- Gets filters from Filter Data by Scopes/Scope IDs.
3808
+ Transform user Filters array into Filter Logic structure
3809
3809
 
3810
3810
 
3811
3811
 
@@ -3814,8 +3814,7 @@ Gets filters from Filter Data by Scopes/Scope IDs.
3814
3814
 
3815
3815
  | Name | Type | Description | |
3816
3816
  | ---- | ---- | ----------- | -------- |
3817
- | filterData | | The filter data |   |
3818
- | scopes | | The collection of Scopes/Scope IDs |   |
3817
+ | userFilters | | The filters that the user defined. |   |
3819
3818
 
3820
3819
 
3821
3820
 
@@ -3823,17 +3822,17 @@ Gets filters from Filter Data by Scopes/Scope IDs.
3823
3822
  ##### Returns
3824
3823
 
3825
3824
 
3826
- - a new Filter Data
3825
+ - The filter logic for the given user filters. if No a given object is recieved, it will return an empty array.
3827
3826
 
3828
3827
 
3829
3828
 
3830
3829
 
3831
- ### dist/filters/helpers/common/getFiltersByVisibility.js
3830
+ ### dist/filters/helpers/backend/getAggFiltersBySummaryIndex.js
3832
3831
 
3833
3832
 
3834
- #### getFiltersByVisibility(filterData, scopes)
3833
+ #### getAggFiltersBySummaryIndex(aggFilters, summaryIndex)
3834
+
3835
3835
 
3836
- Get a new Filter Data by filtering scopes/scope IDs and enabled flags
3837
3836
 
3838
3837
 
3839
3838
 
@@ -3842,8 +3841,8 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
3842
3841
 
3843
3842
  | Name | Type | Description | |
3844
3843
  | ---- | ---- | ----------- | -------- |
3845
- | filterData | | a Filter Data or UI Filter Data |   |
3846
- | scopes | | a Scopes/Scope IDs array |   |
3844
+ | aggFilters | | |   |
3845
+ | summaryIndex | | |   |
3847
3846
 
3848
3847
 
3849
3848
 
@@ -3851,17 +3850,17 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
3851
3850
  ##### Returns
3852
3851
 
3853
3852
 
3854
- - a new Filter Data
3853
+ -
3855
3854
 
3856
3855
 
3857
3856
 
3858
3857
 
3859
- ### dist/filters/helpers/common/getMergeFiltersSettings.js
3858
+ ### dist/filters/helpers/backend/getBackendGroupValue.js
3860
3859
 
3861
3860
 
3862
- #### getMergeFiltersSettings(settings)
3861
+ #### getBackendGroupValue(filter)
3863
3862
 
3864
- Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
3863
+ Gets a group value for the backend logic structure
3865
3864
 
3866
3865
 
3867
3866
 
@@ -3870,7 +3869,7 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
3870
3869
 
3871
3870
  | Name | Type | Description | |
3872
3871
  | ---- | ---- | ----------- | -------- |
3873
- | settings | | an object to the MergeFilters settings |   |
3872
+ | filter | | The filter |   |
3874
3873
 
3875
3874
 
3876
3875
 
@@ -3878,17 +3877,17 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
3878
3877
  ##### Returns
3879
3878
 
3880
3879
 
3881
- - a new MergeFilters settings object.
3880
+ - a property
3882
3881
 
3883
3882
 
3884
3883
 
3885
3884
 
3886
- ### dist/filters/helpers/common/getParamsToGetFilterSettings.js
3885
+ ### dist/filters/helpers/backend/getBackendProperty.js
3887
3886
 
3888
3887
 
3889
- #### getParamsToGetFilterSettings(settings)
3888
+ #### getBackendProperty(filter)
3890
3889
 
3891
- Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
3890
+ Gets a property for the logic structure
3892
3891
 
3893
3892
 
3894
3893
 
@@ -3897,7 +3896,7 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
3897
3896
 
3898
3897
  | Name | Type | Description | |
3899
3898
  | ---- | ---- | ----------- | -------- |
3900
- | settings | | an object to the ParamsToGetFilter settings |   |
3899
+ | filter | | The filter |   |
3901
3900
 
3902
3901
 
3903
3902
 
@@ -3905,17 +3904,17 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
3905
3904
  ##### Returns
3906
3905
 
3907
3906
 
3908
- - a new ParamsToGetFilter settings object.
3907
+ - a property
3909
3908
 
3910
3909
 
3911
3910
 
3912
3911
 
3913
- ### dist/filters/helpers/common/haveFiltersByDataset.js
3912
+ ### dist/filters/helpers/backend/getBackendValidator.js
3914
3913
 
3915
3914
 
3916
- #### haveFiltersByDataset(filterData, qrveyid)
3915
+ #### getBackendValidator(validator)
3917
3916
 
3918
- Validates if the filter data has filters by a dataset ID (Qrvey ID).
3917
+ Gets the Validator that is used in requests
3919
3918
 
3920
3919
 
3921
3920
 
@@ -3924,8 +3923,7 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
3924
3923
 
3925
3924
  | Name | Type | Description | |
3926
3925
  | ---- | ---- | ----------- | -------- |
3927
- | filterData | | the filter data or the UI filter data. |   |
3928
- | qrveyid | | The Qrvey ID |   |
3926
+ | validator | | Filter Validator used in UI |   |
3929
3927
 
3930
3928
 
3931
3929
 
@@ -3933,17 +3931,17 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
3933
3931
  ##### Returns
3934
3932
 
3935
3933
 
3936
- - true: the filter data has filters by the Qrvey ID
3934
+ - Filter Validator used in Backend
3937
3935
 
3938
3936
 
3939
3937
 
3940
3938
 
3941
- ### dist/filters/helpers/common/isBetweenValidator.js
3939
+ ### dist/filters/helpers/backend/getBackendValues.js
3942
3940
 
3943
3941
 
3944
- #### isBetweenValidator(validator)
3942
+ #### getBackendValues(filter)
3945
3943
 
3946
- Validates if the given validator is a Between type
3944
+ Gets the expresion values in the logic format
3947
3945
 
3948
3946
 
3949
3947
 
@@ -3952,7 +3950,7 @@ Validates if the given validator is a Between type
3952
3950
 
3953
3951
  | Name | Type | Description | |
3954
3952
  | ---- | ---- | ----------- | -------- |
3955
- | validator | | The validator |   |
3953
+ | filter | | The filter structure |   |
3956
3954
 
3957
3955
 
3958
3956
 
@@ -3960,17 +3958,13 @@ Validates if the given validator is a Between type
3960
3958
  ##### Returns
3961
3959
 
3962
3960
 
3963
- - true: it is a between validator; false: it is not a between validator
3964
-
3965
-
3966
-
3961
+ - A collection of backend expression value
3967
3962
 
3968
- ### dist/filters/helpers/common/isDateDistinctProperty.js
3969
3963
 
3970
3964
 
3971
- #### isDateDistinctProperty(column, property)
3965
+ #### getResultValues(values, filter)
3972
3966
 
3973
- Determines if the filter column and property is a distinct group dates type
3967
+ Gets the expression values. Depending on the column type
3974
3968
 
3975
3969
 
3976
3970
 
@@ -3979,8 +3973,8 @@ Determines if the filter column and property is a distinct group dates type
3979
3973
 
3980
3974
  | Name | Type | Description | |
3981
3975
  | ---- | ---- | ----------- | -------- |
3982
- | column | | The filter column |   |
3983
- | property | | The filter property |   |
3976
+ | values | | a collection of filter values |   |
3977
+ | filter | | The filter structure |   |
3984
3978
 
3985
3979
 
3986
3980
 
@@ -3988,17 +3982,13 @@ Determines if the filter column and property is a distinct group dates type
3988
3982
  ##### Returns
3989
3983
 
3990
3984
 
3991
- - True if the given property is included from distinct group dates type
3992
-
3993
-
3994
-
3985
+ -
3995
3986
 
3996
- ### dist/filters/helpers/common/isInValidator.js
3997
3987
 
3998
3988
 
3999
- #### isInValidator(validator)
3989
+ #### getRankingValues(values, rankingGroupIndex)
4000
3990
 
4001
- Validates if the given validator is a In type
3991
+ Gets the Ranking values.
4002
3992
 
4003
3993
 
4004
3994
 
@@ -4007,7 +3997,8 @@ Validates if the given validator is a In type
4007
3997
 
4008
3998
  | Name | Type | Description | |
4009
3999
  | ---- | ---- | ----------- | -------- |
4010
- | validator | | The validator |   |
4000
+ | values | | a collection of filter values in the ranking structure |   |
4001
+ | rankingGroupIndex | | determine the value by this index to build and return it |   |
4011
4002
 
4012
4003
 
4013
4004
 
@@ -4015,17 +4006,17 @@ Validates if the given validator is a In type
4015
4006
  ##### Returns
4016
4007
 
4017
4008
 
4018
- - true: it is a In validator; false: it is not a In validator
4009
+ - Expression values for ranking
4019
4010
 
4020
4011
 
4021
4012
 
4022
4013
 
4023
- ### dist/filters/helpers/common/isNullValidator.js
4014
+ ### dist/filters/helpers/backend/getLogicByScopes.js
4024
4015
 
4025
4016
 
4026
- #### isNullValidator(validator)
4017
+ #### getLogicByScopes(logics, scopes)
4027
4018
 
4028
- Checks if the given validator is a Null type.
4019
+ Gets the filters from logic data by Scopes/Scope IDs.
4029
4020
 
4030
4021
 
4031
4022
 
@@ -4034,7 +4025,8 @@ Checks if the given validator is a Null type.
4034
4025
 
4035
4026
  | Name | Type | Description | |
4036
4027
  | ---- | ---- | ----------- | -------- |
4037
- | validator | | The Filter Validator |   |
4028
+ | logics | | The logic array |   |
4029
+ | scopes | | The collection of Scopes/Scope IDs |   |
4038
4030
 
4039
4031
 
4040
4032
 
@@ -4042,17 +4034,17 @@ Checks if the given validator is a Null type.
4042
4034
  ##### Returns
4043
4035
 
4044
4036
 
4045
- - True: It is a Null Validator; False: It is not a Null Validator.
4037
+ - a new Logic array
4046
4038
 
4047
4039
 
4048
4040
 
4049
4041
 
4050
- ### dist/filters/helpers/common/isRangeValidator.js
4042
+ ### dist/filters/helpers/backend/getLogicByScopesHierarchy.js
4051
4043
 
4052
4044
 
4053
- #### isRangeValidator(validator)
4045
+ #### getLogicByScopesHierarchy(filterData, scopes, currentScope)
4054
4046
 
4055
- Validates if the given validator is a Range type. Range type means the value has min and max values to filter
4047
+ Gets filters from the logic by the scopes hierarchy.
4056
4048
 
4057
4049
 
4058
4050
 
@@ -4061,7 +4053,9 @@ Validates if the given validator is a Range type. Range type means the value has
4061
4053
 
4062
4054
  | Name | Type | Description | |
4063
4055
  | ---- | ---- | ----------- | -------- |
4064
- | validator | | The filter validator |   |
4056
+ | filterData | | |   |
4057
+ | scopes | | |   |
4058
+ | currentScope | | |   |
4065
4059
 
4066
4060
 
4067
4061
 
@@ -4069,17 +4063,17 @@ Validates if the given validator is a Range type. Range type means the value has
4069
4063
  ##### Returns
4070
4064
 
4071
4065
 
4072
- - true: it is a range validator
4066
+ - a new array of Logic
4073
4067
 
4074
4068
 
4075
4069
 
4076
4070
 
4077
- ### dist/filters/helpers/common/isRegularValidator.js
4071
+ ### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
4078
4072
 
4079
4073
 
4080
- #### isRegularValidator(validator)
4074
+ #### excludeUIFiltersByAggregate(uFilters)
4081
4075
 
4082
- Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
4076
+ Excludes Aggregate Filters in the Flattened UI Filters array
4083
4077
 
4084
4078
 
4085
4079
 
@@ -4088,7 +4082,7 @@ Validates if the given validator is a regular type. Regular type means the filte
4088
4082
 
4089
4083
  | Name | Type | Description | |
4090
4084
  | ---- | ---- | ----------- | -------- |
4091
- | validator | | The filter validator |   |
4085
+ | uFilters | | Collection of Flat UI Filters |   |
4092
4086
 
4093
4087
 
4094
4088
 
@@ -4096,17 +4090,17 @@ Validates if the given validator is a regular type. Regular type means the filte
4096
4090
  ##### Returns
4097
4091
 
4098
4092
 
4099
- - true: it is a range validator
4093
+ - a new Flat UI Filters that were excluded the aggregate filters
4100
4094
 
4101
4095
 
4102
4096
 
4103
4097
 
4104
- ### dist/filters/helpers/common/mergeFilters.js
4098
+ ### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
4105
4099
 
4106
4100
 
4107
- #### mergeFilters(filterData1, filterData2, overwriteValues)
4101
+ #### excludeUIFlatFiltersByScopes(uFilters, scopes)
4108
4102
 
4109
- Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
4103
+ Excludes and returns a UI Flat Filters without filters by the given scopes
4110
4104
 
4111
4105
 
4112
4106
 
@@ -4115,9 +4109,8 @@ Merge filter data structures in a new one. The first Filter Data passed in the a
4115
4109
 
4116
4110
  | Name | Type | Description | |
4117
4111
  | ---- | ---- | ----------- | -------- |
4118
- | filterData1 | | The target filter data |   |
4119
- | filterData2 | | the filter data to be merged |   |
4120
- | overwriteValues | | Flag to overwrite or not the filter values |   |
4112
+ | uFilters | | The Flatten UI Filters |   |
4113
+ | scopes | | collection of scopes types |   |
4121
4114
 
4122
4115
 
4123
4116
 
@@ -4125,13 +4118,17 @@ Merge filter data structures in a new one. The first Filter Data passed in the a
4125
4118
  ##### Returns
4126
4119
 
4127
4120
 
4128
- - a new filter data structure
4121
+ - The new array of UI Flattened filters
4129
4122
 
4130
4123
 
4131
4124
 
4132
- #### mergeScopes(scopes1, scopes2, overwriteValues)
4133
4125
 
4134
- Gets a new scope structure array by merging two scope structures
4126
+ ### dist/filters/helpers/ui/getFilterPropertyLabel.js
4127
+
4128
+
4129
+ #### getFilterPropertyLabel(filter)
4130
+
4131
+ Gets the label of the filter property
4135
4132
 
4136
4133
 
4137
4134
 
@@ -4140,9 +4137,7 @@ Gets a new scope structure array by merging two scope structures
4140
4137
 
4141
4138
  | Name | Type | Description | |
4142
4139
  | ---- | ---- | ----------- | -------- |
4143
- | scopes1 | | the target scope structure |   |
4144
- | scopes2 | | the scope to be merged |   |
4145
- | overwriteValues | | Flag to overwrite or not the filter values |   |
4140
+ | filter | | The UI Filter |   |
4146
4141
 
4147
4142
 
4148
4143
 
@@ -4150,13 +4145,17 @@ Gets a new scope structure array by merging two scope structures
4150
4145
  ##### Returns
4151
4146
 
4152
4147
 
4153
- - a new scope structure array
4148
+ - a string of the filter property label
4154
4149
 
4155
4150
 
4156
4151
 
4157
- #### mergeDatasets(datasets1, datasets2, overwriteValues)
4158
4152
 
4159
- Gets a new dataset structure array by merging two dataset structures
4153
+ ### dist/filters/helpers/ui/getOutputFormatByColumn.js
4154
+
4155
+
4156
+ #### getOutputFormatByColumn(column, datasets)
4157
+
4158
+ Gets output format object from Datasets by the given column. Item of the datasets array must have outputformat item in order to be returned
4160
4159
 
4161
4160
 
4162
4161
 
@@ -4165,9 +4164,8 @@ Gets a new dataset structure array by merging two dataset structures
4165
4164
 
4166
4165
  | Name | Type | Description | |
4167
4166
  | ---- | ---- | ----------- | -------- |
4168
- | datasets1 | | the target dataset structure |   |
4169
- | datasets2 | | the dataset to be merged |   |
4170
- | overwriteValues | | Flag to overwrite or not the filter values |   |
4167
+ | column | | The column |   |
4168
+ | datasets | | array of datasets |   |
4171
4169
 
4172
4170
 
4173
4171
 
@@ -4175,24 +4173,27 @@ Gets a new dataset structure array by merging two dataset structures
4175
4173
  ##### Returns
4176
4174
 
4177
4175
 
4178
- - a new dataset structure array
4176
+ - The output format object
4179
4177
 
4180
4178
 
4181
4179
 
4182
- #### mergeFilterss(filters1, filters2, overwriteValues)
4183
4180
 
4184
- Gets a new filter structure array by merging two filter structures
4181
+ ### dist/filters/helpers/ui/getUIFlatFilterByParams.js
4185
4182
 
4186
4183
 
4184
+ #### getUIFlatFilterByParams()
4187
4185
 
4186
+ Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
4187
+ The validation to filter the stored filter is depending on:
4188
+ - Column
4189
+ - Qrvey ID,
4190
+ - Scope type
4191
+ - Scope ID
4192
+ - Panel ID
4193
+ - Validator type
4194
+ - Property type
4188
4195
 
4189
- ##### Parameters
4190
4196
 
4191
- | Name | Type | Description | |
4192
- | ---- | ---- | ----------- | -------- |
4193
- | filters1 | | the target filter structure |   |
4194
- | filters2 | | the filter to be merged |   |
4195
- | overwriteValues | | Flag to overwrite or not the filter values |   |
4196
4197
 
4197
4198
 
4198
4199
 
@@ -4200,24 +4201,28 @@ Gets a new filter structure array by merging two filter structures
4200
4201
  ##### Returns
4201
4202
 
4202
4203
 
4203
- - a new filter structure array
4204
+ - The index of the uFilter array or the Filter object s
4204
4205
 
4205
4206
 
4206
4207
 
4207
- #### mergeValues(filter1, filter2, overwrite)
4208
4208
 
4209
- Gets a new value structure array by merging two value structures
4209
+ ### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
4210
4210
 
4211
4211
 
4212
+ #### getUIFlatFiltersByParams()
4212
4213
 
4214
+ Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
4215
+ The validation to filter the stored filter is depending on:
4216
+ - Column
4217
+ - Qrvey ID,
4218
+ - Scope type
4219
+ - Scope ID
4220
+ - Panel ID
4221
+ - Validator type
4222
+ - Property type
4223
+ - Enabled flags
4213
4224
 
4214
- ##### Parameters
4215
4225
 
4216
- | Name | Type | Description | |
4217
- | ---- | ---- | ----------- | -------- |
4218
- | filter1 | | the target filter structure |   |
4219
- | filter2 | | the filter to be used to merge the values |   |
4220
- | overwrite | | Flag to overwrite or not the filter values |   |
4221
4226
 
4222
4227
 
4223
4228
 
@@ -4225,17 +4230,17 @@ Gets a new value structure array by merging two value structures
4225
4230
  ##### Returns
4226
4231
 
4227
4232
 
4228
- - a new value structure array
4233
+ - The index of the uFilter array or the Filter object s
4229
4234
 
4230
4235
 
4231
4236
 
4232
4237
 
4233
- ### dist/filters/helpers/common/resolveDatasetConditions.js
4238
+ ### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
4234
4239
 
4235
4240
 
4236
- #### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
4241
+ #### getUIFlatFiltersByScopes(uFilters, scopes)
4237
4242
 
4238
- Resolves the conditions by given params
4243
+ Filters and gets a UI Flatten Filters by the given scopes
4239
4244
 
4240
4245
 
4241
4246
 
@@ -4244,10 +4249,8 @@ Resolves the conditions by given params
4244
4249
 
4245
4250
  | Name | Type | Description | |
4246
4251
  | ---- | ---- | ----------- | -------- |
4247
- | filter | | The dataset structure |   |
4248
- | params | | given parameters to validate the dataset |   |
4249
- | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined |   |
4250
- | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. |   |
4252
+ | uFilters | | The Flatten UI Filters |   |
4253
+ | scopes | | collection of scopes types |   |
4251
4254
 
4252
4255
 
4253
4256
 
@@ -4255,17 +4258,17 @@ Resolves the conditions by given params
4255
4258
  ##### Returns
4256
4259
 
4257
4260
 
4258
- - true: the condition is satisfied
4261
+ - The new array of UI Flattened filters
4259
4262
 
4260
4263
 
4261
4264
 
4262
4265
 
4263
- ### dist/filters/helpers/common/resolveFilterConditions.js
4266
+ ### dist/filters/helpers/ui/getUIValues.js
4264
4267
 
4265
4268
 
4266
- #### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
4269
+ #### getUIValues(filter, addEnableds, rankingGroupIndex)
4270
+
4267
4271
 
4268
- Resolves the conditions by given params
4269
4272
 
4270
4273
 
4271
4274
 
@@ -4274,10 +4277,9 @@ Resolves the conditions by given params
4274
4277
 
4275
4278
  | Name | Type | Description | |
4276
4279
  | ---- | ---- | ----------- | -------- |
4277
- | filter | | The filter |   |
4278
- | params | | given parameters to validate the filter |   |
4279
- | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined |   |
4280
- | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. |   |
4280
+ | filter | | |   |
4281
+ | addEnableds | | |   |
4282
+ | rankingGroupIndex | | |   |
4281
4283
 
4282
4284
 
4283
4285
 
@@ -4285,17 +4287,17 @@ Resolves the conditions by given params
4285
4287
  ##### Returns
4286
4288
 
4287
4289
 
4288
- - true: the condition is satisfied
4290
+ -
4289
4291
 
4290
4292
 
4291
4293
 
4292
4294
 
4293
- ### dist/filters/helpers/common/resolveScopeConditions.js
4295
+ ### dist/filters/helpers/ui/resolveUIFlatFiltersByParams.js
4294
4296
 
4295
4297
 
4296
- #### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
4298
+ #### resolveUIFlatFilterByParams(filter, params)
4297
4299
 
4298
- Resolves the conditions by given params
4300
+ Resolves conditions between UI flattened filter and given parameters
4299
4301
 
4300
4302
 
4301
4303
 
@@ -4304,10 +4306,8 @@ Resolves the conditions by given params
4304
4306
 
4305
4307
  | Name | Type | Description | |
4306
4308
  | ---- | ---- | ----------- | -------- |
4307
- | filter | | The filter scope structure |   |
4308
- | params | | given parameters to validate the filter |   |
4309
- | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined |   |
4310
- | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. |   |
4309
+ | filter | | UI Flatten Filter |   |
4310
+ | params | | Parameters to validate |   |
4311
4311
 
4312
4312
 
4313
4313
 
@@ -4315,7 +4315,7 @@ Resolves the conditions by given params
4315
4315
  ##### Returns
4316
4316
 
4317
4317
 
4318
- - true: the condition is satisfied
4318
+ - true: the conditions are satisfied.
4319
4319
 
4320
4320
 
4321
4321