@qrvey/utils 1.2.9-7 → 1.2.9-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.
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-7*
1
+ # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-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,32 +688,12 @@ 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
-
711
- ### dist/filters/adapters/FDToLogic.js
691
+ ### dist/filters/adapters/FDToFlatUI.js
712
692
 
713
693
 
714
- #### FDToLogic(filterData)
694
+ #### FDToFlatUI(filterData, datasetsInfo)
715
695
 
716
- Generates a Filter Logic structure from Filter Data structure.
696
+ Generates a Flattened UI filter structure from Filter Data structure.
717
697
 
718
698
 
719
699
 
@@ -723,6 +703,7 @@ Generates a Filter Logic structure from Filter Data structure.
723
703
  | Name | Type | Description | |
724
704
  | ---- | ---- | ----------- | -------- |
725
705
  | filterData | | The filter data object. |   |
706
+ | datasetsInfo | | Collection of datasets information |   |
726
707
 
727
708
 
728
709
 
@@ -730,13 +711,13 @@ Generates a Filter Logic structure from Filter Data structure.
730
711
  ##### Returns
731
712
 
732
713
 
733
- - a filter logic array
714
+ - a flattened UI filters array
734
715
 
735
716
 
736
717
 
737
- #### getLogicBodyFromFD21(filterData)
718
+ #### FD21ToFlatUI(scopes, datasetsInfo)
738
719
 
739
- Gets the logic body
720
+ Generates a Filter Builder Structure from the Filter Data structure v2.1
740
721
 
741
722
 
742
723
 
@@ -745,7 +726,8 @@ Gets the logic body
745
726
 
746
727
  | Name | Type | Description | |
747
728
  | ---- | ---- | ----------- | -------- |
748
- | filterData | | The filter data object |   |
729
+ | scopes | | The filter scope section |   |
730
+ | datasetsInfo | | Collection of datasets information |   |
749
731
 
750
732
 
751
733
 
@@ -753,17 +735,17 @@ Gets the logic body
753
735
  ##### Returns
754
736
 
755
737
 
756
- - a filter logic array
738
+ - a flattened UI filters array
757
739
 
758
740
 
759
741
 
760
742
 
761
- ### dist/filters/adapters/FDToFlatUI.js
743
+ ### dist/filters/adapters/FDToLogic.js
762
744
 
763
745
 
764
- #### FDToFlatUI(filterData, datasetsInfo)
746
+ #### FDToLogic(filterData)
765
747
 
766
- Generates a Flattened UI filter structure from Filter Data structure.
748
+ Generates a Filter Logic structure from Filter Data structure.
767
749
 
768
750
 
769
751
 
@@ -773,7 +755,6 @@ Generates a Flattened UI filter structure from Filter Data structure.
773
755
  | Name | Type | Description | |
774
756
  | ---- | ---- | ----------- | -------- |
775
757
  | filterData | | The filter data object. |   |
776
- | datasetsInfo | | Collection of datasets information |   |
777
758
 
778
759
 
779
760
 
@@ -781,13 +762,13 @@ Generates a Flattened UI filter structure from Filter Data structure.
781
762
  ##### Returns
782
763
 
783
764
 
784
- - a flattened UI filters array
765
+ - a filter logic array
785
766
 
786
767
 
787
768
 
788
- #### FD21ToFlatUI(scopes, datasetsInfo)
769
+ #### getLogicBodyFromFD21(filterData)
789
770
 
790
- Generates a Filter Builder Structure from the Filter Data structure v2.1
771
+ Gets the logic body
791
772
 
792
773
 
793
774
 
@@ -796,8 +777,7 @@ Generates a Filter Builder Structure from the Filter Data structure v2.1
796
777
 
797
778
  | Name | Type | Description | |
798
779
  | ---- | ---- | ----------- | -------- |
799
- | scopes | | The filter scope section |   |
800
- | datasetsInfo | | Collection of datasets information |   |
780
+ | filterData | | The filter data object |   |
801
781
 
802
782
 
803
783
 
@@ -805,7 +785,7 @@ Generates a Filter Builder Structure from the Filter Data structure v2.1
805
785
  ##### Returns
806
786
 
807
787
 
808
- - a flattened UI filters array
788
+ - a filter logic array
809
789
 
810
790
 
811
791
 
@@ -1558,6 +1538,26 @@ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
1558
1538
 
1559
1539
 
1560
1540
 
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
 
@@ -1868,6 +1868,35 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
1868
1868
 
1869
1869
 
1870
1870
 
1871
+ ### dist/general/mix/compareDeep.js
1872
+
1873
+
1874
+ #### compareDeep(object1, object2)
1875
+
1876
+ Compares two objects to know if they are equals. Go across nested objects.
1877
+ Includes arrays in the comparison.
1878
+
1879
+
1880
+
1881
+
1882
+ ##### Parameters
1883
+
1884
+ | Name | Type | Description | |
1885
+ | ---- | ---- | ----------- | -------- |
1886
+ | object1 | | First Object to compare |   |
1887
+ | object2 | | Second Object to compare |   |
1888
+
1889
+
1890
+
1891
+
1892
+ ##### Returns
1893
+
1894
+
1895
+ - True: objects are equal. False: Objects are not equal. Undefined: invalid
1896
+
1897
+
1898
+
1899
+
1871
1900
  ### dist/general/mix/getTag.js
1872
1901
 
1873
1902
 
@@ -1980,39 +2009,10 @@ return a Promise that is resolved when the script is loaded
1980
2009
 
1981
2010
 
1982
2011
 
1983
- ### dist/general/mix/compareDeep.js
2012
+ ### dist/general/mix/isEmpty.js
1984
2013
 
1985
2014
 
1986
- #### compareDeep(object1, object2)
1987
-
1988
- Compares two objects to know if they are equals. Go across nested objects.
1989
- Includes arrays in the comparison.
1990
-
1991
-
1992
-
1993
-
1994
- ##### Parameters
1995
-
1996
- | Name | Type | Description | |
1997
- | ---- | ---- | ----------- | -------- |
1998
- | object1 | | First Object to compare |   |
1999
- | object2 | | Second Object to compare |   |
2000
-
2001
-
2002
-
2003
-
2004
- ##### Returns
2005
-
2006
-
2007
- - True: objects are equal. False: Objects are not equal. Undefined: invalid
2008
-
2009
-
2010
-
2011
-
2012
- ### dist/general/mix/isEmpty.js
2013
-
2014
-
2015
- #### isEmpty(variable, includeFalsy)
2015
+ #### isEmpty(variable, includeFalsy)
2016
2016
 
2017
2017
  Validates if the given argument is empty
2018
2018
 
@@ -2153,33 +2153,6 @@ Gets the length of the given array.
2153
2153
 
2154
2154
 
2155
2155
 
2156
- ### dist/general/string/capitalize.js
2157
-
2158
-
2159
- #### capitalize(text)
2160
-
2161
- Upper case the first letter of a given text
2162
-
2163
-
2164
-
2165
-
2166
- ##### Parameters
2167
-
2168
- | Name | Type | Description | |
2169
- | ---- | ---- | ----------- | -------- |
2170
- | text | `String` | |   |
2171
-
2172
-
2173
-
2174
-
2175
- ##### Returns
2176
-
2177
-
2178
- - `String` a capitalized text
2179
-
2180
-
2181
-
2182
-
2183
2156
  ### dist/general/object/cloneDeep.js
2184
2157
 
2185
2158
 
@@ -2265,12 +2238,20 @@ _get({ item1: { item11: 'Hello Again' }, item2: {} }, ['item1', 'item11'])
2265
2238
 
2266
2239
 
2267
2240
 
2268
- ### dist/general/object/hasProperty.js
2241
+ ### dist/general/object/getAttribute.js
2269
2242
 
2270
2243
 
2271
- #### _hasProperty(obj, property)
2244
+ #### getAttribute(obj, key)
2272
2245
 
2273
- Use the hasOwnProperty in order to verify if the given property exists in the object.
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
2274
2255
 
2275
2256
 
2276
2257
 
@@ -2279,8 +2260,8 @@ Use the hasOwnProperty in order to verify if the given property exists in the ob
2279
2260
 
2280
2261
  | Name | Type | Description | |
2281
2262
  | ---- | ---- | ----------- | -------- |
2282
- | obj | `object` | an object |   |
2283
- | property | `string` | String to verify if exists in the object as property |   |
2263
+ | obj | `object` | object to look for |   |
2264
+ | key | `string` | String attribute in snake_case style |   |
2284
2265
 
2285
2266
 
2286
2267
 
@@ -2288,37 +2269,24 @@ Use the hasOwnProperty in order to verify if the given property exists in the ob
2288
2269
  ##### Examples
2289
2270
 
2290
2271
  ```javascript
2291
- const prop = 'prop2'
2292
- const obj1 = { prop1: 'hello', prop2: 'world'}
2293
- _hasProperty(ob1, prop1) // true
2294
-
2295
- const obj2 = { prop1: 'hello world' }
2296
- _hasProperty(ob1, prop2) // false
2272
+ getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
2297
2273
  ```
2298
2274
 
2299
2275
 
2300
2276
  ##### Returns
2301
2277
 
2302
2278
 
2303
- - True if the object has the given property; otherwise, false.
2279
+ - `Void`
2304
2280
 
2305
2281
 
2306
2282
 
2307
2283
 
2308
- ### dist/general/object/getAttribute.js
2284
+ ### dist/general/object/hasProperty.js
2309
2285
 
2310
2286
 
2311
- #### getAttribute(obj, key)
2287
+ #### _hasProperty(obj, property)
2312
2288
 
2313
- Searchs for properties in different case styles such as: lower, upper, camel and pascal
2314
- - To optimize the searching, it is required a key in a snake_case style
2315
- - List of cases that do not match
2316
- -- From lower to snake case
2317
- -- From upper to snake case
2318
- -- From lower to camel case
2319
- -- From upper to camel case
2320
- -- From lower to pascal case
2321
- -- From upper to pascal case
2289
+ Use the hasOwnProperty in order to verify if the given property exists in the object.
2322
2290
 
2323
2291
 
2324
2292
 
@@ -2327,8 +2295,8 @@ Searchs for properties in different case styles such as: lower, upper, camel and
2327
2295
 
2328
2296
  | Name | Type | Description | |
2329
2297
  | ---- | ---- | ----------- | -------- |
2330
- | obj | `object` | object to look for |   |
2331
- | key | `string` | String attribute in snake_case style |   |
2298
+ | obj | `object` | an object |   |
2299
+ | property | `string` | String to verify if exists in the object as property |   |
2332
2300
 
2333
2301
 
2334
2302
 
@@ -2336,14 +2304,19 @@ Searchs for properties in different case styles such as: lower, upper, camel and
2336
2304
  ##### Examples
2337
2305
 
2338
2306
  ```javascript
2339
- getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
2307
+ const prop = 'prop2'
2308
+ const obj1 = { prop1: 'hello', prop2: 'world'}
2309
+ _hasProperty(ob1, prop1) // true
2310
+
2311
+ const obj2 = { prop1: 'hello world' }
2312
+ _hasProperty(ob1, prop2) // false
2340
2313
  ```
2341
2314
 
2342
2315
 
2343
2316
  ##### Returns
2344
2317
 
2345
2318
 
2346
- - `Void`
2319
+ - True if the object has the given property; otherwise, false.
2347
2320
 
2348
2321
 
2349
2322
 
@@ -2592,6 +2565,33 @@ serialize object to url param
2592
2565
 
2593
2566
 
2594
2567
 
2568
+ ### dist/general/string/capitalize.js
2569
+
2570
+
2571
+ #### capitalize(text)
2572
+
2573
+ Upper case the first letter of a given text
2574
+
2575
+
2576
+
2577
+
2578
+ ##### Parameters
2579
+
2580
+ | Name | Type | Description | |
2581
+ | ---- | ---- | ----------- | -------- |
2582
+ | text | `String` | |   |
2583
+
2584
+
2585
+
2586
+
2587
+ ##### Returns
2588
+
2589
+
2590
+ - `String` a capitalized text
2591
+
2592
+
2593
+
2594
+
2595
2595
  ### dist/qrvey/helpers/getColumnsLabel.js
2596
2596
 
2597
2597
 
@@ -2619,12 +2619,12 @@ Get an string of the properties of the given column.
2619
2619
 
2620
2620
 
2621
2621
 
2622
- ### dist/services/api/getAllQrveys.api.js
2622
+ ### dist/services/api/getAllDatasets.api.js
2623
2623
 
2624
2624
 
2625
- #### getAllQrveys(config, params)
2625
+ #### getAllDatasets(qrveyids)
2626
2626
 
2627
- POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
2627
+ Get a dataset list from a collection of Qrvey IDs
2628
2628
 
2629
2629
 
2630
2630
 
@@ -2633,8 +2633,7 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
2633
2633
 
2634
2634
  | Name | Type | Description | |
2635
2635
  | ---- | ---- | ----------- | -------- |
2636
- | config | | Configuration |   |
2637
- | params | | Object for getting precise data |   |
2636
+ | qrveyids | | Collection of Qrvey IDs |   |
2638
2637
 
2639
2638
 
2640
2639
 
@@ -2642,17 +2641,17 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
2642
2641
  ##### Returns
2643
2642
 
2644
2643
 
2645
- - `Void`
2644
+ - a promise
2646
2645
 
2647
2646
 
2648
2647
 
2649
2648
 
2650
- ### dist/services/api/getDatasetColumns.api.js
2649
+ ### dist/services/api/getAllQrveys.api.js
2651
2650
 
2652
2651
 
2653
- #### getDatasetColumns(qrveyid)
2652
+ #### getAllQrveys(config, params)
2654
2653
 
2655
- Get a dataset by Qrvey ID
2654
+ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
2656
2655
 
2657
2656
 
2658
2657
 
@@ -2661,7 +2660,8 @@ Get a dataset by Qrvey ID
2661
2660
 
2662
2661
  | Name | Type | Description | |
2663
2662
  | ---- | ---- | ----------- | -------- |
2664
- | qrveyid | | The Qrvey ID |   |
2663
+ | config | | Configuration |   |
2664
+ | params | | Object for getting precise data |   |
2665
2665
 
2666
2666
 
2667
2667
 
@@ -2669,17 +2669,17 @@ Get a dataset by Qrvey ID
2669
2669
  ##### Returns
2670
2670
 
2671
2671
 
2672
- - a promise
2672
+ - `Void`
2673
2673
 
2674
2674
 
2675
2675
 
2676
2676
 
2677
- ### dist/services/api/getAllDatasets.api.js
2677
+ ### dist/services/api/getDatasetColumns.api.js
2678
2678
 
2679
2679
 
2680
- #### getAllDatasets(qrveyids)
2680
+ #### getDatasetColumns(qrveyid)
2681
2681
 
2682
- Get a dataset list from a collection of Qrvey IDs
2682
+ Get a dataset by Qrvey ID
2683
2683
 
2684
2684
 
2685
2685
 
@@ -2688,7 +2688,7 @@ Get a dataset list from a collection of Qrvey IDs
2688
2688
 
2689
2689
  | Name | Type | Description | |
2690
2690
  | ---- | ---- | ----------- | -------- |
2691
- | qrveyids | | Collection of Qrvey IDs |   |
2691
+ | qrveyid | | The Qrvey ID |   |
2692
2692
 
2693
2693
 
2694
2694
 
@@ -3217,12 +3217,12 @@ Gets filters from the logic by the scopes hierarchy.
3217
3217
 
3218
3218
 
3219
3219
 
3220
- ### dist/filters/helpers/common/areFiltersEquals.js
3220
+ ### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
3221
3221
 
3222
3222
 
3223
- #### areFiltersEquals(filter1, filter2)
3223
+ #### getFilterBuilderGeneralConfig(config)
3224
3224
 
3225
- Validates if both filters are the same
3225
+ Returns a filter builder config object by a any given config
3226
3226
 
3227
3227
 
3228
3228
 
@@ -3231,8 +3231,7 @@ Validates if both filters are the same
3231
3231
 
3232
3232
  | Name | Type | Description | |
3233
3233
  | ---- | ---- | ----------- | -------- |
3234
- | filter1 | | filter 1 |   |
3235
- | filter2 | | filter 2 |   |
3234
+ | config | | any config object |   |
3236
3235
 
3237
3236
 
3238
3237
 
@@ -3240,17 +3239,17 @@ Validates if both filters are the same
3240
3239
  ##### Returns
3241
3240
 
3242
3241
 
3243
- - true: the filters are equal; false: the filters are NOT equal
3242
+ - The filter builder config object
3244
3243
 
3245
3244
 
3246
3245
 
3247
3246
 
3248
- ### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
3247
+ ### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
3249
3248
 
3250
3249
 
3251
- #### excludeFiltersByAggregateColumn(filterData)
3250
+ #### excludeUIFiltersByAggregate(uFilters)
3252
3251
 
3253
- Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
3252
+ Excludes Aggregate Filters in the Flattened UI Filters array
3254
3253
 
3255
3254
 
3256
3255
 
@@ -3259,7 +3258,7 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
3259
3258
 
3260
3259
  | Name | Type | Description | |
3261
3260
  | ---- | ---- | ----------- | -------- |
3262
- | filterData | | The filter data object |   |
3261
+ | uFilters | | Collection of Flat UI Filters |   |
3263
3262
 
3264
3263
 
3265
3264
 
@@ -3267,26 +3266,17 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
3267
3266
  ##### Returns
3268
3267
 
3269
3268
 
3270
- - The new filter data object that were excluded the aggregate filters
3269
+ - a new Flat UI Filters that were excluded the aggregate filters
3271
3270
 
3272
3271
 
3273
3272
 
3274
3273
 
3275
- ### dist/filters/helpers/common/excludeFiltersByParams.js
3274
+ ### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
3276
3275
 
3277
3276
 
3278
- #### excludeFiltersByParams(filterData, params)
3277
+ #### excludeUIFlatFiltersByScopes(uFilters, scopes)
3279
3278
 
3280
- Excludes filters from the given Filters.
3281
- The validation to filter the stored filter is depending on:
3282
- - Column
3283
- - Qrvey ID
3284
- - Scope type
3285
- - Scope ID
3286
- - Panel ID
3287
- - Validator type
3288
- - Property type
3289
- - Enabled flags
3279
+ Excludes and returns a UI Flat Filters without filters by the given scopes
3290
3280
 
3291
3281
 
3292
3282
 
@@ -3295,8 +3285,8 @@ The validation to filter the stored filter is depending on:
3295
3285
 
3296
3286
  | Name | Type | Description | |
3297
3287
  | ---- | ---- | ----------- | -------- |
3298
- | filterData | | The Filter Data or the UI Filter Data |   |
3299
- | params | | given parameters to validate the filter data |   |
3288
+ | uFilters | | The Flatten UI Filters |   |
3289
+ | scopes | | collection of scopes types |   |
3300
3290
 
3301
3291
 
3302
3292
 
@@ -3304,17 +3294,17 @@ The validation to filter the stored filter is depending on:
3304
3294
  ##### Returns
3305
3295
 
3306
3296
 
3307
- - a new Filter object structure
3297
+ - The new array of UI Flattened filters
3308
3298
 
3309
3299
 
3310
3300
 
3311
3301
 
3312
- ### dist/filters/helpers/common/excludeFiltersByScopes.js
3302
+ ### dist/filters/helpers/ui/getFilterPropertyLabel.js
3313
3303
 
3314
3304
 
3315
- #### excludeFiltersByScopes(filterData, scopes)
3305
+ #### getFilterPropertyLabel(filter)
3316
3306
 
3317
- Excludes and returns a filter data without filters by the given scopes
3307
+ Gets the label of the filter property
3318
3308
 
3319
3309
 
3320
3310
 
@@ -3323,8 +3313,7 @@ Excludes and returns a filter data without filters by the given scopes
3323
3313
 
3324
3314
  | Name | Type | Description | |
3325
3315
  | ---- | ---- | ----------- | -------- |
3326
- | filterData | | The Filter Data |   |
3327
- | scopes | | collection of scopes to be as filtering parameters |   |
3316
+ | filter | | The UI Filter |   |
3328
3317
 
3329
3318
 
3330
3319
 
@@ -3332,17 +3321,17 @@ Excludes and returns a filter data without filters by the given scopes
3332
3321
  ##### Returns
3333
3322
 
3334
3323
 
3335
- - The new Filter Data without filters by the given scopes.
3324
+ - a string of the filter property label
3336
3325
 
3337
3326
 
3338
3327
 
3339
3328
 
3340
- ### dist/filters/helpers/common/getFilterColumnLabel.js
3329
+ ### dist/filters/helpers/ui/getOutputFormatByColumn.js
3341
3330
 
3342
3331
 
3343
- #### getFilterColumnLabel(column)
3332
+ #### getOutputFormatByColumn(column, datasets)
3344
3333
 
3345
- Get an string of the properties of the given filter column.
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
3346
3335
 
3347
3336
 
3348
3337
 
@@ -3351,7 +3340,8 @@ Get an string of the properties of the given filter column.
3351
3340
 
3352
3341
  | Name | Type | Description | |
3353
3342
  | ---- | ---- | ----------- | -------- |
3354
- | column | | The filter column |   |
3343
+ | column | | The column |   |
3344
+ | datasets | | array of datasets |   |
3355
3345
 
3356
3346
 
3357
3347
 
@@ -3359,26 +3349,27 @@ Get an string of the properties of the given filter column.
3359
3349
  ##### Returns
3360
3350
 
3361
3351
 
3362
- - an string with the property, aggregate or calculation label.
3363
-
3364
-
3365
-
3352
+ - The output format object
3366
3353
 
3367
- ### dist/filters/helpers/common/getFilterLabel.js
3368
3354
 
3369
3355
 
3370
- #### getFilterLabel(filter)
3371
3356
 
3372
- Gets the Filter Label + Column label
3357
+ ### dist/filters/helpers/ui/getUIFlatFilterByParams.js
3373
3358
 
3374
3359
 
3360
+ #### getUIFlatFilterByParams()
3375
3361
 
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
3376
3371
 
3377
- ##### Parameters
3378
3372
 
3379
- | Name | Type | Description | |
3380
- | ---- | ---- | ----------- | -------- |
3381
- | filter | | the UI filter |   |
3382
3373
 
3383
3374
 
3384
3375
 
@@ -3386,37 +3377,28 @@ Gets the Filter Label + Column label
3386
3377
  ##### Returns
3387
3378
 
3388
3379
 
3389
- - a sring label
3380
+ - The index of the uFilter array or the Filter object s
3390
3381
 
3391
3382
 
3392
3383
 
3393
3384
 
3394
- ### dist/filters/helpers/common/getFilterid.js
3395
-
3396
-
3397
- #### getFilterid(filter)
3398
-
3399
- Get the Filter ID by the filter structure
3400
- The order of the epression ID is:
3401
- - Scope Type
3402
- - scopeid
3403
- - qrveyid
3404
- - panelid
3405
- - columnid
3406
- - validator
3407
- - property
3408
- - Column Aggregate
3409
- - Column Calculation
3410
- - Optional Index
3385
+ ### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
3411
3386
 
3412
3387
 
3388
+ #### getUIFlatFiltersByParams()
3413
3389
 
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
3414
3400
 
3415
- ##### Parameters
3416
3401
 
3417
- | Name | Type | Description | |
3418
- | ---- | ---- | ----------- | -------- |
3419
- | filter | | the filter structure |   |
3420
3402
 
3421
3403
 
3422
3404
 
@@ -3424,17 +3406,17 @@ The order of the epression ID is:
3424
3406
  ##### Returns
3425
3407
 
3426
3408
 
3427
- - a text to identify the filter
3409
+ - The index of the uFilter array or the Filter object s
3428
3410
 
3429
3411
 
3430
3412
 
3431
3413
 
3432
- ### dist/filters/helpers/common/getFiltersByAggregateColumn.js
3414
+ ### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
3433
3415
 
3434
3416
 
3435
- #### getFiltersByAggregateColumn(filterData)
3417
+ #### getUIFlatFiltersByScopes(uFilters, scopes)
3436
3418
 
3437
- Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
3419
+ Filters and gets a UI Flatten Filters by the given scopes
3438
3420
 
3439
3421
 
3440
3422
 
@@ -3443,7 +3425,8 @@ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggr
3443
3425
 
3444
3426
  | Name | Type | Description | |
3445
3427
  | ---- | ---- | ----------- | -------- |
3446
- | filterData | | The filter data object |   |
3428
+ | uFilters | | The Flatten UI Filters |   |
3429
+ | scopes | | collection of scopes types |   |
3447
3430
 
3448
3431
 
3449
3432
 
@@ -3451,26 +3434,17 @@ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggr
3451
3434
  ##### Returns
3452
3435
 
3453
3436
 
3454
- - The new filter data object that were get the aggregate filters
3437
+ - The new array of UI Flattened filters
3455
3438
 
3456
3439
 
3457
3440
 
3458
3441
 
3459
- ### dist/filters/helpers/common/getFiltersByParams.js
3442
+ ### dist/filters/helpers/ui/getUIValues.js
3460
3443
 
3461
3444
 
3462
- #### getFiltersByParams(filterData, params)
3445
+ #### getUIValues(filter, addEnableds, rankingGroupIndex)
3446
+
3463
3447
 
3464
- Gets filters from the given params.
3465
- The validation to filter the stored filter is depending on:
3466
- - Column
3467
- - Qrvey ID
3468
- - Scope type
3469
- - Scope ID
3470
- - Panel ID
3471
- - Validator type
3472
- - Property type
3473
- - Enabled flags
3474
3448
 
3475
3449
 
3476
3450
 
@@ -3479,8 +3453,9 @@ The validation to filter the stored filter is depending on:
3479
3453
 
3480
3454
  | Name | Type | Description | |
3481
3455
  | ---- | ---- | ----------- | -------- |
3482
- | filterData | | The Filter Data or the UI Filter Data |   |
3483
- | params | | given parameters to validate the dataset |   |
3456
+ | filter | | |   |
3457
+ | addEnableds | | |   |
3458
+ | rankingGroupIndex | | |   |
3484
3459
 
3485
3460
 
3486
3461
 
@@ -3488,17 +3463,17 @@ The validation to filter the stored filter is depending on:
3488
3463
  ##### Returns
3489
3464
 
3490
3465
 
3491
- - a new Filter object structure
3466
+ -
3492
3467
 
3493
3468
 
3494
3469
 
3495
3470
 
3496
- ### dist/filters/helpers/common/getFiltersByScopes.js
3471
+ ### dist/filters/helpers/ui/resolveUIFlatFiltersByParams.js
3497
3472
 
3498
3473
 
3499
- #### getFiltersByScopes(filterData, scopes)
3474
+ #### resolveUIFlatFilterByParams(filter, params)
3500
3475
 
3501
- Filters and gets a Filter Data by the given scopes
3476
+ Resolves conditions between UI flattened filter and given parameters
3502
3477
 
3503
3478
 
3504
3479
 
@@ -3507,8 +3482,8 @@ Filters and gets a Filter Data by the given scopes
3507
3482
 
3508
3483
  | Name | Type | Description | |
3509
3484
  | ---- | ---- | ----------- | -------- |
3510
- | filterData | | The Filter Data |   |
3511
- | scopes | | collection of scopes types |   |
3485
+ | filter | | UI Flatten Filter |   |
3486
+ | params | | Parameters to validate |   |
3512
3487
 
3513
3488
 
3514
3489
 
@@ -3516,17 +3491,17 @@ Filters and gets a Filter Data by the given scopes
3516
3491
  ##### Returns
3517
3492
 
3518
3493
 
3519
- - The new Filter Data
3494
+ - true: the conditions are satisfied.
3520
3495
 
3521
3496
 
3522
3497
 
3523
3498
 
3524
- ### dist/filters/helpers/common/getFiltersByScopesIds.js
3499
+ ### dist/filters/helpers/common/areFiltersEquals.js
3525
3500
 
3526
3501
 
3527
- #### getFiltersByScopesIds(filterData, scopes)
3502
+ #### areFiltersEquals(filter1, filter2)
3528
3503
 
3529
- Gets filters from Filter Data by Scopes/Scope IDs.
3504
+ Validates if both filters are the same
3530
3505
 
3531
3506
 
3532
3507
 
@@ -3535,8 +3510,8 @@ Gets filters from Filter Data by Scopes/Scope IDs.
3535
3510
 
3536
3511
  | Name | Type | Description | |
3537
3512
  | ---- | ---- | ----------- | -------- |
3538
- | filterData | | The filter data |   |
3539
- | scopes | | The collection of Scopes/Scope IDs |   |
3513
+ | filter1 | | filter 1 |   |
3514
+ | filter2 | | filter 2 |   |
3540
3515
 
3541
3516
 
3542
3517
 
@@ -3544,17 +3519,17 @@ Gets filters from Filter Data by Scopes/Scope IDs.
3544
3519
  ##### Returns
3545
3520
 
3546
3521
 
3547
- - a new Filter Data
3522
+ - true: the filters are equal; false: the filters are NOT equal
3548
3523
 
3549
3524
 
3550
3525
 
3551
3526
 
3552
- ### dist/filters/helpers/common/getFiltersByVisibility.js
3527
+ ### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
3553
3528
 
3554
3529
 
3555
- #### getFiltersByVisibility(filterData, scopes)
3530
+ #### excludeFiltersByAggregateColumn(filterData)
3556
3531
 
3557
- Get a new Filter Data by filtering scopes/scope IDs and enabled flags
3532
+ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
3558
3533
 
3559
3534
 
3560
3535
 
@@ -3563,8 +3538,7 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
3563
3538
 
3564
3539
  | Name | Type | Description | |
3565
3540
  | ---- | ---- | ----------- | -------- |
3566
- | filterData | | a Filter Data or UI Filter Data |   |
3567
- | scopes | | a Scopes/Scope IDs array |   |
3541
+ | filterData | | The filter data object |   |
3568
3542
 
3569
3543
 
3570
3544
 
@@ -3572,17 +3546,26 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
3572
3546
  ##### Returns
3573
3547
 
3574
3548
 
3575
- - a new Filter Data
3549
+ - The new filter data object that were excluded the aggregate filters
3576
3550
 
3577
3551
 
3578
3552
 
3579
3553
 
3580
- ### dist/filters/helpers/common/getMergeFiltersSettings.js
3554
+ ### dist/filters/helpers/common/excludeFiltersByParams.js
3581
3555
 
3582
3556
 
3583
- #### getMergeFiltersSettings(settings)
3557
+ #### excludeFiltersByParams(filterData, params)
3584
3558
 
3585
- Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
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
3569
 
3587
3570
 
3588
3571
 
@@ -3591,7 +3574,8 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
3591
3574
 
3592
3575
  | Name | Type | Description | |
3593
3576
  | ---- | ---- | ----------- | -------- |
3594
- | settings | | an object to the MergeFilters settings |   |
3577
+ | filterData | | The Filter Data or the UI Filter Data |   |
3578
+ | params | | given parameters to validate the filter data |   |
3595
3579
 
3596
3580
 
3597
3581
 
@@ -3599,17 +3583,17 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
3599
3583
  ##### Returns
3600
3584
 
3601
3585
 
3602
- - a new MergeFilters settings object.
3586
+ - a new Filter object structure
3603
3587
 
3604
3588
 
3605
3589
 
3606
3590
 
3607
- ### dist/filters/helpers/common/getParamsToGetFilterSettings.js
3591
+ ### dist/filters/helpers/common/excludeFiltersByScopes.js
3608
3592
 
3609
3593
 
3610
- #### getParamsToGetFilterSettings(settings)
3594
+ #### excludeFiltersByScopes(filterData, scopes)
3611
3595
 
3612
- Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
3596
+ Excludes and returns a filter data without filters by the given scopes
3613
3597
 
3614
3598
 
3615
3599
 
@@ -3618,7 +3602,8 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
3618
3602
 
3619
3603
  | Name | Type | Description | |
3620
3604
  | ---- | ---- | ----------- | -------- |
3621
- | settings | | an object to the ParamsToGetFilter settings |   |
3605
+ | filterData | | The Filter Data |   |
3606
+ | scopes | | collection of scopes to be as filtering parameters |   |
3622
3607
 
3623
3608
 
3624
3609
 
@@ -3626,17 +3611,17 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
3626
3611
  ##### Returns
3627
3612
 
3628
3613
 
3629
- - a new ParamsToGetFilter settings object.
3614
+ - The new Filter Data without filters by the given scopes.
3630
3615
 
3631
3616
 
3632
3617
 
3633
3618
 
3634
- ### dist/filters/helpers/common/haveFiltersByDataset.js
3619
+ ### dist/filters/helpers/common/getFilterLabel.js
3635
3620
 
3636
3621
 
3637
- #### haveFiltersByDataset(filterData, qrveyid)
3622
+ #### getFilterLabel(filter)
3638
3623
 
3639
- Validates if the filter data has filters by a dataset ID (Qrvey ID).
3624
+ Gets the Filter Label + Column label
3640
3625
 
3641
3626
 
3642
3627
 
@@ -3645,8 +3630,7 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
3645
3630
 
3646
3631
  | Name | Type | Description | |
3647
3632
  | ---- | ---- | ----------- | -------- |
3648
- | filterData | | the filter data or the UI filter data. |   |
3649
- | qrveyid | | The Qrvey ID |   |
3633
+ | filter | | the UI filter |   |
3650
3634
 
3651
3635
 
3652
3636
 
@@ -3654,17 +3638,17 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
3654
3638
  ##### Returns
3655
3639
 
3656
3640
 
3657
- - true: the filter data has filters by the Qrvey ID
3641
+ - a sring label
3658
3642
 
3659
3643
 
3660
3644
 
3661
3645
 
3662
- ### dist/filters/helpers/common/isBetweenValidator.js
3646
+ ### dist/filters/helpers/common/getFilterColumnLabel.js
3663
3647
 
3664
3648
 
3665
- #### isBetweenValidator(validator)
3649
+ #### getFilterColumnLabel(column)
3666
3650
 
3667
- Validates if the given validator is a Between type
3651
+ Get an string of the properties of the given filter column.
3668
3652
 
3669
3653
 
3670
3654
 
@@ -3673,7 +3657,7 @@ Validates if the given validator is a Between type
3673
3657
 
3674
3658
  | Name | Type | Description | |
3675
3659
  | ---- | ---- | ----------- | -------- |
3676
- | validator | | The validator |   |
3660
+ | column | | The filter column |   |
3677
3661
 
3678
3662
 
3679
3663
 
@@ -3681,17 +3665,28 @@ Validates if the given validator is a Between type
3681
3665
  ##### Returns
3682
3666
 
3683
3667
 
3684
- - true: it is a between validator; false: it is not a between validator
3668
+ - an string with the property, aggregate or calculation label.
3685
3669
 
3686
3670
 
3687
3671
 
3688
3672
 
3689
- ### dist/filters/helpers/common/isDateDistinctProperty.js
3673
+ ### dist/filters/helpers/common/getFilterid.js
3690
3674
 
3691
3675
 
3692
- #### isDateDistinctProperty(column, property)
3676
+ #### getFilterid(filter)
3693
3677
 
3694
- Determines if the filter column and property is a distinct group dates type
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
3695
3690
 
3696
3691
 
3697
3692
 
@@ -3700,8 +3695,7 @@ Determines if the filter column and property is a distinct group dates type
3700
3695
 
3701
3696
  | Name | Type | Description | |
3702
3697
  | ---- | ---- | ----------- | -------- |
3703
- | column | | The filter column |   |
3704
- | property | | The filter property |   |
3698
+ | filter | | the filter structure |   |
3705
3699
 
3706
3700
 
3707
3701
 
@@ -3709,17 +3703,17 @@ Determines if the filter column and property is a distinct group dates type
3709
3703
  ##### Returns
3710
3704
 
3711
3705
 
3712
- - True if the given property is included from distinct group dates type
3706
+ - a text to identify the filter
3713
3707
 
3714
3708
 
3715
3709
 
3716
3710
 
3717
- ### dist/filters/helpers/common/isInValidator.js
3711
+ ### dist/filters/helpers/common/getFiltersByAggregateColumn.js
3718
3712
 
3719
3713
 
3720
- #### isInValidator(validator)
3714
+ #### getFiltersByAggregateColumn(filterData)
3721
3715
 
3722
- Validates if the given validator is a In type
3716
+ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
3723
3717
 
3724
3718
 
3725
3719
 
@@ -3728,7 +3722,7 @@ Validates if the given validator is a In type
3728
3722
 
3729
3723
  | Name | Type | Description | |
3730
3724
  | ---- | ---- | ----------- | -------- |
3731
- | validator | | The validator |   |
3725
+ | filterData | | The filter data object |   |
3732
3726
 
3733
3727
 
3734
3728
 
@@ -3736,17 +3730,26 @@ Validates if the given validator is a In type
3736
3730
  ##### Returns
3737
3731
 
3738
3732
 
3739
- - true: it is a In validator; false: it is not a In validator
3733
+ - The new filter data object that were get the aggregate filters
3740
3734
 
3741
3735
 
3742
3736
 
3743
3737
 
3744
- ### dist/filters/helpers/common/isNullValidator.js
3738
+ ### dist/filters/helpers/common/getFiltersByParams.js
3745
3739
 
3746
3740
 
3747
- #### isNullValidator(validator)
3741
+ #### getFiltersByParams(filterData, params)
3748
3742
 
3749
- Checks if the given validator is a Null type.
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
3753
 
3751
3754
 
3752
3755
 
@@ -3755,7 +3758,8 @@ Checks if the given validator is a Null type.
3755
3758
 
3756
3759
  | Name | Type | Description | |
3757
3760
  | ---- | ---- | ----------- | -------- |
3758
- | validator | | The Filter Validator |   |
3761
+ | filterData | | The Filter Data or the UI Filter Data |   |
3762
+ | params | | given parameters to validate the dataset |   |
3759
3763
 
3760
3764
 
3761
3765
 
@@ -3763,17 +3767,17 @@ Checks if the given validator is a Null type.
3763
3767
  ##### Returns
3764
3768
 
3765
3769
 
3766
- - True: It is a Null Validator; False: It is not a Null Validator.
3770
+ - a new Filter object structure
3767
3771
 
3768
3772
 
3769
3773
 
3770
3774
 
3771
- ### dist/filters/helpers/common/isRangeValidator.js
3775
+ ### dist/filters/helpers/common/getFiltersByScopes.js
3772
3776
 
3773
3777
 
3774
- #### isRangeValidator(validator)
3778
+ #### getFiltersByScopes(filterData, scopes)
3775
3779
 
3776
- Validates if the given validator is a Range type. Range type means the value has min and max values to filter
3780
+ Filters and gets a Filter Data by the given scopes
3777
3781
 
3778
3782
 
3779
3783
 
@@ -3782,7 +3786,8 @@ Validates if the given validator is a Range type. Range type means the value has
3782
3786
 
3783
3787
  | Name | Type | Description | |
3784
3788
  | ---- | ---- | ----------- | -------- |
3785
- | validator | | The filter validator |   |
3789
+ | filterData | | The Filter Data |   |
3790
+ | scopes | | collection of scopes types |   |
3786
3791
 
3787
3792
 
3788
3793
 
@@ -3790,17 +3795,17 @@ Validates if the given validator is a Range type. Range type means the value has
3790
3795
  ##### Returns
3791
3796
 
3792
3797
 
3793
- - true: it is a range validator
3798
+ - The new Filter Data
3794
3799
 
3795
3800
 
3796
3801
 
3797
3802
 
3798
- ### dist/filters/helpers/common/isRegularValidator.js
3803
+ ### dist/filters/helpers/common/getFiltersByScopesIds.js
3799
3804
 
3800
3805
 
3801
- #### isRegularValidator(validator)
3806
+ #### getFiltersByScopesIds(filterData, scopes)
3802
3807
 
3803
- Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
3808
+ Gets filters from Filter Data by Scopes/Scope IDs.
3804
3809
 
3805
3810
 
3806
3811
 
@@ -3809,7 +3814,8 @@ Validates if the given validator is a regular type. Regular type means the filte
3809
3814
 
3810
3815
  | Name | Type | Description | |
3811
3816
  | ---- | ---- | ----------- | -------- |
3812
- | validator | | The filter validator |   |
3817
+ | filterData | | The filter data |   |
3818
+ | scopes | | The collection of Scopes/Scope IDs |   |
3813
3819
 
3814
3820
 
3815
3821
 
@@ -3817,17 +3823,17 @@ Validates if the given validator is a regular type. Regular type means the filte
3817
3823
  ##### Returns
3818
3824
 
3819
3825
 
3820
- - true: it is a range validator
3826
+ - a new Filter Data
3821
3827
 
3822
3828
 
3823
3829
 
3824
3830
 
3825
- ### dist/filters/helpers/common/mergeFilters.js
3831
+ ### dist/filters/helpers/common/getFiltersByVisibility.js
3826
3832
 
3827
3833
 
3828
- #### mergeFilters(filterData1, filterData2, overwriteValues)
3834
+ #### getFiltersByVisibility(filterData, scopes)
3829
3835
 
3830
- Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
3836
+ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
3831
3837
 
3832
3838
 
3833
3839
 
@@ -3836,9 +3842,8 @@ Merge filter data structures in a new one. The first Filter Data passed in the a
3836
3842
 
3837
3843
  | Name | Type | Description | |
3838
3844
  | ---- | ---- | ----------- | -------- |
3839
- | filterData1 | | The target filter data |   |
3840
- | filterData2 | | the filter data to be merged |   |
3841
- | overwriteValues | | Flag to overwrite or not the filter values |   |
3845
+ | filterData | | a Filter Data or UI Filter Data |   |
3846
+ | scopes | | a Scopes/Scope IDs array |   |
3842
3847
 
3843
3848
 
3844
3849
 
@@ -3846,13 +3851,17 @@ Merge filter data structures in a new one. The first Filter Data passed in the a
3846
3851
  ##### Returns
3847
3852
 
3848
3853
 
3849
- - a new filter data structure
3854
+ - a new Filter Data
3850
3855
 
3851
3856
 
3852
3857
 
3853
- #### mergeScopes(scopes1, scopes2, overwriteValues)
3854
3858
 
3855
- Gets a new scope structure array by merging two scope structures
3859
+ ### dist/filters/helpers/common/getMergeFiltersSettings.js
3860
+
3861
+
3862
+ #### getMergeFiltersSettings(settings)
3863
+
3864
+ Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
3856
3865
 
3857
3866
 
3858
3867
 
@@ -3861,9 +3870,7 @@ Gets a new scope structure array by merging two scope structures
3861
3870
 
3862
3871
  | Name | Type | Description | |
3863
3872
  | ---- | ---- | ----------- | -------- |
3864
- | scopes1 | | the target scope structure |   |
3865
- | scopes2 | | the scope to be merged |   |
3866
- | overwriteValues | | Flag to overwrite or not the filter values |   |
3873
+ | settings | | an object to the MergeFilters settings |   |
3867
3874
 
3868
3875
 
3869
3876
 
@@ -3871,13 +3878,17 @@ Gets a new scope structure array by merging two scope structures
3871
3878
  ##### Returns
3872
3879
 
3873
3880
 
3874
- - a new scope structure array
3881
+ - a new MergeFilters settings object.
3875
3882
 
3876
3883
 
3877
3884
 
3878
- #### mergeDatasets(datasets1, datasets2, overwriteValues)
3879
3885
 
3880
- Gets a new dataset structure array by merging two dataset structures
3886
+ ### dist/filters/helpers/common/getParamsToGetFilterSettings.js
3887
+
3888
+
3889
+ #### getParamsToGetFilterSettings(settings)
3890
+
3891
+ Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
3881
3892
 
3882
3893
 
3883
3894
 
@@ -3886,9 +3897,7 @@ Gets a new dataset structure array by merging two dataset structures
3886
3897
 
3887
3898
  | Name | Type | Description | |
3888
3899
  | ---- | ---- | ----------- | -------- |
3889
- | datasets1 | | the target dataset structure |   |
3890
- | datasets2 | | the dataset to be merged |   |
3891
- | overwriteValues | | Flag to overwrite or not the filter values |   |
3900
+ | settings | | an object to the ParamsToGetFilter settings |   |
3892
3901
 
3893
3902
 
3894
3903
 
@@ -3896,13 +3905,17 @@ Gets a new dataset structure array by merging two dataset structures
3896
3905
  ##### Returns
3897
3906
 
3898
3907
 
3899
- - a new dataset structure array
3908
+ - a new ParamsToGetFilter settings object.
3900
3909
 
3901
3910
 
3902
3911
 
3903
- #### mergeFilterss(filters1, filters2, overwriteValues)
3904
3912
 
3905
- Gets a new filter structure array by merging two filter structures
3913
+ ### dist/filters/helpers/common/haveFiltersByDataset.js
3914
+
3915
+
3916
+ #### haveFiltersByDataset(filterData, qrveyid)
3917
+
3918
+ Validates if the filter data has filters by a dataset ID (Qrvey ID).
3906
3919
 
3907
3920
 
3908
3921
 
@@ -3911,9 +3924,8 @@ Gets a new filter structure array by merging two filter structures
3911
3924
 
3912
3925
  | Name | Type | Description | |
3913
3926
  | ---- | ---- | ----------- | -------- |
3914
- | filters1 | | the target filter structure |   |
3915
- | filters2 | | the filter to be merged |   |
3916
- | overwriteValues | | Flag to overwrite or not the filter values |   |
3927
+ | filterData | | the filter data or the UI filter data. |   |
3928
+ | qrveyid | | The Qrvey ID |   |
3917
3929
 
3918
3930
 
3919
3931
 
@@ -3921,13 +3933,17 @@ Gets a new filter structure array by merging two filter structures
3921
3933
  ##### Returns
3922
3934
 
3923
3935
 
3924
- - a new filter structure array
3936
+ - true: the filter data has filters by the Qrvey ID
3925
3937
 
3926
3938
 
3927
3939
 
3928
- #### mergeValues(filter1, filter2, overwrite)
3929
3940
 
3930
- Gets a new value structure array by merging two value structures
3941
+ ### dist/filters/helpers/common/isBetweenValidator.js
3942
+
3943
+
3944
+ #### isBetweenValidator(validator)
3945
+
3946
+ Validates if the given validator is a Between type
3931
3947
 
3932
3948
 
3933
3949
 
@@ -3936,9 +3952,7 @@ Gets a new value structure array by merging two value structures
3936
3952
 
3937
3953
  | Name | Type | Description | |
3938
3954
  | ---- | ---- | ----------- | -------- |
3939
- | filter1 | | the target filter structure |   |
3940
- | filter2 | | the filter to be used to merge the values |   |
3941
- | overwrite | | Flag to overwrite or not the filter values |   |
3955
+ | validator | | The validator |   |
3942
3956
 
3943
3957
 
3944
3958
 
@@ -3946,17 +3960,17 @@ Gets a new value structure array by merging two value structures
3946
3960
  ##### Returns
3947
3961
 
3948
3962
 
3949
- - a new value structure array
3963
+ - true: it is a between validator; false: it is not a between validator
3950
3964
 
3951
3965
 
3952
3966
 
3953
3967
 
3954
- ### dist/filters/helpers/common/resolveDatasetConditions.js
3968
+ ### dist/filters/helpers/common/isDateDistinctProperty.js
3955
3969
 
3956
3970
 
3957
- #### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
3971
+ #### isDateDistinctProperty(column, property)
3958
3972
 
3959
- Resolves the conditions by given params
3973
+ Determines if the filter column and property is a distinct group dates type
3960
3974
 
3961
3975
 
3962
3976
 
@@ -3965,10 +3979,8 @@ Resolves the conditions by given params
3965
3979
 
3966
3980
  | Name | Type | Description | |
3967
3981
  | ---- | ---- | ----------- | -------- |
3968
- | filter | | The dataset structure |   |
3969
- | params | | given parameters to validate the dataset |   |
3970
- | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined |   |
3971
- | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. |   |
3982
+ | column | | The filter column |   |
3983
+ | property | | The filter property |   |
3972
3984
 
3973
3985
 
3974
3986
 
@@ -3976,17 +3988,17 @@ Resolves the conditions by given params
3976
3988
  ##### Returns
3977
3989
 
3978
3990
 
3979
- - true: the condition is satisfied
3991
+ - True if the given property is included from distinct group dates type
3980
3992
 
3981
3993
 
3982
3994
 
3983
3995
 
3984
- ### dist/filters/helpers/common/resolveFilterConditions.js
3996
+ ### dist/filters/helpers/common/isInValidator.js
3985
3997
 
3986
3998
 
3987
- #### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
3999
+ #### isInValidator(validator)
3988
4000
 
3989
- Resolves the conditions by given params
4001
+ Validates if the given validator is a In type
3990
4002
 
3991
4003
 
3992
4004
 
@@ -3995,10 +4007,7 @@ Resolves the conditions by given params
3995
4007
 
3996
4008
  | Name | Type | Description | |
3997
4009
  | ---- | ---- | ----------- | -------- |
3998
- | filter | | The filter |   |
3999
- | params | | given parameters to validate the filter |   |
4000
- | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined |   |
4001
- | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. |   |
4010
+ | validator | | The validator |   |
4002
4011
 
4003
4012
 
4004
4013
 
@@ -4006,17 +4015,17 @@ Resolves the conditions by given params
4006
4015
  ##### Returns
4007
4016
 
4008
4017
 
4009
- - true: the condition is satisfied
4018
+ - true: it is a In validator; false: it is not a In validator
4010
4019
 
4011
4020
 
4012
4021
 
4013
4022
 
4014
- ### dist/filters/helpers/common/resolveScopeConditions.js
4023
+ ### dist/filters/helpers/common/isNullValidator.js
4015
4024
 
4016
4025
 
4017
- #### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
4026
+ #### isNullValidator(validator)
4018
4027
 
4019
- Resolves the conditions by given params
4028
+ Checks if the given validator is a Null type.
4020
4029
 
4021
4030
 
4022
4031
 
@@ -4025,10 +4034,7 @@ Resolves the conditions by given params
4025
4034
 
4026
4035
  | Name | Type | Description | |
4027
4036
  | ---- | ---- | ----------- | -------- |
4028
- | filter | | The filter scope structure |   |
4029
- | params | | given parameters to validate the filter |   |
4030
- | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined |   |
4031
- | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. |   |
4037
+ | validator | | The Filter Validator |   |
4032
4038
 
4033
4039
 
4034
4040
 
@@ -4036,17 +4042,17 @@ Resolves the conditions by given params
4036
4042
  ##### Returns
4037
4043
 
4038
4044
 
4039
- - true: the condition is satisfied
4045
+ - True: It is a Null Validator; False: It is not a Null Validator.
4040
4046
 
4041
4047
 
4042
4048
 
4043
4049
 
4044
- ### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
4050
+ ### dist/filters/helpers/common/isRegularValidator.js
4045
4051
 
4046
4052
 
4047
- #### getFilterBuilderGeneralConfig(config)
4053
+ #### isRegularValidator(validator)
4048
4054
 
4049
- Returns a filter builder config object by a any given config
4055
+ Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
4050
4056
 
4051
4057
 
4052
4058
 
@@ -4055,7 +4061,7 @@ Returns a filter builder config object by a any given config
4055
4061
 
4056
4062
  | Name | Type | Description | |
4057
4063
  | ---- | ---- | ----------- | -------- |
4058
- | config | | any config object |   |
4064
+ | validator | | The filter validator |   |
4059
4065
 
4060
4066
 
4061
4067
 
@@ -4063,17 +4069,17 @@ Returns a filter builder config object by a any given config
4063
4069
  ##### Returns
4064
4070
 
4065
4071
 
4066
- - The filter builder config object
4072
+ - true: it is a range validator
4067
4073
 
4068
4074
 
4069
4075
 
4070
4076
 
4071
- ### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
4077
+ ### dist/filters/helpers/common/isRangeValidator.js
4072
4078
 
4073
4079
 
4074
- #### excludeUIFiltersByAggregate(uFilters)
4080
+ #### isRangeValidator(validator)
4075
4081
 
4076
- Excludes Aggregate Filters in the Flattened UI Filters array
4082
+ Validates if the given validator is a Range type. Range type means the value has min and max values to filter
4077
4083
 
4078
4084
 
4079
4085
 
@@ -4082,7 +4088,7 @@ Excludes Aggregate Filters in the Flattened UI Filters array
4082
4088
 
4083
4089
  | Name | Type | Description | |
4084
4090
  | ---- | ---- | ----------- | -------- |
4085
- | uFilters | | Collection of Flat UI Filters |   |
4091
+ | validator | | The filter validator |   |
4086
4092
 
4087
4093
 
4088
4094
 
@@ -4090,17 +4096,17 @@ Excludes Aggregate Filters in the Flattened UI Filters array
4090
4096
  ##### Returns
4091
4097
 
4092
4098
 
4093
- - a new Flat UI Filters that were excluded the aggregate filters
4099
+ - true: it is a range validator
4094
4100
 
4095
4101
 
4096
4102
 
4097
4103
 
4098
- ### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
4104
+ ### dist/filters/helpers/common/mergeFilters.js
4099
4105
 
4100
4106
 
4101
- #### excludeUIFlatFiltersByScopes(uFilters, scopes)
4107
+ #### mergeFilters(filterData1, filterData2, overwriteValues)
4102
4108
 
4103
- Excludes and returns a UI Flat Filters without filters by the given scopes
4109
+ Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
4104
4110
 
4105
4111
 
4106
4112
 
@@ -4109,8 +4115,9 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
4109
4115
 
4110
4116
  | Name | Type | Description | |
4111
4117
  | ---- | ---- | ----------- | -------- |
4112
- | uFilters | | The Flatten UI Filters |   |
4113
- | scopes | | collection of scopes types |   |
4118
+ | filterData1 | | The target filter data |   |
4119
+ | filterData2 | | the filter data to be merged |   |
4120
+ | overwriteValues | | Flag to overwrite or not the filter values |   |
4114
4121
 
4115
4122
 
4116
4123
 
@@ -4118,17 +4125,13 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
4118
4125
  ##### Returns
4119
4126
 
4120
4127
 
4121
- - The new array of UI Flattened filters
4122
-
4123
-
4124
-
4128
+ - a new filter data structure
4125
4129
 
4126
- ### dist/filters/helpers/ui/getFilterPropertyLabel.js
4127
4130
 
4128
4131
 
4129
- #### getFilterPropertyLabel(filter)
4132
+ #### mergeScopes(scopes1, scopes2, overwriteValues)
4130
4133
 
4131
- Gets the label of the filter property
4134
+ Gets a new scope structure array by merging two scope structures
4132
4135
 
4133
4136
 
4134
4137
 
@@ -4137,7 +4140,9 @@ Gets the label of the filter property
4137
4140
 
4138
4141
  | Name | Type | Description | |
4139
4142
  | ---- | ---- | ----------- | -------- |
4140
- | filter | | The UI Filter |   |
4143
+ | scopes1 | | the target scope structure |   |
4144
+ | scopes2 | | the scope to be merged |   |
4145
+ | overwriteValues | | Flag to overwrite or not the filter values |   |
4141
4146
 
4142
4147
 
4143
4148
 
@@ -4145,17 +4150,13 @@ Gets the label of the filter property
4145
4150
  ##### Returns
4146
4151
 
4147
4152
 
4148
- - a string of the filter property label
4149
-
4150
-
4151
-
4153
+ - a new scope structure array
4152
4154
 
4153
- ### dist/filters/helpers/ui/getOutputFormatByColumn.js
4154
4155
 
4155
4156
 
4156
- #### getOutputFormatByColumn(column, datasets)
4157
+ #### mergeDatasets(datasets1, datasets2, overwriteValues)
4157
4158
 
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
4159
+ Gets a new dataset structure array by merging two dataset structures
4159
4160
 
4160
4161
 
4161
4162
 
@@ -4164,8 +4165,9 @@ Gets output format object from Datasets by the given column. Item of the dataset
4164
4165
 
4165
4166
  | Name | Type | Description | |
4166
4167
  | ---- | ---- | ----------- | -------- |
4167
- | column | | The column |   |
4168
- | datasets | | array of datasets |   |
4168
+ | datasets1 | | the target dataset structure |   |
4169
+ | datasets2 | | the dataset to be merged |   |
4170
+ | overwriteValues | | Flag to overwrite or not the filter values |   |
4169
4171
 
4170
4172
 
4171
4173
 
@@ -4173,27 +4175,24 @@ Gets output format object from Datasets by the given column. Item of the dataset
4173
4175
  ##### Returns
4174
4176
 
4175
4177
 
4176
- - The output format object
4178
+ - a new dataset structure array
4177
4179
 
4178
4180
 
4179
4181
 
4182
+ #### mergeFilterss(filters1, filters2, overwriteValues)
4180
4183
 
4181
- ### dist/filters/helpers/ui/getUIFlatFilterByParams.js
4184
+ Gets a new filter structure array by merging two filter structures
4182
4185
 
4183
4186
 
4184
- #### getUIFlatFilterByParams()
4185
4187
 
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
4195
4188
 
4189
+ ##### Parameters
4196
4190
 
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 |   |
4197
4196
 
4198
4197
 
4199
4198
 
@@ -4201,28 +4200,24 @@ The validation to filter the stored filter is depending on:
4201
4200
  ##### Returns
4202
4201
 
4203
4202
 
4204
- - The index of the uFilter array or the Filter object s
4203
+ - a new filter structure array
4205
4204
 
4206
4205
 
4207
4206
 
4207
+ #### mergeValues(filter1, filter2, overwrite)
4208
4208
 
4209
- ### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
4209
+ Gets a new value structure array by merging two value structures
4210
4210
 
4211
4211
 
4212
- #### getUIFlatFiltersByParams()
4213
4212
 
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
4224
4213
 
4214
+ ##### Parameters
4225
4215
 
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 |   |
4226
4221
 
4227
4222
 
4228
4223
 
@@ -4230,17 +4225,17 @@ The validation to filter the stored filter is depending on:
4230
4225
  ##### Returns
4231
4226
 
4232
4227
 
4233
- - The index of the uFilter array or the Filter object s
4228
+ - a new value structure array
4234
4229
 
4235
4230
 
4236
4231
 
4237
4232
 
4238
- ### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
4233
+ ### dist/filters/helpers/common/resolveDatasetConditions.js
4239
4234
 
4240
4235
 
4241
- #### getUIFlatFiltersByScopes(uFilters, scopes)
4236
+ #### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
4242
4237
 
4243
- Filters and gets a UI Flatten Filters by the given scopes
4238
+ Resolves the conditions by given params
4244
4239
 
4245
4240
 
4246
4241
 
@@ -4249,8 +4244,10 @@ Filters and gets a UI Flatten Filters by the given scopes
4249
4244
 
4250
4245
  | Name | Type | Description | |
4251
4246
  | ---- | ---- | ----------- | -------- |
4252
- | uFilters | | The Flatten UI Filters |   |
4253
- | scopes | | collection of scopes types |   |
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. |   |
4254
4251
 
4255
4252
 
4256
4253
 
@@ -4258,17 +4255,17 @@ Filters and gets a UI Flatten Filters by the given scopes
4258
4255
  ##### Returns
4259
4256
 
4260
4257
 
4261
- - The new array of UI Flattened filters
4262
-
4258
+ - true: the condition is satisfied
4263
4259
 
4264
4260
 
4265
4261
 
4266
- ### dist/filters/helpers/ui/getUIValues.js
4267
4262
 
4263
+ ### dist/filters/helpers/common/resolveFilterConditions.js
4268
4264
 
4269
- #### getUIValues(filter, addEnableds, rankingGroupIndex)
4270
4265
 
4266
+ #### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
4271
4267
 
4268
+ Resolves the conditions by given params
4272
4269
 
4273
4270
 
4274
4271
 
@@ -4277,9 +4274,10 @@ Filters and gets a UI Flatten Filters by the given scopes
4277
4274
 
4278
4275
  | Name | Type | Description | |
4279
4276
  | ---- | ---- | ----------- | -------- |
4280
- | filter | | |   |
4281
- | addEnableds | | |   |
4282
- | rankingGroupIndex | | |   |
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. |   |
4283
4281
 
4284
4282
 
4285
4283
 
@@ -4287,17 +4285,17 @@ Filters and gets a UI Flatten Filters by the given scopes
4287
4285
  ##### Returns
4288
4286
 
4289
4287
 
4290
- -
4288
+ - true: the condition is satisfied
4291
4289
 
4292
4290
 
4293
4291
 
4294
4292
 
4295
- ### dist/filters/helpers/ui/resolveUIFlatFiltersByParams.js
4293
+ ### dist/filters/helpers/common/resolveScopeConditions.js
4296
4294
 
4297
4295
 
4298
- #### resolveUIFlatFilterByParams(filter, params)
4296
+ #### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
4299
4297
 
4300
- Resolves conditions between UI flattened filter and given parameters
4298
+ Resolves the conditions by given params
4301
4299
 
4302
4300
 
4303
4301
 
@@ -4306,8 +4304,10 @@ Resolves conditions between UI flattened filter and given parameters
4306
4304
 
4307
4305
  | Name | Type | Description | |
4308
4306
  | ---- | ---- | ----------- | -------- |
4309
- | filter | | UI Flatten Filter |   |
4310
- | params | | Parameters to validate |   |
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. |   |
4311
4311
 
4312
4312
 
4313
4313
 
@@ -4315,7 +4315,7 @@ Resolves conditions between UI flattened filter and given parameters
4315
4315
  ##### Returns
4316
4316
 
4317
4317
 
4318
- - true: the conditions are satisfied.
4318
+ - true: the condition is satisfied
4319
4319
 
4320
4320
 
4321
4321