@qrvey/utils 1.8.0-8 → 1.8.0

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.8.0-8*
1
+ # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.8.0*
2
2
 
3
3
  > Helper, Utils for all Qrvey Projects
4
4
 
@@ -199,34 +199,6 @@ If data is truthy and data.dateColumn is truthy, return true, otherwise return f
199
199
 
200
200
 
201
201
 
202
- #### metricMakeTimeData(dateColumn, timeData, range)
203
-
204
- It takes a date column, time data, and a custom range config and returns a metric period or metric
205
- custom range
206
-
207
-
208
-
209
-
210
- ##### Parameters
211
-
212
- | Name | Type | Description | |
213
- | ---- | ---- | ----------- | -------- |
214
- | dateColumn | | - The column that contains the date data. |   |
215
- | timeData | | - { |   |
216
- | range | `CustomRangeConfig` | - CustomRangeConfig |   |
217
-
218
-
219
-
220
-
221
- ##### Returns
222
-
223
-
224
- - An object with the following properties: - label
225
- - value
226
- - questionid
227
-
228
-
229
-
230
202
  #### getConfigRelativeObjectBytimeLabel(timeLabel, range)
231
203
 
232
204
  Given a time label and a custom range, return a relative date config or a metric custom range.
@@ -2386,36 +2358,16 @@ Adapter for model answer to convert to recognizable values for Filter Builder
2386
2358
 
2387
2359
 
2388
2360
 
2389
- ### dist/filters/helpers/OLD_getAggFilters.js
2390
-
2391
-
2392
- #### getAggFilters(logics, summaries)
2393
-
2394
-
2395
-
2396
-
2397
-
2398
-
2399
- ##### Parameters
2400
-
2401
- | Name | Type | Description | |
2402
- | ---- | ---- | ----------- | -------- |
2403
- | logics | | |   |
2404
- | summaries | | |   |
2405
-
2406
-
2407
-
2408
-
2409
- ##### Returns
2410
-
2411
-
2412
- - the filter aggregate structure
2361
+ ### dist/format/duration/addDurationFormat.js
2413
2362
 
2414
2363
 
2364
+ #### addDurationFormat(number, format[, locale, fractionDigits])
2415
2365
 
2416
- #### getAggregateFilters(logics, formatToFilters)
2366
+ [TODO: The decimals dots are not working correctly, we need to reviewing (fractionDigits)]
2367
+ "Convert a number of seconds to a human readable string."
2417
2368
 
2418
- Filters and gets the filters used for aggregate values.
2369
+ `addDurationFormat` is a function that takes a number, a format, an optional locale, and an optional
2370
+ number of fraction digits, and returns a string
2419
2371
 
2420
2372
 
2421
2373
 
@@ -2424,8 +2376,10 @@ Filters and gets the filters used for aggregate values.
2424
2376
 
2425
2377
  | Name | Type | Description | |
2426
2378
  | ---- | ---- | ----------- | -------- |
2427
- | logics | | The filter logic structure |   |
2428
- | formatToFilters | | Flag to change de way of returning the filter structure. |   |
2379
+ | number | `number` | - The number of milliseconds to format. |   |
2380
+ | format | `string` | - The format string. |   |
2381
+ | locale | `string` | - The locale to use for formatting. If not specified, the default locale is used. | *Optional* |
2382
+ | fractionDigits | `number` | - The number of digits to show after the decimal point. | *Optional* |
2429
2383
 
2430
2384
 
2431
2385
 
@@ -2433,28 +2387,19 @@ Filters and gets the filters used for aggregate values.
2433
2387
  ##### Returns
2434
2388
 
2435
2389
 
2436
- - the aggregate filters in the IFilterFilters way or as logic structure.
2437
-
2438
-
2439
-
2390
+ - A string
2440
2391
 
2441
- ### dist/filters/helpers/applyHierarchyForAggFilters.js
2442
2392
 
2443
2393
 
2444
- #### applyHierarchyForAggFilters(chartSettings, scopes, currentScope)
2445
2394
 
2446
- [TODO: Make a proper description for this function]
2395
+ ### dist/format/duration/durationFormatter.js
2447
2396
 
2448
2397
 
2398
+ #### setLocaleFormatter()
2449
2399
 
2400
+ It sets the locale formatter for the number.
2450
2401
 
2451
- ##### Parameters
2452
2402
 
2453
- | Name | Type | Description | |
2454
- | ---- | ---- | ----------- | -------- |
2455
- | chartSettings | | Chart Settings for the Filter Builder |   |
2456
- | scopes | | the pair id/label scopes |   |
2457
- | currentScope | | the scope to be validated |   |
2458
2403
 
2459
2404
 
2460
2405
 
@@ -2462,17 +2407,14 @@ Filters and gets the filters used for aggregate values.
2462
2407
  ##### Returns
2463
2408
 
2464
2409
 
2465
- - the chart settings
2466
-
2467
-
2468
-
2410
+ - `Void`
2469
2411
 
2470
- ### dist/filters/helpers/filtersTokensToString.js
2471
2412
 
2472
2413
 
2473
- #### filtersTokensToString(tokens)
2414
+ #### getNewNumberFormat(locale)
2474
2415
 
2475
- It takes an array of tokens and returns a string
2416
+ It returns a new instance of the Intl.NumberFormat class, which is a built-in JavaScript class
2417
+ that formats numbers
2476
2418
 
2477
2419
 
2478
2420
 
@@ -2481,7 +2423,7 @@ It takes an array of tokens and returns a string
2481
2423
 
2482
2424
  | Name | Type | Description | |
2483
2425
  | ---- | ---- | ----------- | -------- |
2484
- | tokens | `Array.<IFFilterTokens>` | - IFFilterTokens[] - the tokens to convert to a string | &nbsp; |
2426
+ | locale | `string` `Array.<string>` | - string | string[] | &nbsp; |
2485
2427
 
2486
2428
 
2487
2429
 
@@ -2489,17 +2431,14 @@ It takes an array of tokens and returns a string
2489
2431
  ##### Returns
2490
2432
 
2491
2433
 
2492
- - A string
2493
-
2494
-
2495
-
2496
-
2497
- ### dist/filters/helpers/getAggFiltersFromFilterData.js
2434
+ - A new instance of the Intl.NumberFormat class.
2498
2435
 
2499
2436
 
2500
- #### getAggFiltersFromFilterData(filterData, _summaries) *private method*
2501
2437
 
2438
+ #### setParts(template)
2502
2439
 
2440
+ It takes a template string and sets the parts property to the result of calling the
2441
+ parseFormatTemplate function with the template string as an argument
2503
2442
 
2504
2443
 
2505
2444
 
@@ -2508,8 +2447,7 @@ It takes an array of tokens and returns a string
2508
2447
 
2509
2448
  | Name | Type | Description | |
2510
2449
  | ---- | ---- | ----------- | -------- |
2511
- | filterData | | | &nbsp; |
2512
- | _summaries | | | &nbsp; |
2450
+ | template | `string` | - The format template string. | &nbsp; |
2513
2451
 
2514
2452
 
2515
2453
 
@@ -2517,17 +2455,13 @@ It takes an array of tokens and returns a string
2517
2455
  ##### Returns
2518
2456
 
2519
2457
 
2520
- - the aggFilters structure
2521
-
2522
-
2523
-
2458
+ - `Void`
2524
2459
 
2525
- ### dist/filters/helpers/getAvailableScopes.js
2526
2460
 
2527
2461
 
2528
- #### getAvailableScopes(config)
2462
+ #### matchFormatsReplace(template)
2529
2463
 
2530
- Gets Scopes/Scope IDs by given IDs
2464
+ It replaces the H and D characters in the template with h and d respectively
2531
2465
 
2532
2466
 
2533
2467
 
@@ -2536,7 +2470,7 @@ Gets Scopes/Scope IDs by given IDs
2536
2470
 
2537
2471
  | Name | Type | Description | |
2538
2472
  | ---- | ---- | ----------- | -------- |
2539
- | config | | given Differnts IDs in order set a available scope | &nbsp; |
2473
+ | template | `string` | - The template string to be used for the date format. | &nbsp; |
2540
2474
 
2541
2475
 
2542
2476
 
@@ -2544,26 +2478,15 @@ Gets Scopes/Scope IDs by given IDs
2544
2478
  ##### Returns
2545
2479
 
2546
2480
 
2547
- - a Scopes/Scope IDs array
2548
-
2549
-
2550
-
2551
-
2552
- ### dist/filters/helpers/getAvailableScopesIDsByConfig.js
2553
-
2554
-
2555
- #### getAvailableScopesIDsByConfig(config)
2481
+ - The template string with all instances of H replaced with h and all instances of D replaced with d.
2556
2482
 
2557
- Gets the Scopes IDS for the Available Scope function by any config
2558
2483
 
2559
2484
 
2485
+ #### setNumberFactor()
2560
2486
 
2487
+ It sets the numberFactor to the value of the duration part that matches the unit.
2561
2488
 
2562
- ##### Parameters
2563
2489
 
2564
- | Name | Type | Description | |
2565
- | ---- | ---- | ----------- | -------- |
2566
- | config | | any config | &nbsp; |
2567
2490
 
2568
2491
 
2569
2492
 
@@ -2571,17 +2494,14 @@ Gets the Scopes IDS for the Available Scope function by any config
2571
2494
  ##### Returns
2572
2495
 
2573
2496
 
2574
- - a Available Scope IDS config
2575
-
2576
-
2577
-
2497
+ - `Void`
2578
2498
 
2579
- ### dist/filters/helpers/getScopesByHierarchy.js
2580
2499
 
2581
2500
 
2582
- #### getScopesByHierarchy(scopes, currentScope)
2501
+ #### parseFormatTemplate(template)
2583
2502
 
2584
- [TODO: Make a description for this]
2503
+ It takes a string, splits it into an array of strings, then maps each string to a config object,
2504
+ then filters out any falsy values, then reverses the array
2585
2505
 
2586
2506
 
2587
2507
 
@@ -2590,8 +2510,7 @@ Gets the Scopes IDS for the Available Scope function by any config
2590
2510
 
2591
2511
  | Name | Type | Description | |
2592
2512
  | ---- | ---- | ----------- | -------- |
2593
- | scopes | | the collection of Scopes/Scope IDs | &nbsp; |
2594
- | currentScope | | Current scope type | &nbsp; |
2513
+ | template | `string` | - string - the template string that we want to parse | &nbsp; |
2595
2514
 
2596
2515
 
2597
2516
 
@@ -2599,17 +2518,14 @@ Gets the Scopes IDS for the Available Scope function by any config
2599
2518
  ##### Returns
2600
2519
 
2601
2520
 
2602
- - A new array of Scopes/Scope IDs
2603
-
2604
-
2605
-
2521
+ - An array of objects that have the order and the name of the part of the duration.
2606
2522
 
2607
- ### dist/filters/helpers/getTokensFromFilters.js
2608
2523
 
2609
2524
 
2610
- #### getTokensFromFilters(filters, options)
2525
+ #### format(number)
2611
2526
 
2612
- It takes a filter object and returns an array of tokens that represent the filter
2527
+ It takes a number, multiplies it by a factor, then uses the parts array to calculate the number
2528
+ of each part in the number, then uses the template to format the number
2613
2529
 
2614
2530
 
2615
2531
 
@@ -2618,8 +2534,7 @@ It takes a filter object and returns an array of tokens that represent the filte
2618
2534
 
2619
2535
  | Name | Type | Description | |
2620
2536
  | ---- | ---- | ----------- | -------- |
2621
- | filters | `IFUData` | - The filters object. | &nbsp; |
2622
- | options | `IFTokensFromFiltersSettings` | - IFTokensFromFiltersSettings | &nbsp; |
2537
+ | number | `number` | - The number of milliseconds to format. | &nbsp; |
2623
2538
 
2624
2539
 
2625
2540
 
@@ -2627,17 +2542,13 @@ It takes a filter object and returns an array of tokens that represent the filte
2627
2542
  ##### Returns
2628
2543
 
2629
2544
 
2630
- - `Array.&lt;IFFilterTokens&gt;` An array of tokens that represents the filters object
2631
-
2632
-
2633
-
2545
+ - The template string with the values replaced.
2634
2546
 
2635
- ### dist/filters/helpers/getVerboseFilter.js
2636
2547
 
2637
2548
 
2638
- #### getVerboseFilter(filters, options)
2549
+ #### formatValue(parts, part)
2639
2550
 
2640
- It takes a set of filters and returns a string that describes the filters
2551
+ It takes a dictionary of values and a list of keys, and returns a formatted string
2641
2552
 
2642
2553
 
2643
2554
 
@@ -2646,8 +2557,8 @@ It takes a set of filters and returns a string that describes the filters
2646
2557
 
2647
2558
  | Name | Type | Description | |
2648
2559
  | ---- | ---- | ----------- | -------- |
2649
- | filters | `IFUData` | - The filters object that you want to convert to a string. | &nbsp; |
2650
- | options | `IFTokensFromFiltersSettings` | - IFTokensFromFiltersSettings | &nbsp; |
2560
+ | parts | | - { [x: string]: any; } | &nbsp; |
2561
+ | part | `string` `Array.<string|number>` | - This is the part of the date that we're formatting. | &nbsp; |
2651
2562
 
2652
2563
 
2653
2564
 
@@ -2655,7 +2566,7 @@ It takes a set of filters and returns a string that describes the filters
2655
2566
  ##### Returns
2656
2567
 
2657
2568
 
2658
- - A string
2569
+ - The value of the part of the date that is being formatted.
2659
2570
 
2660
2571
 
2661
2572
 
@@ -3516,16 +3427,12 @@ Checks if two filter columns are the same.
3516
3427
 
3517
3428
 
3518
3429
 
3519
- ### dist/format/duration/addDurationFormat.js
3430
+ ### dist/filters/helpers/OLD_getAggFilters.js
3520
3431
 
3521
3432
 
3522
- #### addDurationFormat(number, format[, locale, fractionDigits])
3433
+ #### getAggFilters(logics, summaries)
3523
3434
 
3524
- [TODO: The decimals dots are not working correctly, we need to reviewing (fractionDigits)]
3525
- "Convert a number of seconds to a human readable string."
3526
3435
 
3527
- `addDurationFormat` is a function that takes a number, a format, an optional locale, and an optional
3528
- number of fraction digits, and returns a string
3529
3436
 
3530
3437
 
3531
3438
 
@@ -3534,10 +3441,8 @@ number of fraction digits, and returns a string
3534
3441
 
3535
3442
  | Name | Type | Description | |
3536
3443
  | ---- | ---- | ----------- | -------- |
3537
- | number | `number` | - The number of milliseconds to format. | &nbsp; |
3538
- | format | `string` | - The format string. | &nbsp; |
3539
- | locale | `string` | - The locale to use for formatting. If not specified, the default locale is used. | *Optional* |
3540
- | fractionDigits | `number` | - The number of digits to show after the decimal point. | *Optional* |
3444
+ | logics | | | &nbsp; |
3445
+ | summaries | | | &nbsp; |
3541
3446
 
3542
3447
 
3543
3448
 
@@ -3545,19 +3450,23 @@ number of fraction digits, and returns a string
3545
3450
  ##### Returns
3546
3451
 
3547
3452
 
3548
- - A string
3453
+ - the filter aggregate structure
3549
3454
 
3550
3455
 
3551
3456
 
3457
+ #### getAggregateFilters(logics, formatToFilters)
3552
3458
 
3553
- ### dist/format/duration/durationFormatter.js
3459
+ Filters and gets the filters used for aggregate values.
3554
3460
 
3555
3461
 
3556
- #### setLocaleFormatter()
3557
3462
 
3558
- It sets the locale formatter for the number.
3559
3463
 
3464
+ ##### Parameters
3560
3465
 
3466
+ | Name | Type | Description | |
3467
+ | ---- | ---- | ----------- | -------- |
3468
+ | logics | | The filter logic structure | &nbsp; |
3469
+ | formatToFilters | | Flag to change de way of returning the filter structure. | &nbsp; |
3561
3470
 
3562
3471
 
3563
3472
 
@@ -3565,14 +3474,17 @@ It sets the locale formatter for the number.
3565
3474
  ##### Returns
3566
3475
 
3567
3476
 
3568
- - `Void`
3477
+ - the aggregate filters in the IFilterFilters way or as logic structure.
3569
3478
 
3570
3479
 
3571
3480
 
3572
- #### getNewNumberFormat(locale)
3573
3481
 
3574
- It returns a new instance of the Intl.NumberFormat class, which is a built-in JavaScript class
3575
- that formats numbers
3482
+ ### dist/filters/helpers/applyHierarchyForAggFilters.js
3483
+
3484
+
3485
+ #### applyHierarchyForAggFilters(chartSettings, scopes, currentScope)
3486
+
3487
+ [TODO: Make a proper description for this function]
3576
3488
 
3577
3489
 
3578
3490
 
@@ -3581,7 +3493,9 @@ that formats numbers
3581
3493
 
3582
3494
  | Name | Type | Description | |
3583
3495
  | ---- | ---- | ----------- | -------- |
3584
- | locale | `string` `Array.<string>` | - string | string[] | &nbsp; |
3496
+ | chartSettings | | Chart Settings for the Filter Builder | &nbsp; |
3497
+ | scopes | | the pair id/label scopes | &nbsp; |
3498
+ | currentScope | | the scope to be validated | &nbsp; |
3585
3499
 
3586
3500
 
3587
3501
 
@@ -3589,14 +3503,17 @@ that formats numbers
3589
3503
  ##### Returns
3590
3504
 
3591
3505
 
3592
- - A new instance of the Intl.NumberFormat class.
3506
+ - the chart settings
3593
3507
 
3594
3508
 
3595
3509
 
3596
- #### setParts(template)
3597
3510
 
3598
- It takes a template string and sets the parts property to the result of calling the
3599
- parseFormatTemplate function with the template string as an argument
3511
+ ### dist/filters/helpers/filtersTokensToString.js
3512
+
3513
+
3514
+ #### filtersTokensToString(tokens)
3515
+
3516
+ It takes an array of tokens and returns a string
3600
3517
 
3601
3518
 
3602
3519
 
@@ -3605,7 +3522,7 @@ parseFormatTemplate function with the template string as an argument
3605
3522
 
3606
3523
  | Name | Type | Description | |
3607
3524
  | ---- | ---- | ----------- | -------- |
3608
- | template | `string` | - The format template string. | &nbsp; |
3525
+ | tokens | `Array.<IFFilterTokens>` | - IFFilterTokens[] - the tokens to convert to a string | &nbsp; |
3609
3526
 
3610
3527
 
3611
3528
 
@@ -3613,13 +3530,17 @@ parseFormatTemplate function with the template string as an argument
3613
3530
  ##### Returns
3614
3531
 
3615
3532
 
3616
- - `Void`
3533
+ - A string
3617
3534
 
3618
3535
 
3619
3536
 
3620
- #### matchFormatsReplace(template)
3621
3537
 
3622
- It replaces the H and D characters in the template with h and d respectively
3538
+ ### dist/filters/helpers/getAggFiltersFromFilterData.js
3539
+
3540
+
3541
+ #### getAggFiltersFromFilterData(filterData, _summaries) *private method*
3542
+
3543
+
3623
3544
 
3624
3545
 
3625
3546
 
@@ -3628,7 +3549,8 @@ It replaces the H and D characters in the template with h and d respectively
3628
3549
 
3629
3550
  | Name | Type | Description | |
3630
3551
  | ---- | ---- | ----------- | -------- |
3631
- | template | `string` | - The template string to be used for the date format. | &nbsp; |
3552
+ | filterData | | | &nbsp; |
3553
+ | _summaries | | | &nbsp; |
3632
3554
 
3633
3555
 
3634
3556
 
@@ -3636,30 +3558,44 @@ It replaces the H and D characters in the template with h and d respectively
3636
3558
  ##### Returns
3637
3559
 
3638
3560
 
3639
- - The template string with all instances of H replaced with h and all instances of D replaced with d.
3561
+ - the aggFilters structure
3640
3562
 
3641
3563
 
3642
3564
 
3643
- #### setNumberFactor()
3644
3565
 
3645
- It sets the numberFactor to the value of the duration part that matches the unit.
3566
+ ### dist/filters/helpers/getAvailableScopes.js
3646
3567
 
3647
3568
 
3569
+ #### getAvailableScopes(config)
3648
3570
 
3571
+ Gets Scopes/Scope IDs by given IDs
3649
3572
 
3650
3573
 
3651
3574
 
3652
- ##### Returns
3653
3575
 
3576
+ ##### Parameters
3654
3577
 
3655
- - `Void`
3578
+ | Name | Type | Description | |
3579
+ | ---- | ---- | ----------- | -------- |
3580
+ | config | | given Differnts IDs in order set a available scope | &nbsp; |
3656
3581
 
3657
3582
 
3658
3583
 
3659
- #### parseFormatTemplate(template)
3660
3584
 
3661
- It takes a string, splits it into an array of strings, then maps each string to a config object,
3662
- then filters out any falsy values, then reverses the array
3585
+ ##### Returns
3586
+
3587
+
3588
+ - a Scopes/Scope IDs array
3589
+
3590
+
3591
+
3592
+
3593
+ ### dist/filters/helpers/getAvailableScopesIDsByConfig.js
3594
+
3595
+
3596
+ #### getAvailableScopesIDsByConfig(config)
3597
+
3598
+ Gets the Scopes IDS for the Available Scope function by any config
3663
3599
 
3664
3600
 
3665
3601
 
@@ -3668,7 +3604,7 @@ then filters out any falsy values, then reverses the array
3668
3604
 
3669
3605
  | Name | Type | Description | |
3670
3606
  | ---- | ---- | ----------- | -------- |
3671
- | template | `string` | - string - the template string that we want to parse | &nbsp; |
3607
+ | config | | any config | &nbsp; |
3672
3608
 
3673
3609
 
3674
3610
 
@@ -3676,14 +3612,17 @@ then filters out any falsy values, then reverses the array
3676
3612
  ##### Returns
3677
3613
 
3678
3614
 
3679
- - An array of objects that have the order and the name of the part of the duration.
3615
+ - a Available Scope IDS config
3680
3616
 
3681
3617
 
3682
3618
 
3683
- #### format(number)
3684
3619
 
3685
- It takes a number, multiplies it by a factor, then uses the parts array to calculate the number
3686
- of each part in the number, then uses the template to format the number
3620
+ ### dist/filters/helpers/getScopesByHierarchy.js
3621
+
3622
+
3623
+ #### getScopesByHierarchy(scopes, currentScope)
3624
+
3625
+ [TODO: Make a description for this]
3687
3626
 
3688
3627
 
3689
3628
 
@@ -3692,7 +3631,8 @@ of each part in the number, then uses the template to format the number
3692
3631
 
3693
3632
  | Name | Type | Description | |
3694
3633
  | ---- | ---- | ----------- | -------- |
3695
- | number | `number` | - The number of milliseconds to format. | &nbsp; |
3634
+ | scopes | | the collection of Scopes/Scope IDs | &nbsp; |
3635
+ | currentScope | | Current scope type | &nbsp; |
3696
3636
 
3697
3637
 
3698
3638
 
@@ -3700,13 +3640,17 @@ of each part in the number, then uses the template to format the number
3700
3640
  ##### Returns
3701
3641
 
3702
3642
 
3703
- - The template string with the values replaced.
3643
+ - A new array of Scopes/Scope IDs
3704
3644
 
3705
3645
 
3706
3646
 
3707
- #### formatValue(parts, part)
3708
3647
 
3709
- It takes a dictionary of values and a list of keys, and returns a formatted string
3648
+ ### dist/filters/helpers/getTokensFromFilters.js
3649
+
3650
+
3651
+ #### getTokensFromFilters(filters, options)
3652
+
3653
+ It takes a filter object and returns an array of tokens that represent the filter
3710
3654
 
3711
3655
 
3712
3656
 
@@ -3715,8 +3659,8 @@ It takes a dictionary of values and a list of keys, and returns a formatted stri
3715
3659
 
3716
3660
  | Name | Type | Description | |
3717
3661
  | ---- | ---- | ----------- | -------- |
3718
- | parts | | - { [x: string]: any; } | &nbsp; |
3719
- | part | `string` `Array.<string|number>` | - This is the part of the date that we're formatting. | &nbsp; |
3662
+ | filters | `IFUData` | - The filters object. | &nbsp; |
3663
+ | options | `IFTokensFromFiltersSettings` | - IFTokensFromFiltersSettings | &nbsp; |
3720
3664
 
3721
3665
 
3722
3666
 
@@ -3724,7 +3668,55 @@ It takes a dictionary of values and a list of keys, and returns a formatted stri
3724
3668
  ##### Returns
3725
3669
 
3726
3670
 
3727
- - The value of the part of the date that is being formatted.
3671
+ - `Array.&lt;IFFilterTokens&gt;` An array of tokens that represents the filters object
3672
+
3673
+
3674
+
3675
+
3676
+ ### dist/filters/helpers/getVerboseFilter.js
3677
+
3678
+
3679
+ #### getVerboseFilter(filters, options)
3680
+
3681
+ It takes a set of filters and returns a string that describes the filters
3682
+
3683
+
3684
+
3685
+
3686
+ ##### Parameters
3687
+
3688
+ | Name | Type | Description | |
3689
+ | ---- | ---- | ----------- | -------- |
3690
+ | filters | `IFUData` | - The filters object that you want to convert to a string. | &nbsp; |
3691
+ | options | `IFTokensFromFiltersSettings` | - IFTokensFromFiltersSettings | &nbsp; |
3692
+
3693
+
3694
+
3695
+
3696
+ ##### Returns
3697
+
3698
+
3699
+ - A string
3700
+
3701
+
3702
+
3703
+
3704
+ ### dist/globalization/service/i18nextBuilder.js
3705
+
3706
+
3707
+ #### new I18nService()
3708
+
3709
+ This class allows to use the translation service of the i18next library
3710
+
3711
+
3712
+
3713
+
3714
+
3715
+
3716
+ ##### Returns
3717
+
3718
+
3719
+ - `Void`
3728
3720
 
3729
3721
 
3730
3722
 
@@ -3971,62 +3963,6 @@ Remove duplicated items from a given array by property name
3971
3963
 
3972
3964
 
3973
3965
 
3974
- ### dist/general/function/debounce.js
3975
-
3976
-
3977
- #### debounce(fn, time)
3978
-
3979
- Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last time the debounced function was invoked.
3980
-
3981
-
3982
-
3983
-
3984
- ##### Parameters
3985
-
3986
- | Name | Type | Description | |
3987
- | ---- | ---- | ----------- | -------- |
3988
- | fn | `Function` | original Function | &nbsp; |
3989
- | time | `Number` | default 500ms | &nbsp; |
3990
-
3991
-
3992
-
3993
-
3994
- ##### Returns
3995
-
3996
-
3997
- - `Function` debounced functions
3998
-
3999
-
4000
-
4001
-
4002
- ### dist/general/function/throttled.js
4003
-
4004
-
4005
- #### throttled(fn, time)
4006
-
4007
- Make sure to only invokes _fn_ at most once per every _time_ milliseconds
4008
-
4009
-
4010
-
4011
-
4012
- ##### Parameters
4013
-
4014
- | Name | Type | Description | |
4015
- | ---- | ---- | ----------- | -------- |
4016
- | fn | `Function` | original Function | &nbsp; |
4017
- | time | `Number` | default 500ms | &nbsp; |
4018
-
4019
-
4020
-
4021
-
4022
- ##### Returns
4023
-
4024
-
4025
- - `Function` throttled function
4026
-
4027
-
4028
-
4029
-
4030
3966
  ### dist/general/mix/compareDeep.js
4031
3967
 
4032
3968
 
@@ -4784,14 +4720,22 @@ Upper case the first letter of a given text
4784
4720
 
4785
4721
 
4786
4722
 
4787
- ### dist/globalization/service/i18nextBuilder.js
4723
+ ### dist/general/function/debounce.js
4788
4724
 
4789
4725
 
4790
- #### new I18nService()
4726
+ #### debounce(fn, time)
4727
+
4728
+ Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last time the debounced function was invoked.
4729
+
4791
4730
 
4792
- This class allows to use the translation service of the i18next library
4793
4731
 
4794
4732
 
4733
+ ##### Parameters
4734
+
4735
+ | Name | Type | Description | |
4736
+ | ---- | ---- | ----------- | -------- |
4737
+ | fn | `Function` | original Function | &nbsp; |
4738
+ | time | `Number` | default 500ms | &nbsp; |
4795
4739
 
4796
4740
 
4797
4741
 
@@ -4799,18 +4743,17 @@ This class allows to use the translation service of the i18next library
4799
4743
  ##### Returns
4800
4744
 
4801
4745
 
4802
- - `Void`
4746
+ - `Function` debounced functions
4803
4747
 
4804
4748
 
4805
4749
 
4806
4750
 
4807
- ### dist/qrvey/helpers/areStaticColumnValues.js
4751
+ ### dist/general/function/throttled.js
4808
4752
 
4809
4753
 
4810
- #### areStaticColumnValues(column)
4754
+ #### throttled(fn, time)
4811
4755
 
4812
- Determines if the given column is belonging to static values questions.
4813
- Static values questions are questions that do not need request an info from backend, instead the info is got from Model, Question/List object.
4756
+ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
4814
4757
 
4815
4758
 
4816
4759
 
@@ -4819,7 +4762,8 @@ Static values questions are questions that do not need request an info from back
4819
4762
 
4820
4763
  | Name | Type | Description | |
4821
4764
  | ---- | ---- | ----------- | -------- |
4822
- | column | | The question column | &nbsp; |
4765
+ | fn | `Function` | original Function | &nbsp; |
4766
+ | time | `Number` | default 500ms | &nbsp; |
4823
4767
 
4824
4768
 
4825
4769
 
@@ -4827,61 +4771,52 @@ Static values questions are questions that do not need request an info from back
4827
4771
  ##### Returns
4828
4772
 
4829
4773
 
4830
- - true if the column belongs to a static values question; otherwise, false
4831
-
4832
-
4774
+ - `Function` throttled function
4833
4775
 
4834
4776
 
4835
- ### dist/qrvey/helpers/getCategorizableExpression.js
4836
4777
 
4837
4778
 
4838
- #### getCategorizableExpression(column, dataset)
4779
+ ### dist/stencil/decorators/Config.js
4839
4780
 
4840
- Special function for Expression Columns.
4841
- This function allows validating if expression columns have active category option.
4842
- This is esential in order to display the asigned property for expression.
4843
4781
 
4782
+ #### Config()
4844
4783
 
4784
+ Stencil.js - Prop Decorator
4785
+ 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
4786
+ But for this, is required ask for a property in `snake_case` style
4845
4787
 
4846
4788
 
4847
- ##### Parameters
4848
4789
 
4849
- | Name | Type | Description | |
4850
- | ---- | ---- | ----------- | -------- |
4851
- | column | | The column with info | &nbsp; |
4852
- | dataset | | the dataset object to search the column | &nbsp; |
4853
4790
 
4854
4791
 
4855
4792
 
4793
+ ##### Examples
4856
4794
 
4857
- ##### Returns
4795
+ ```javascript
4796
+ \ @Config() @Prop() settings;
4858
4797
 
4798
+ someMethod() {
4799
+ this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
4800
+ }
4801
+ ```
4859
4802
 
4860
- - true if expression column is categorizable; otherwise not. If does not exist, undefined is sent.
4861
4803
 
4804
+ ##### Returns
4862
4805
 
4863
4806
 
4807
+ - `Void`
4864
4808
 
4865
- ### dist/qrvey/helpers/getDataAnswersByColumn.js
4866
4809
 
4867
4810
 
4868
- #### getDataAnswersByColumn(column, model, property)
4869
4811
 
4870
- Get answers located in model object. If column exists in the model, answers will be gotten depending on column type.
4871
- For Rating columns, needs a number sequence (From 1 to 5).
4872
- For Expression columns, needs a property type attribute for categorizable ones; for non-categorizable expressions is not required this attribute.
4873
- For the others columns, answers is located in the property of the same name.
4812
+ ### dist/stencil/util/createRef.js
4874
4813
 
4875
4814
 
4815
+ #### createRef()
4876
4816
 
4817
+ lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
4877
4818
 
4878
- ##### Parameters
4879
4819
 
4880
- | Name | Type | Description | |
4881
- | ---- | ---- | ----------- | -------- |
4882
- | column | | Info of the column | &nbsp; |
4883
- | model | | The model object | &nbsp; |
4884
- | property | | Optional Attribute, especially for expression columns. | &nbsp; |
4885
4820
 
4886
4821
 
4887
4822
 
@@ -4889,17 +4824,21 @@ For the others columns, answers is located in the property of the same name.
4889
4824
  ##### Returns
4890
4825
 
4891
4826
 
4892
- - Formatted answers inside of answer property.
4827
+ - function - Function to use in ref prop in html elements
4893
4828
 
4894
4829
 
4895
4830
 
4896
4831
 
4897
- ### dist/qrvey/helpers/getDatasetByColumn.js
4832
+ ### dist/stencil/util/getConfig.js
4898
4833
 
4899
4834
 
4900
- #### getDatasetByColumn(column, datasets)
4835
+ #### getConfig(cfg)
4901
4836
 
4902
- Gets a dataset by a given partial column
4837
+ verify the Config object type and try to return a parsed Object
4838
+ - In case _cfg_ is a string, first try to make a JSON parse in other case
4839
+ try to find this string as a variable on Windows object
4840
+ - If _cfg_ is a fuction, tis is invoked and parsed
4841
+ - Finally, if is an object, _cfg_ is inmediatly returned
4903
4842
 
4904
4843
 
4905
4844
 
@@ -4908,8 +4847,7 @@ Gets a dataset by a given partial column
4908
4847
 
4909
4848
  | Name | Type | Description | |
4910
4849
  | ---- | ---- | ----------- | -------- |
4911
- | column | | the partial column | &nbsp; |
4912
- | datasets | | the collection of dataset to look for one. | &nbsp; |
4850
+ | cfg | | | &nbsp; |
4913
4851
 
4914
4852
 
4915
4853
 
@@ -4917,18 +4855,21 @@ Gets a dataset by a given partial column
4917
4855
  ##### Returns
4918
4856
 
4919
4857
 
4920
- - the found dataset or undefined
4858
+ - `Void`
4921
4859
 
4922
4860
 
4923
4861
 
4924
4862
 
4925
- ### dist/qrvey/helpers/getDropdownAnswers.js
4863
+ ### dist/services/api/getAllDatasets.api.js
4926
4864
 
4927
4865
 
4928
- #### getDropdownAnswers(question)
4866
+ #### getAllDatasets(config, qrveyids)
4929
4867
 
4930
- Get the answers of dropdown columns.
4931
- Answers is a direct array of strings so it is necessary to format them.
4868
+ Get a dataset list from a collection of Qrvey IDs
4869
+ Considerations for qrveyids second argument:
4870
+ - If it is a undefined argument, the function will return all available datasets of the app
4871
+ - If it is a empty array argument, the function will return an empty dataset list. (A request will not be executed)
4872
+ - If it is a non-empty array argument, the function will return a set of available datasets
4932
4873
 
4933
4874
 
4934
4875
 
@@ -4937,7 +4878,8 @@ Answers is a direct array of strings so it is necessary to format them.
4937
4878
 
4938
4879
  | Name | Type | Description | |
4939
4880
  | ---- | ---- | ----------- | -------- |
4940
- | question | | The column located inside the model object. | &nbsp; |
4881
+ | config | | the widget config. Includes general configuration properties | &nbsp; |
4882
+ | qrveyids | | Collection of Qrvey IDs for returning a set of available datasets | &nbsp; |
4941
4883
 
4942
4884
 
4943
4885
 
@@ -4945,17 +4887,17 @@ Answers is a direct array of strings so it is necessary to format them.
4945
4887
  ##### Returns
4946
4888
 
4947
4889
 
4948
- - Formatted answers inside of an answer property.
4890
+ - a promise that if it is resolved displays a collection of dataset info.
4949
4891
 
4950
4892
 
4951
4893
 
4952
4894
 
4953
- ### dist/qrvey/helpers/getExpressionAnswers.js
4895
+ ### dist/services/api/getAllQrveys.api.js
4954
4896
 
4955
4897
 
4956
- #### getExpressionAnswers(column, property)
4898
+ #### getAllQrveys(config, params)
4957
4899
 
4958
- Get the answers of expression columns. Depends of the property attribute and if the column is categorizable.
4900
+ Request function for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
4959
4901
 
4960
4902
 
4961
4903
 
@@ -4964,8 +4906,8 @@ Get the answers of expression columns. Depends of the property attribute and if
4964
4906
 
4965
4907
  | Name | Type | Description | |
4966
4908
  | ---- | ---- | ----------- | -------- |
4967
- | column | | The column located inside the model object. | &nbsp; |
4968
- | property | | Optional Attribute, especially for expression columns. | &nbsp; |
4909
+ | config | | Configuration | &nbsp; |
4910
+ | params | | Object for getting precise data | &nbsp; |
4969
4911
 
4970
4912
 
4971
4913
 
@@ -4973,17 +4915,17 @@ Get the answers of expression columns. Depends of the property attribute and if
4973
4915
  ##### Returns
4974
4916
 
4975
4917
 
4976
- - Formatted answers inside of an answer property.
4918
+ - `Void`
4977
4919
 
4978
4920
 
4979
4921
 
4980
4922
 
4981
- ### dist/qrvey/helpers/getImageAnswers.js
4923
+ ### dist/services/api/getDatasetColumns.api.js
4982
4924
 
4983
4925
 
4984
- #### getImageAnswers(column)
4926
+ #### getDatasetColumns(qrveyid)
4985
4927
 
4986
- Get the answers of image columns.
4928
+ Get a dataset by Qrvey ID
4987
4929
 
4988
4930
 
4989
4931
 
@@ -4992,7 +4934,7 @@ Get the answers of image columns.
4992
4934
 
4993
4935
  | Name | Type | Description | |
4994
4936
  | ---- | ---- | ----------- | -------- |
4995
- | column | | The column located inside the model object. | &nbsp; |
4937
+ | qrveyid | | The Qrvey ID | &nbsp; |
4996
4938
 
4997
4939
 
4998
4940
 
@@ -5000,18 +4942,17 @@ Get the answers of image columns.
5000
4942
  ##### Returns
5001
4943
 
5002
4944
 
5003
- - Formatted answers inside of an answer property.
4945
+ - a promise
5004
4946
 
5005
4947
 
5006
4948
 
5007
4949
 
5008
- ### dist/qrvey/helpers/getImageUploadHasAnalysis.js
4950
+ ### dist/services/api/getDatasetsByIds.api.js
5009
4951
 
5010
4952
 
5011
- #### getImageUploadHasAnalysis(column, model)
4953
+ #### getDatasetsByIds(qrveyid)
5012
4954
 
5013
- Special function for Image Upload
5014
- This function returns if the current column has object or text analysis as property.
4955
+ Get a dataset by Qrvey ID
5015
4956
 
5016
4957
 
5017
4958
 
@@ -5020,8 +4961,7 @@ This function returns if the current column has object or text analysis as prope
5020
4961
 
5021
4962
  | Name | Type | Description | |
5022
4963
  | ---- | ---- | ----------- | -------- |
5023
- | column | | The column with info | &nbsp; |
5024
- | model | | The model object | &nbsp; |
4964
+ | qrveyid | | The Qrvey ID | &nbsp; |
5025
4965
 
5026
4966
 
5027
4967
 
@@ -5029,17 +4969,18 @@ This function returns if the current column has object or text analysis as prope
5029
4969
  ##### Returns
5030
4970
 
5031
4971
 
5032
- - true if this column has analysis. Otherwise false.
4972
+ - a promise
5033
4973
 
5034
4974
 
5035
4975
 
5036
4976
 
5037
- ### dist/qrvey/helpers/getRatingAnswers.js
4977
+ ### dist/qrvey/helpers/areStaticColumnValues.js
5038
4978
 
5039
4979
 
5040
- #### getRatingAnswers(_question)
4980
+ #### areStaticColumnValues(column)
5041
4981
 
5042
- Get the answers of rating columns.
4982
+ Determines if the given column is belonging to static values questions.
4983
+ Static values questions are questions that do not need request an info from backend, instead the info is got from Model, Question/List object.
5043
4984
 
5044
4985
 
5045
4986
 
@@ -5048,7 +4989,7 @@ Get the answers of rating columns.
5048
4989
 
5049
4990
  | Name | Type | Description | |
5050
4991
  | ---- | ---- | ----------- | -------- |
5051
- | _question | | The column located inside the model object. | &nbsp; |
4992
+ | column | | The question column | &nbsp; |
5052
4993
 
5053
4994
 
5054
4995
 
@@ -5056,17 +4997,19 @@ Get the answers of rating columns.
5056
4997
  ##### Returns
5057
4998
 
5058
4999
 
5059
- - Formatted answers inside of an answer property
5000
+ - true if the column belongs to a static values question; otherwise, false
5060
5001
 
5061
5002
 
5062
5003
 
5063
5004
 
5064
- ### dist/qrvey/helpers/getSlidebarAnswers.js
5005
+ ### dist/qrvey/helpers/getCategorizableExpression.js
5065
5006
 
5066
5007
 
5067
- #### getSlidebarAnswers(_question)
5008
+ #### getCategorizableExpression(column, dataset)
5068
5009
 
5069
- Get the answers of slidebar columns. The quantity of answers depend on the steps chosen in maker.
5010
+ Special function for Expression Columns.
5011
+ This function allows validating if expression columns have active category option.
5012
+ This is esential in order to display the asigned property for expression.
5070
5013
 
5071
5014
 
5072
5015
 
@@ -5075,7 +5018,8 @@ Get the answers of slidebar columns. The quantity of answers depend on the steps
5075
5018
 
5076
5019
  | Name | Type | Description | |
5077
5020
  | ---- | ---- | ----------- | -------- |
5078
- | _question | | The column located inside the model object. | &nbsp; |
5021
+ | column | | The column with info | &nbsp; |
5022
+ | dataset | | the dataset object to search the column | &nbsp; |
5079
5023
 
5080
5024
 
5081
5025
 
@@ -5083,17 +5027,20 @@ Get the answers of slidebar columns. The quantity of answers depend on the steps
5083
5027
  ##### Returns
5084
5028
 
5085
5029
 
5086
- - Formatted answers inside of an answer property
5030
+ - true if expression column is categorizable; otherwise not. If does not exist, undefined is sent.
5087
5031
 
5088
5032
 
5089
5033
 
5090
5034
 
5091
- ### dist/qrvey/helpers/getSuffixTranslateByColumn.js
5035
+ ### dist/qrvey/helpers/getDataAnswersByColumn.js
5092
5036
 
5093
5037
 
5094
- #### getSuffixTranslateByColumn(column)
5038
+ #### getDataAnswersByColumn(column, model, property)
5095
5039
 
5096
- Gets a string of the translate structure by the given column
5040
+ Get answers located in model object. If column exists in the model, answers will be gotten depending on column type.
5041
+ For Rating columns, needs a number sequence (From 1 to 5).
5042
+ For Expression columns, needs a property type attribute for categorizable ones; for non-categorizable expressions is not required this attribute.
5043
+ For the others columns, answers is located in the property of the same name.
5097
5044
 
5098
5045
 
5099
5046
 
@@ -5102,7 +5049,9 @@ Gets a string of the translate structure by the given column
5102
5049
 
5103
5050
  | Name | Type | Description | |
5104
5051
  | ---- | ---- | ----------- | -------- |
5105
- | column | | the Info of the column | &nbsp; |
5052
+ | column | | Info of the column | &nbsp; |
5053
+ | model | | The model object | &nbsp; |
5054
+ | property | | Optional Attribute, especially for expression columns. | &nbsp; |
5106
5055
 
5107
5056
 
5108
5057
 
@@ -5110,18 +5059,17 @@ Gets a string of the translate structure by the given column
5110
5059
  ##### Returns
5111
5060
 
5112
5061
 
5113
- - a string of the translation structure where the label is located.
5062
+ - Formatted answers inside of answer property.
5114
5063
 
5115
5064
 
5116
5065
 
5117
5066
 
5118
- ### dist/qrvey/helpers/getValueWithSuffixes.js
5067
+ ### dist/qrvey/helpers/getDatasetByColumn.js
5119
5068
 
5120
5069
 
5121
- #### getValueWithSuffixes(value, suffixes)
5070
+ #### getDatasetByColumn(column, datasets)
5122
5071
 
5123
- Get a string value with suffixes if available.
5124
- Add suffix into the value string. Prioritized for numeric values.
5072
+ Gets a dataset by a given partial column
5125
5073
 
5126
5074
 
5127
5075
 
@@ -5130,8 +5078,8 @@ Add suffix into the value string. Prioritized for numeric values.
5130
5078
 
5131
5079
  | Name | Type | Description | |
5132
5080
  | ---- | ---- | ----------- | -------- |
5133
- | value | | a number or string | &nbsp; |
5134
- | suffixes | | An object with singular or plural suffix string. | &nbsp; |
5081
+ | column | | the partial column | &nbsp; |
5082
+ | datasets | | the collection of dataset to look for one. | &nbsp; |
5135
5083
 
5136
5084
 
5137
5085
 
@@ -5139,18 +5087,18 @@ Add suffix into the value string. Prioritized for numeric values.
5139
5087
  ##### Returns
5140
5088
 
5141
5089
 
5142
- - a string value with suffix
5090
+ - the found dataset or undefined
5143
5091
 
5144
5092
 
5145
5093
 
5146
5094
 
5147
- ### dist/qrvey/helpers/getYesNoAnswers.js
5095
+ ### dist/qrvey/helpers/getDropdownAnswers.js
5148
5096
 
5149
5097
 
5150
- #### getYesNoAnswers(column)
5098
+ #### getDropdownAnswers(question)
5151
5099
 
5152
- Get the answers of Yes/No columns.
5153
- Yes/No answers from model object are capitalized but the filters need values in lowercase.
5100
+ Get the answers of dropdown columns.
5101
+ Answers is a direct array of strings so it is necessary to format them.
5154
5102
 
5155
5103
 
5156
5104
 
@@ -5159,7 +5107,7 @@ Yes/No answers from model object are capitalized but the filters need values in
5159
5107
 
5160
5108
  | Name | Type | Description | |
5161
5109
  | ---- | ---- | ----------- | -------- |
5162
- | column | | The column located inside the model object. | &nbsp; |
5110
+ | question | | The column located inside the model object. | &nbsp; |
5163
5111
 
5164
5112
 
5165
5113
 
@@ -5167,17 +5115,17 @@ Yes/No answers from model object are capitalized but the filters need values in
5167
5115
  ##### Returns
5168
5116
 
5169
5117
 
5170
- - Formatted answers inside of an answer property
5118
+ - Formatted answers inside of an answer property.
5171
5119
 
5172
5120
 
5173
5121
 
5174
5122
 
5175
- ### dist/qrvey/helpers/transformValue.js
5123
+ ### dist/qrvey/helpers/getExpressionAnswers.js
5176
5124
 
5177
5125
 
5178
- #### transformValue(value, settings)
5126
+ #### getExpressionAnswers(column, property)
5179
5127
 
5180
- Transforms a value depending of localization/globalization and extras settings.
5128
+ Get the answers of expression columns. Depends of the property attribute and if the column is categorizable.
5181
5129
 
5182
5130
 
5183
5131
 
@@ -5186,8 +5134,8 @@ Transforms a value depending of localization/globalization and extras settings.
5186
5134
 
5187
5135
  | Name | Type | Description | |
5188
5136
  | ---- | ---- | ----------- | -------- |
5189
- | value | | A value to transform | &nbsp; |
5190
- | settings | | The settings of the transformValue function | &nbsp; |
5137
+ | column | | The column located inside the model object. | &nbsp; |
5138
+ | property | | Optional Attribute, especially for expression columns. | &nbsp; |
5191
5139
 
5192
5140
 
5193
5141
 
@@ -5195,13 +5143,17 @@ Transforms a value depending of localization/globalization and extras settings.
5195
5143
  ##### Returns
5196
5144
 
5197
5145
 
5198
- - A transformed value
5146
+ - Formatted answers inside of an answer property.
5199
5147
 
5200
5148
 
5201
5149
 
5202
- #### getOutputFormat(settings)
5203
5150
 
5204
- Gets the outputformat settings
5151
+ ### dist/qrvey/helpers/getImageAnswers.js
5152
+
5153
+
5154
+ #### getImageAnswers(column)
5155
+
5156
+ Get the answers of image columns.
5205
5157
 
5206
5158
 
5207
5159
 
@@ -5210,7 +5162,7 @@ Gets the outputformat settings
5210
5162
 
5211
5163
  | Name | Type | Description | |
5212
5164
  | ---- | ---- | ----------- | -------- |
5213
- | settings | | The settings of the transformValue function | &nbsp; |
5165
+ | column | | The column located inside the model object. | &nbsp; |
5214
5166
 
5215
5167
 
5216
5168
 
@@ -5218,13 +5170,18 @@ Gets the outputformat settings
5218
5170
  ##### Returns
5219
5171
 
5220
5172
 
5221
- - the outputformat settings
5173
+ - Formatted answers inside of an answer property.
5222
5174
 
5223
5175
 
5224
5176
 
5225
- #### getFormatConfig(settings)
5226
5177
 
5227
- Gets the format config
5178
+ ### dist/qrvey/helpers/getImageUploadHasAnalysis.js
5179
+
5180
+
5181
+ #### getImageUploadHasAnalysis(column, model)
5182
+
5183
+ Special function for Image Upload
5184
+ This function returns if the current column has object or text analysis as property.
5228
5185
 
5229
5186
 
5230
5187
 
@@ -5233,7 +5190,8 @@ Gets the format config
5233
5190
 
5234
5191
  | Name | Type | Description | |
5235
5192
  | ---- | ---- | ----------- | -------- |
5236
- | settings | | The settings of the transformValue function | &nbsp; |
5193
+ | column | | The column with info | &nbsp; |
5194
+ | model | | The model object | &nbsp; |
5237
5195
 
5238
5196
 
5239
5197
 
@@ -5241,74 +5199,71 @@ Gets the format config
5241
5199
  ##### Returns
5242
5200
 
5243
5201
 
5244
- - the format config
5245
-
5202
+ - true if this column has analysis. Otherwise false.
5246
5203
 
5247
5204
 
5248
5205
 
5249
- ### dist/stencil/decorators/Config.js
5250
5206
 
5207
+ ### dist/qrvey/helpers/getRatingAnswers.js
5251
5208
 
5252
- #### Config()
5253
5209
 
5254
- Stencil.js - Prop Decorator
5255
- 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
5256
- But for this, is required ask for a property in `snake_case` style
5210
+ #### getRatingAnswers(_question)
5257
5211
 
5212
+ Get the answers of rating columns.
5258
5213
 
5259
5214
 
5260
5215
 
5261
5216
 
5217
+ ##### Parameters
5262
5218
 
5263
- ##### Examples
5219
+ | Name | Type | Description | |
5220
+ | ---- | ---- | ----------- | -------- |
5221
+ | _question | | The column located inside the model object. | &nbsp; |
5264
5222
 
5265
- ```javascript
5266
- \ @Config() @Prop() settings;
5267
5223
 
5268
- someMethod() {
5269
- this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
5270
- }
5271
- ```
5272
5224
 
5273
5225
 
5274
5226
  ##### Returns
5275
5227
 
5276
5228
 
5277
- - `Void`
5229
+ - Formatted answers inside of an answer property
5278
5230
 
5279
5231
 
5280
5232
 
5281
5233
 
5282
- ### dist/stencil/util/createRef.js
5234
+ ### dist/qrvey/helpers/getSlidebarAnswers.js
5283
5235
 
5284
5236
 
5285
- #### createRef()
5237
+ #### getSlidebarAnswers(_question)
5286
5238
 
5287
- lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
5239
+ Get the answers of slidebar columns. The quantity of answers depend on the steps chosen in maker.
5288
5240
 
5289
5241
 
5290
5242
 
5291
5243
 
5244
+ ##### Parameters
5245
+
5246
+ | Name | Type | Description | |
5247
+ | ---- | ---- | ----------- | -------- |
5248
+ | _question | | The column located inside the model object. | &nbsp; |
5249
+
5250
+
5292
5251
 
5293
5252
 
5294
5253
  ##### Returns
5295
5254
 
5296
5255
 
5297
- - function - Function to use in ref prop in html elements
5256
+ - Formatted answers inside of an answer property
5298
5257
 
5299
5258
 
5300
5259
 
5301
5260
 
5302
- ### dist/stencil/util/getConfig.js
5261
+ ### dist/qrvey/helpers/getSuffixTranslateByColumn.js
5303
5262
 
5304
5263
 
5305
- #### getConfig(cfg)
5264
+ #### getSuffixTranslateByColumn(column)
5306
5265
 
5307
- verify the Config object type and try to return a parsed Object
5308
- - In case _cfg_ is a string, first try to make a JSON parse in other case
5309
- try to find this string as a variable on Windows object
5310
- - If _cfg_ is a fuction, tis is invoked and parsed
5311
- - Finally, if is an object, _cfg_ is inmediatly returned
5266
+ Gets a string of the translate structure by the given column
5312
5267
 
5313
5268
 
5314
5269
 
@@ -5317,7 +5272,7 @@ try to find this string as a variable on Windows object
5317
5272
 
5318
5273
  | Name | Type | Description | |
5319
5274
  | ---- | ---- | ----------- | -------- |
5320
- | cfg | | | &nbsp; |
5275
+ | column | | the Info of the column | &nbsp; |
5321
5276
 
5322
5277
 
5323
5278
 
@@ -5325,17 +5280,18 @@ try to find this string as a variable on Windows object
5325
5280
  ##### Returns
5326
5281
 
5327
5282
 
5328
- - `Void`
5283
+ - a string of the translation structure where the label is located.
5329
5284
 
5330
5285
 
5331
5286
 
5332
5287
 
5333
- ### dist/services/adapters/BBranchesMapToUIBranchesMap.adapter.js
5288
+ ### dist/qrvey/helpers/getValueWithSuffixes.js
5334
5289
 
5335
5290
 
5336
- #### BBranchesMapToUIBranchesMap(branchesMap)
5291
+ #### getValueWithSuffixes(value, suffixes)
5337
5292
 
5338
- Adapts the branches map from backend to the UI branches map
5293
+ Get a string value with suffixes if available.
5294
+ Add suffix into the value string. Prioritized for numeric values.
5339
5295
 
5340
5296
 
5341
5297
 
@@ -5344,7 +5300,8 @@ Adapts the branches map from backend to the UI branches map
5344
5300
 
5345
5301
  | Name | Type | Description | |
5346
5302
  | ---- | ---- | ----------- | -------- |
5347
- | branchesMap | | the backend branches map | &nbsp; |
5303
+ | value | | a number or string | &nbsp; |
5304
+ | suffixes | | An object with singular or plural suffix string. | &nbsp; |
5348
5305
 
5349
5306
 
5350
5307
 
@@ -5352,21 +5309,18 @@ Adapts the branches map from backend to the UI branches map
5352
5309
  ##### Returns
5353
5310
 
5354
5311
 
5355
- - The Branches map array
5312
+ - a string value with suffix
5356
5313
 
5357
5314
 
5358
5315
 
5359
5316
 
5360
- ### dist/services/api/getAllDatasets.api.js
5317
+ ### dist/qrvey/helpers/getYesNoAnswers.js
5361
5318
 
5362
5319
 
5363
- #### getAllDatasets(config, qrveyids)
5320
+ #### getYesNoAnswers(column)
5364
5321
 
5365
- Get a dataset list from a collection of Qrvey IDs
5366
- Considerations for qrveyids second argument:
5367
- - If it is a undefined argument, the function will return all available datasets of the app
5368
- - If it is a empty array argument, the function will return an empty dataset list. (A request will not be executed)
5369
- - If it is a non-empty array argument, the function will return a set of available datasets
5322
+ Get the answers of Yes/No columns.
5323
+ Yes/No answers from model object are capitalized but the filters need values in lowercase.
5370
5324
 
5371
5325
 
5372
5326
 
@@ -5375,8 +5329,7 @@ Considerations for qrveyids second argument:
5375
5329
 
5376
5330
  | Name | Type | Description | |
5377
5331
  | ---- | ---- | ----------- | -------- |
5378
- | config | | the widget config. Includes general configuration properties | &nbsp; |
5379
- | qrveyids | | Collection of Qrvey IDs for returning a set of available datasets | &nbsp; |
5332
+ | column | | The column located inside the model object. | &nbsp; |
5380
5333
 
5381
5334
 
5382
5335
 
@@ -5384,17 +5337,17 @@ Considerations for qrveyids second argument:
5384
5337
  ##### Returns
5385
5338
 
5386
5339
 
5387
- - a promise that if it is resolved displays a collection of dataset info.
5340
+ - Formatted answers inside of an answer property
5388
5341
 
5389
5342
 
5390
5343
 
5391
5344
 
5392
- ### dist/services/api/getAllQrveys.api.js
5345
+ ### dist/qrvey/helpers/transformValue.js
5393
5346
 
5394
5347
 
5395
- #### getAllQrveys(config, params)
5348
+ #### transformValue(value, settings)
5396
5349
 
5397
- Request function for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
5350
+ Transforms a value depending of localization/globalization and extras settings.
5398
5351
 
5399
5352
 
5400
5353
 
@@ -5403,8 +5356,8 @@ Request function for getting Qrveys such as Web Forms and Datasets. Use params f
5403
5356
 
5404
5357
  | Name | Type | Description | |
5405
5358
  | ---- | ---- | ----------- | -------- |
5406
- | config | | Configuration | &nbsp; |
5407
- | params | | Object for getting precise data | &nbsp; |
5359
+ | value | | A value to transform | &nbsp; |
5360
+ | settings | | The settings of the transformValue function | &nbsp; |
5408
5361
 
5409
5362
 
5410
5363
 
@@ -5412,17 +5365,13 @@ Request function for getting Qrveys such as Web Forms and Datasets. Use params f
5412
5365
  ##### Returns
5413
5366
 
5414
5367
 
5415
- - `Void`
5416
-
5417
-
5418
-
5368
+ - A transformed value
5419
5369
 
5420
- ### dist/services/api/getDatasetColumns.api.js
5421
5370
 
5422
5371
 
5423
- #### getDatasetColumns(qrveyid)
5372
+ #### getOutputFormat(settings)
5424
5373
 
5425
- Get a dataset by Qrvey ID
5374
+ Gets the outputformat settings
5426
5375
 
5427
5376
 
5428
5377
 
@@ -5431,7 +5380,7 @@ Get a dataset by Qrvey ID
5431
5380
 
5432
5381
  | Name | Type | Description | |
5433
5382
  | ---- | ---- | ----------- | -------- |
5434
- | qrveyid | | The Qrvey ID | &nbsp; |
5383
+ | settings | | The settings of the transformValue function | &nbsp; |
5435
5384
 
5436
5385
 
5437
5386
 
@@ -5439,17 +5388,13 @@ Get a dataset by Qrvey ID
5439
5388
  ##### Returns
5440
5389
 
5441
5390
 
5442
- - a promise
5443
-
5444
-
5445
-
5391
+ - the outputformat settings
5446
5392
 
5447
- ### dist/services/api/getDatasetsByIds.api.js
5448
5393
 
5449
5394
 
5450
- #### getDatasetsByIds(qrveyid)
5395
+ #### getFormatConfig(settings)
5451
5396
 
5452
- Get a dataset by Qrvey ID
5397
+ Gets the format config
5453
5398
 
5454
5399
 
5455
5400
 
@@ -5458,7 +5403,7 @@ Get a dataset by Qrvey ID
5458
5403
 
5459
5404
  | Name | Type | Description | |
5460
5405
  | ---- | ---- | ----------- | -------- |
5461
- | qrveyid | | The Qrvey ID | &nbsp; |
5406
+ | settings | | The settings of the transformValue function | &nbsp; |
5462
5407
 
5463
5408
 
5464
5409
 
@@ -5466,17 +5411,44 @@ Get a dataset by Qrvey ID
5466
5411
  ##### Returns
5467
5412
 
5468
5413
 
5469
- - a promise
5414
+ - the format config
5470
5415
 
5471
5416
 
5472
5417
 
5473
5418
 
5474
- ### dist/typescript/decorators/Debounce.js
5419
+ ### dist/services/adapters/BBranchesMapToUIBranchesMap.adapter.js
5475
5420
 
5476
5421
 
5477
- #### Debounce(time)
5422
+ #### BBranchesMapToUIBranchesMap(branchesMap)
5423
+
5424
+ Adapts the branches map from backend to the UI branches map
5425
+
5426
+
5427
+
5428
+
5429
+ ##### Parameters
5430
+
5431
+ | Name | Type | Description | |
5432
+ | ---- | ---- | ----------- | -------- |
5433
+ | branchesMap | | the backend branches map | &nbsp; |
5434
+
5435
+
5436
+
5437
+
5438
+ ##### Returns
5478
5439
 
5479
- (Method Decorator) Debounce Class Method
5440
+
5441
+ - The Branches map array
5442
+
5443
+
5444
+
5445
+
5446
+ ### dist/typescript/decorators/Debounce.js
5447
+
5448
+
5449
+ #### Debounce(time)
5450
+
5451
+ (Method Decorator) Debounce Class Method
5480
5452
 
5481
5453
 
5482
5454
 
@@ -6376,21 +6348,12 @@ Module specially for CLS.
6376
6348
 
6377
6349
 
6378
6350
 
6379
- ### dist/filters/helpers/common/getFiltersByParams.js
6351
+ ### dist/filters/helpers/common/getFiltersByScopes.js
6380
6352
 
6381
6353
 
6382
- #### getFiltersByParams(filterData, params)
6354
+ #### getFiltersByScopes(filterData, scopes)
6383
6355
 
6384
- Gets filters from the given params.
6385
- The validation to filter the stored filter is depending on:
6386
- - Column
6387
- - Qrvey ID
6388
- - Scope type
6389
- - Scope ID
6390
- - Panel ID
6391
- - Validator type
6392
- - Property type
6393
- - Enabled flags
6356
+ Filters and gets a Filter Data by the given scopes
6394
6357
 
6395
6358
 
6396
6359
 
@@ -6399,8 +6362,8 @@ The validation to filter the stored filter is depending on:
6399
6362
 
6400
6363
  | Name | Type | Description | |
6401
6364
  | ---- | ---- | ----------- | -------- |
6402
- | filterData | | The Filter Data or the UI Filter Data | &nbsp; |
6403
- | params | | given parameters to validate the dataset | &nbsp; |
6365
+ | filterData | | The Filter Data | &nbsp; |
6366
+ | scopes | | collection of scopes types | &nbsp; |
6404
6367
 
6405
6368
 
6406
6369
 
@@ -6408,17 +6371,17 @@ The validation to filter the stored filter is depending on:
6408
6371
  ##### Returns
6409
6372
 
6410
6373
 
6411
- - a new Filter object structure
6374
+ - The new Filter Data
6412
6375
 
6413
6376
 
6414
6377
 
6415
6378
 
6416
- ### dist/filters/helpers/common/getFiltersByScopes.js
6379
+ ### dist/filters/helpers/common/getFiltersByScopesIds.js
6417
6380
 
6418
6381
 
6419
- #### getFiltersByScopes(filterData, scopes)
6382
+ #### getFiltersByScopesIds(filterData, scopes)
6420
6383
 
6421
- Filters and gets a Filter Data by the given scopes
6384
+ Gets filters from Filter Data by Scopes/Scope IDs.
6422
6385
 
6423
6386
 
6424
6387
 
@@ -6427,8 +6390,8 @@ Filters and gets a Filter Data by the given scopes
6427
6390
 
6428
6391
  | Name | Type | Description | |
6429
6392
  | ---- | ---- | ----------- | -------- |
6430
- | filterData | | The Filter Data | &nbsp; |
6431
- | scopes | | collection of scopes types | &nbsp; |
6393
+ | filterData | | The filter data | &nbsp; |
6394
+ | scopes | | The collection of Scopes/Scope IDs | &nbsp; |
6432
6395
 
6433
6396
 
6434
6397
 
@@ -6436,17 +6399,17 @@ Filters and gets a Filter Data by the given scopes
6436
6399
  ##### Returns
6437
6400
 
6438
6401
 
6439
- - The new Filter Data
6402
+ - a new Filter Data
6440
6403
 
6441
6404
 
6442
6405
 
6443
6406
 
6444
- ### dist/filters/helpers/common/getFiltersByScopesIds.js
6407
+ ### dist/filters/helpers/common/getFiltersByVisibility.js
6445
6408
 
6446
6409
 
6447
- #### getFiltersByScopesIds(filterData, scopes)
6410
+ #### getFiltersByVisibility(filterData, scopes)
6448
6411
 
6449
- Gets filters from Filter Data by Scopes/Scope IDs.
6412
+ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
6450
6413
 
6451
6414
 
6452
6415
 
@@ -6455,8 +6418,8 @@ Gets filters from Filter Data by Scopes/Scope IDs.
6455
6418
 
6456
6419
  | Name | Type | Description | |
6457
6420
  | ---- | ---- | ----------- | -------- |
6458
- | filterData | | The filter data | &nbsp; |
6459
- | scopes | | The collection of Scopes/Scope IDs | &nbsp; |
6421
+ | filterData | | a Filter Data or UI Filter Data | &nbsp; |
6422
+ | scopes | | a Scopes/Scope IDs array | &nbsp; |
6460
6423
 
6461
6424
 
6462
6425
 
@@ -6469,12 +6432,21 @@ Gets filters from Filter Data by Scopes/Scope IDs.
6469
6432
 
6470
6433
 
6471
6434
 
6472
- ### dist/filters/helpers/common/getFiltersByVisibility.js
6435
+ ### dist/filters/helpers/common/getFiltersByParams.js
6473
6436
 
6474
6437
 
6475
- #### getFiltersByVisibility(filterData, scopes)
6438
+ #### getFiltersByParams(filterData, params)
6476
6439
 
6477
- Get a new Filter Data by filtering scopes/scope IDs and enabled flags
6440
+ Gets filters from the given params.
6441
+ The validation to filter the stored filter is depending on:
6442
+ - Column
6443
+ - Qrvey ID
6444
+ - Scope type
6445
+ - Scope ID
6446
+ - Panel ID
6447
+ - Validator type
6448
+ - Property type
6449
+ - Enabled flags
6478
6450
 
6479
6451
 
6480
6452
 
@@ -6483,8 +6455,8 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
6483
6455
 
6484
6456
  | Name | Type | Description | |
6485
6457
  | ---- | ---- | ----------- | -------- |
6486
- | filterData | | a Filter Data or UI Filter Data | &nbsp; |
6487
- | scopes | | a Scopes/Scope IDs array | &nbsp; |
6458
+ | filterData | | The Filter Data or the UI Filter Data | &nbsp; |
6459
+ | params | | given parameters to validate the dataset | &nbsp; |
6488
6460
 
6489
6461
 
6490
6462
 
@@ -6492,7 +6464,7 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
6492
6464
  ##### Returns
6493
6465
 
6494
6466
 
6495
- - a new Filter Data
6467
+ - a new Filter object structure
6496
6468
 
6497
6469
 
6498
6470
 
@@ -6660,12 +6632,12 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
6660
6632
 
6661
6633
 
6662
6634
 
6663
- ### dist/filters/helpers/common/isBetweenValidator.js
6635
+ ### dist/filters/helpers/common/isDateDistinctProperty.js
6664
6636
 
6665
6637
 
6666
- #### isBetweenValidator(validator)
6638
+ #### isDateDistinctProperty(column, property)
6667
6639
 
6668
- Validates if the given validator is a Between type
6640
+ Determines if the filter column and property is a distinct group dates type
6669
6641
 
6670
6642
 
6671
6643
 
@@ -6674,7 +6646,8 @@ Validates if the given validator is a Between type
6674
6646
 
6675
6647
  | Name | Type | Description | |
6676
6648
  | ---- | ---- | ----------- | -------- |
6677
- | validator | | The validator | &nbsp; |
6649
+ | column | | The filter column | &nbsp; |
6650
+ | property | | The filter property | &nbsp; |
6678
6651
 
6679
6652
 
6680
6653
 
@@ -6682,17 +6655,17 @@ Validates if the given validator is a Between type
6682
6655
  ##### Returns
6683
6656
 
6684
6657
 
6685
- - true: it is a between validator; false: it is not a between validator
6658
+ - True if the given property is included from distinct group dates type
6686
6659
 
6687
6660
 
6688
6661
 
6689
6662
 
6690
- ### dist/filters/helpers/common/isDateDistinctProperty.js
6663
+ ### dist/filters/helpers/common/isBetweenValidator.js
6691
6664
 
6692
6665
 
6693
- #### isDateDistinctProperty(column, property)
6666
+ #### isBetweenValidator(validator)
6694
6667
 
6695
- Determines if the filter column and property is a distinct group dates type
6668
+ Validates if the given validator is a Between type
6696
6669
 
6697
6670
 
6698
6671
 
@@ -6701,8 +6674,7 @@ Determines if the filter column and property is a distinct group dates type
6701
6674
 
6702
6675
  | Name | Type | Description | |
6703
6676
  | ---- | ---- | ----------- | -------- |
6704
- | column | | The filter column | &nbsp; |
6705
- | property | | The filter property | &nbsp; |
6677
+ | validator | | The validator | &nbsp; |
6706
6678
 
6707
6679
 
6708
6680
 
@@ -6710,17 +6682,17 @@ Determines if the filter column and property is a distinct group dates type
6710
6682
  ##### Returns
6711
6683
 
6712
6684
 
6713
- - True if the given property is included from distinct group dates type
6685
+ - true: it is a between validator; false: it is not a between validator
6714
6686
 
6715
6687
 
6716
6688
 
6717
6689
 
6718
- ### dist/filters/helpers/common/isInValidator.js
6690
+ ### dist/filters/helpers/common/isNullValidator.js
6719
6691
 
6720
6692
 
6721
- #### isInValidator(validator)
6693
+ #### isNullValidator(validator)
6722
6694
 
6723
- Validates if the given validator is a In type
6695
+ Checks if the given validator is a Null type.
6724
6696
 
6725
6697
 
6726
6698
 
@@ -6729,7 +6701,7 @@ Validates if the given validator is a In type
6729
6701
 
6730
6702
  | Name | Type | Description | |
6731
6703
  | ---- | ---- | ----------- | -------- |
6732
- | validator | | The validator | &nbsp; |
6704
+ | validator | | The Filter Validator | &nbsp; |
6733
6705
 
6734
6706
 
6735
6707
 
@@ -6737,17 +6709,17 @@ Validates if the given validator is a In type
6737
6709
  ##### Returns
6738
6710
 
6739
6711
 
6740
- - true: it is a In validator; false: it is not a In validator
6712
+ - True: It is a Null Validator; False: It is not a Null Validator.
6741
6713
 
6742
6714
 
6743
6715
 
6744
6716
 
6745
- ### dist/filters/helpers/common/isNullValidator.js
6717
+ ### dist/filters/helpers/common/isInValidator.js
6746
6718
 
6747
6719
 
6748
- #### isNullValidator(validator)
6720
+ #### isInValidator(validator)
6749
6721
 
6750
- Checks if the given validator is a Null type.
6722
+ Validates if the given validator is a In type
6751
6723
 
6752
6724
 
6753
6725
 
@@ -6756,7 +6728,7 @@ Checks if the given validator is a Null type.
6756
6728
 
6757
6729
  | Name | Type | Description | |
6758
6730
  | ---- | ---- | ----------- | -------- |
6759
- | validator | | The Filter Validator | &nbsp; |
6731
+ | validator | | The validator | &nbsp; |
6760
6732
 
6761
6733
 
6762
6734
 
@@ -6764,17 +6736,18 @@ Checks if the given validator is a Null type.
6764
6736
  ##### Returns
6765
6737
 
6766
6738
 
6767
- - True: It is a Null Validator; False: It is not a Null Validator.
6739
+ - true: it is a In validator; false: it is not a In validator
6768
6740
 
6769
6741
 
6770
6742
 
6771
6743
 
6772
- ### dist/filters/helpers/common/isRangeValidator.js
6744
+ ### dist/filters/helpers/common/isRankingFilter.js
6773
6745
 
6774
6746
 
6775
- #### isRangeValidator(validator)
6747
+ #### isRankingFilter(filter)
6776
6748
 
6777
- Validates if the given validator is a Range type. Range type means the value has min and max values to filter
6749
+ Validates if the given filter is considering a ranking filter type.
6750
+ - Filters with Null and Is Not Null for ranking column are not considering as Ranking Filters.
6778
6751
 
6779
6752
 
6780
6753
 
@@ -6783,7 +6756,7 @@ Validates if the given validator is a Range type. Range type means the value has
6783
6756
 
6784
6757
  | Name | Type | Description | |
6785
6758
  | ---- | ---- | ----------- | -------- |
6786
- | validator | | The filter validator | &nbsp; |
6759
+ | filter | | The filter object | &nbsp; |
6787
6760
 
6788
6761
 
6789
6762
 
@@ -6791,18 +6764,17 @@ Validates if the given validator is a Range type. Range type means the value has
6791
6764
  ##### Returns
6792
6765
 
6793
6766
 
6794
- - true: it is a range validator
6767
+ - a true if the filter is a ranking filter.
6795
6768
 
6796
6769
 
6797
6770
 
6798
6771
 
6799
- ### dist/filters/helpers/common/isRankingFilter.js
6772
+ ### dist/filters/helpers/common/isRegularValidator.js
6800
6773
 
6801
6774
 
6802
- #### isRankingFilter(filter)
6775
+ #### isRegularValidator(validator)
6803
6776
 
6804
- Validates if the given filter is considering a ranking filter type.
6805
- - Filters with Null and Is Not Null for ranking column are not considering as Ranking Filters.
6777
+ Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
6806
6778
 
6807
6779
 
6808
6780
 
@@ -6811,7 +6783,7 @@ Validates if the given filter is considering a ranking filter type.
6811
6783
 
6812
6784
  | Name | Type | Description | |
6813
6785
  | ---- | ---- | ----------- | -------- |
6814
- | filter | | The filter object | &nbsp; |
6786
+ | validator | | The filter validator | &nbsp; |
6815
6787
 
6816
6788
 
6817
6789
 
@@ -6819,17 +6791,17 @@ Validates if the given filter is considering a ranking filter type.
6819
6791
  ##### Returns
6820
6792
 
6821
6793
 
6822
- - a true if the filter is a ranking filter.
6794
+ - true: it is a range validator
6823
6795
 
6824
6796
 
6825
6797
 
6826
6798
 
6827
- ### dist/filters/helpers/common/isRegularValidator.js
6799
+ ### dist/filters/helpers/common/isRangeValidator.js
6828
6800
 
6829
6801
 
6830
- #### isRegularValidator(validator)
6802
+ #### isRangeValidator(validator)
6831
6803
 
6832
- Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
6804
+ Validates if the given validator is a Range type. Range type means the value has min and max values to filter
6833
6805
 
6834
6806
 
6835
6807
 
@@ -7099,12 +7071,12 @@ Resolves the conditions by given params
7099
7071
 
7100
7072
 
7101
7073
 
7102
- ### dist/filters/helpers/settings/areMultipleScopesByProperties.js
7074
+ ### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
7103
7075
 
7104
7076
 
7105
- #### areMultipleScopesByProperties(settings, scopeProperties, condition)
7077
+ #### excludeUIFlatFiltersByScopes(uFilters, scopes)
7106
7078
 
7107
- Validates if the scope settings is satisfied by properties in multiple scopes
7079
+ Excludes and returns a UI Flat Filters without filters by the given scopes
7108
7080
 
7109
7081
 
7110
7082
 
@@ -7113,9 +7085,8 @@ Validates if the scope settings is satisfied by properties in multiple scopes
7113
7085
 
7114
7086
  | Name | Type | Description | |
7115
7087
  | ---- | ---- | ----------- | -------- |
7116
- | settings | `IFSettings` | the filter setting | &nbsp; |
7117
- | scopeProperties | `string` | the property or the string path of the scope settings | &nbsp; |
7118
- | condition | `string` | validate with AND or OR condition | &nbsp; |
7088
+ | uFilters | | The Flatten UI Filters | &nbsp; |
7089
+ | scopes | | collection of scopes types | &nbsp; |
7119
7090
 
7120
7091
 
7121
7092
 
@@ -7123,17 +7094,17 @@ Validates if the scope settings is satisfied by properties in multiple scopes
7123
7094
  ##### Returns
7124
7095
 
7125
7096
 
7126
- - true iif there are scopes to be satisfied; false: one or none scopes to be satisfied
7097
+ - The new array of UI Flattened filters
7127
7098
 
7128
7099
 
7129
7100
 
7130
7101
 
7131
- ### dist/filters/helpers/settings/areMultipleScopesByProperty.js
7102
+ ### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
7132
7103
 
7133
7104
 
7134
- #### areMultipleScopesByProperty(settings, property)
7105
+ #### excludeUIFiltersByAggregate(uFilters)
7135
7106
 
7136
- Validates if the scope settings is satisfied the property in multiple scopes
7107
+ Excludes Aggregate Filters in the Flattened UI Filters array
7137
7108
 
7138
7109
 
7139
7110
 
@@ -7142,8 +7113,7 @@ Validates if the scope settings is satisfied the property in multiple scopes
7142
7113
 
7143
7114
  | Name | Type | Description | |
7144
7115
  | ---- | ---- | ----------- | -------- |
7145
- | settings | `IFSettings` | the filter setting | &nbsp; |
7146
- | property | `string` | the property or the string path of the scope settings | &nbsp; |
7116
+ | uFilters | | Collection of Flat UI Filters | &nbsp; |
7147
7117
 
7148
7118
 
7149
7119
 
@@ -7151,20 +7121,17 @@ Validates if the scope settings is satisfied the property in multiple scopes
7151
7121
  ##### Returns
7152
7122
 
7153
7123
 
7154
- - true if there are scopes to be satisfied; false: one or none scopes to be satisfied
7124
+ - a new Flat UI Filters that were excluded the aggregate filters
7155
7125
 
7156
7126
 
7157
7127
 
7158
7128
 
7159
- ### dist/filters/helpers/settings/getFilterSettings.js
7129
+ ### dist/filters/helpers/ui/getFilterPropertyLabel.js
7160
7130
 
7161
7131
 
7162
- #### getFilterSettings(filterSettings, allowedScopes, otherSettings)
7132
+ #### getFilterPropertyLabel(filter)
7163
7133
 
7164
- Gets a new filter settings object according to various conditions
7165
- - By allowed scopes. Different implementation could accept some scopes, so the forbidden scopes into the filter settings will be skipped
7166
- - If there is not filter settings provived, a default one is returned
7167
- - The returned filter settings depend on the coexisting scopes
7134
+ Gets the label of the filter property
7168
7135
 
7169
7136
 
7170
7137
 
@@ -7173,9 +7140,7 @@ Gets a new filter settings object according to various conditions
7173
7140
 
7174
7141
  | Name | Type | Description | |
7175
7142
  | ---- | ---- | ----------- | -------- |
7176
- | filterSettings | `IFSettings` | the given filter settings | &nbsp; |
7177
- | allowedScopes | `Array.<IFScope>` | a collection of scope types that are permitted | &nbsp; |
7178
- | otherSettings | `IFSettings` | another filter settings object to be merged with the filterSettings param | &nbsp; |
7143
+ | filter | | The UI Filter | &nbsp; |
7179
7144
 
7180
7145
 
7181
7146
 
@@ -7183,13 +7148,17 @@ Gets a new filter settings object according to various conditions
7183
7148
  ##### Returns
7184
7149
 
7185
7150
 
7186
- - a new filter settings object
7151
+ - a string of the filter property label
7187
7152
 
7188
7153
 
7189
7154
 
7190
- #### getFilterSettingsByMultipleScopes(settings, allowedScopes)
7191
7155
 
7192
- Gets the filter settings by multiple scopes conditions
7156
+ ### dist/filters/helpers/ui/getOutputFormatByColumn.js
7157
+
7158
+
7159
+ #### getOutputFormatByColumn(column, datasets)
7160
+
7161
+ Gets output format object from Datasets by the given column. Item of the datasets array must have outputformat item in order to be returned
7193
7162
 
7194
7163
 
7195
7164
 
@@ -7198,8 +7167,8 @@ Gets the filter settings by multiple scopes conditions
7198
7167
 
7199
7168
  | Name | Type | Description | |
7200
7169
  | ---- | ---- | ----------- | -------- |
7201
- | settings | `IFSettings` | the given filter settings | &nbsp; |
7202
- | allowedScopes | `Array.<IFScope>` | a collection of scope types that are permitted | &nbsp; |
7170
+ | column | | The column | &nbsp; |
7171
+ | datasets | | array of datasets | &nbsp; |
7203
7172
 
7204
7173
 
7205
7174
 
@@ -7207,13 +7176,18 @@ Gets the filter settings by multiple scopes conditions
7207
7176
  ##### Returns
7208
7177
 
7209
7178
 
7210
- - a new filter settings object
7179
+ - The output format object
7211
7180
 
7212
7181
 
7213
7182
 
7214
- #### getFilterSettingsByOnlyScope(settings, allowedScopes)
7215
7183
 
7216
- Gets the filter settings when a single scope is permitted
7184
+ ### dist/filters/helpers/ui/getQrveyIdsByUIFilters.js
7185
+
7186
+
7187
+ #### getQrveyIdsByUIFilters(uiFilter)
7188
+
7189
+ Gets a collection of Qrvey IDs in the UI Filter structure.
7190
+ Looks around all filter structure finding the qrveyid propertty in each dataset
7217
7191
 
7218
7192
 
7219
7193
 
@@ -7222,8 +7196,7 @@ Gets the filter settings when a single scope is permitted
7222
7196
 
7223
7197
  | Name | Type | Description | |
7224
7198
  | ---- | ---- | ----------- | -------- |
7225
- | settings | `IFSettings` | the given filter settings | &nbsp; |
7226
- | allowedScopes | `Array.<IFScope>` | a collection of scope types that are permitted | &nbsp; |
7199
+ | uiFilter | | | &nbsp; |
7227
7200
 
7228
7201
 
7229
7202
 
@@ -7231,22 +7204,27 @@ Gets the filter settings when a single scope is permitted
7231
7204
  ##### Returns
7232
7205
 
7233
7206
 
7234
- - a new filter settings object
7207
+ - `Void`
7235
7208
 
7236
7209
 
7237
7210
 
7238
- #### getFilterSettingsByNoScopes(settings)
7239
7211
 
7240
- Gets the filter settings when there is not scope to accept
7212
+ ### dist/filters/helpers/ui/getUIFlatFilterByParams.js
7241
7213
 
7242
7214
 
7215
+ #### getUIFlatFilterByParams()
7243
7216
 
7217
+ Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
7218
+ The validation to filter the stored filter is depending on:
7219
+ - Column
7220
+ - Qrvey ID,
7221
+ - Scope type
7222
+ - Scope ID
7223
+ - Panel ID
7224
+ - Validator type
7225
+ - Property type
7244
7226
 
7245
- ##### Parameters
7246
7227
 
7247
- | Name | Type | Description | |
7248
- | ---- | ---- | ----------- | -------- |
7249
- | settings | `IFSettings` | the given filter settings | &nbsp; |
7250
7228
 
7251
7229
 
7252
7230
 
@@ -7254,23 +7232,56 @@ Gets the filter settings when there is not scope to accept
7254
7232
  ##### Returns
7255
7233
 
7256
7234
 
7257
- - a new filter settings object
7258
-
7259
-
7235
+ - The index of the uFilter array or the Filter object s
7260
7236
 
7261
- #### getFilterSettingsByGeneralOnlyScope(settings)
7262
7237
 
7263
- Gets the filter settings when a general scope are only permitted
7264
- The general scopes could be the GLOBAL, PAGE, TAB and PANEL types.
7265
7238
 
7266
7239
 
7240
+ ### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
7267
7241
 
7268
7242
 
7269
- ##### Parameters
7243
+ #### getUIFlatFiltersByParams()
7244
+
7245
+ Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
7246
+ The validation to filter the stored filter is depending on:
7247
+ - Column
7248
+ - Qrvey ID,
7249
+ - Scope type
7250
+ - Scope ID
7251
+ - Panel ID
7252
+ - Validator type
7253
+ - Property type
7254
+ - Enabled flags
7255
+
7256
+
7257
+
7258
+
7259
+
7260
+
7261
+ ##### Returns
7262
+
7263
+
7264
+ - The index of the uFilter array or the Filter object s
7265
+
7266
+
7267
+
7268
+
7269
+ ### dist/filters/helpers/ui/getUIValues.js
7270
+
7271
+
7272
+ #### getUIValues(filter, settings)
7273
+
7274
+ Gets the UI Values generated depending on the validator
7275
+
7276
+
7277
+
7278
+
7279
+ ##### Parameters
7270
7280
 
7271
7281
  | Name | Type | Description | |
7272
7282
  | ---- | ---- | ----------- | -------- |
7273
- | settings | `IFSettings` | the given filter settings | &nbsp; |
7283
+ | filter | | the filter structure | &nbsp; |
7284
+ | settings | | a settings for this function | &nbsp; |
7274
7285
 
7275
7286
 
7276
7287
 
@@ -7278,13 +7289,17 @@ The general scopes could be the GLOBAL, PAGE, TAB and PANEL types.
7278
7289
  ##### Returns
7279
7290
 
7280
7291
 
7281
- - a new filter settings object
7292
+ - an array of values
7282
7293
 
7283
7294
 
7284
7295
 
7285
- #### getFilterSettingsByNoDefaultScope(settings)
7286
7296
 
7287
- Gets the filter settings when there is not a default scope type
7297
+ ### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
7298
+
7299
+
7300
+ #### getUIFlatFiltersByScopes(uFilters, scopes)
7301
+
7302
+ Filters and gets a UI Flatten Filters by the given scopes
7288
7303
 
7289
7304
 
7290
7305
 
@@ -7293,7 +7308,8 @@ Gets the filter settings when there is not a default scope type
7293
7308
 
7294
7309
  | Name | Type | Description | |
7295
7310
  | ---- | ---- | ----------- | -------- |
7296
- | settings | `IFSettings` | the given filter settings | &nbsp; |
7311
+ | uFilters | | The Flatten UI Filters | &nbsp; |
7312
+ | scopes | | collection of scopes types | &nbsp; |
7297
7313
 
7298
7314
 
7299
7315
 
@@ -7301,13 +7317,17 @@ Gets the filter settings when there is not a default scope type
7301
7317
  ##### Returns
7302
7318
 
7303
7319
 
7304
- - a new filter settings object
7320
+ - The new array of UI Flattened filters
7305
7321
 
7306
7322
 
7307
7323
 
7308
- #### getFilterSettingsByOnlyDefaultScope(settings)
7309
7324
 
7310
- Gets the filter settings when there is only a default scope type
7325
+ ### dist/filters/helpers/ui/getUpdatedUIFilters.js
7326
+
7327
+
7328
+ #### getUpdatedUIFilters(data, datasets)
7329
+
7330
+ Gets a new UI Filter structure with a datasets/columns info updates
7311
7331
 
7312
7332
 
7313
7333
 
@@ -7316,7 +7336,8 @@ Gets the filter settings when there is only a default scope type
7316
7336
 
7317
7337
  | Name | Type | Description | |
7318
7338
  | ---- | ---- | ----------- | -------- |
7319
- | settings | `IFSettings` | the given filter settings | &nbsp; |
7339
+ | data | | The UI Filter structure | &nbsp; |
7340
+ | datasets | | An array of datasets/column info used for updating the data | &nbsp; |
7320
7341
 
7321
7342
 
7322
7343
 
@@ -7324,13 +7345,17 @@ Gets the filter settings when there is only a default scope type
7324
7345
  ##### Returns
7325
7346
 
7326
7347
 
7327
- - a new filter settings object
7348
+ - A new UI FIlter structure
7328
7349
 
7329
7350
 
7330
7351
 
7331
- #### getFilterSettingsByDefaultWithOneAdditionalScope(settings)
7332
7352
 
7333
- Gets the filter settings when there are a default scope and other single scope
7353
+ ### dist/filters/helpers/ui/resolveUIFlatFilterByParams.js
7354
+
7355
+
7356
+ #### resolveUIFlatFilterByParams(filter, params)
7357
+
7358
+ Resolves conditions between UI flattened filter and given parameters
7334
7359
 
7335
7360
 
7336
7361
 
@@ -7339,7 +7364,8 @@ Gets the filter settings when there are a default scope and other single scope
7339
7364
 
7340
7365
  | Name | Type | Description | |
7341
7366
  | ---- | ---- | ----------- | -------- |
7342
- | settings | `IFSettings` | the given filter settings | &nbsp; |
7367
+ | filter | | UI Flatten Filter | &nbsp; |
7368
+ | params | | Parameters to validate | &nbsp; |
7343
7369
 
7344
7370
 
7345
7371
 
@@ -7347,13 +7373,17 @@ Gets the filter settings when there are a default scope and other single scope
7347
7373
  ##### Returns
7348
7374
 
7349
7375
 
7350
- - a new filter settings object
7376
+ - true: the conditions are satisfied.
7351
7377
 
7352
7378
 
7353
7379
 
7354
- #### getFilterSettingsByOnlyPanelScope(settings)
7355
7380
 
7356
- Gets the filter settings when there is only the panel scope
7381
+ ### dist/filters/helpers/settings/areMultipleScopesByProperties.js
7382
+
7383
+
7384
+ #### areMultipleScopesByProperties(settings, scopeProperties, condition)
7385
+
7386
+ Validates if the scope settings is satisfied by properties in multiple scopes
7357
7387
 
7358
7388
 
7359
7389
 
@@ -7362,7 +7392,9 @@ Gets the filter settings when there is only the panel scope
7362
7392
 
7363
7393
  | Name | Type | Description | |
7364
7394
  | ---- | ---- | ----------- | -------- |
7365
- | settings | `IFSettings` | the given filter settings | &nbsp; |
7395
+ | settings | `IFSettings` | the filter setting | &nbsp; |
7396
+ | scopeProperties | `string` | the property or the string path of the scope settings | &nbsp; |
7397
+ | condition | `string` | validate with AND or OR condition | &nbsp; |
7366
7398
 
7367
7399
 
7368
7400
 
@@ -7370,13 +7402,17 @@ Gets the filter settings when there is only the panel scope
7370
7402
  ##### Returns
7371
7403
 
7372
7404
 
7373
- - a new filter settings object
7405
+ - true iif there are scopes to be satisfied; false: one or none scopes to be satisfied
7374
7406
 
7375
7407
 
7376
7408
 
7377
- #### getFilterSettingsByOnlyDataScope(settings)
7378
7409
 
7379
- Gets the filter settings when there is only the data scope
7410
+ ### dist/filters/helpers/settings/areMultipleScopesByProperty.js
7411
+
7412
+
7413
+ #### areMultipleScopesByProperty(settings, property)
7414
+
7415
+ Validates if the scope settings is satisfied the property in multiple scopes
7380
7416
 
7381
7417
 
7382
7418
 
@@ -7385,7 +7421,8 @@ Gets the filter settings when there is only the data scope
7385
7421
 
7386
7422
  | Name | Type | Description | |
7387
7423
  | ---- | ---- | ----------- | -------- |
7388
- | settings | `IFSettings` | the given filter settings | &nbsp; |
7424
+ | settings | `IFSettings` | the filter setting | &nbsp; |
7425
+ | property | `string` | the property or the string path of the scope settings | &nbsp; |
7389
7426
 
7390
7427
 
7391
7428
 
@@ -7393,14 +7430,20 @@ Gets the filter settings when there is only the data scope
7393
7430
  ##### Returns
7394
7431
 
7395
7432
 
7396
- - a new filter settings object
7433
+ - true if there are scopes to be satisfied; false: one or none scopes to be satisfied
7397
7434
 
7398
7435
 
7399
7436
 
7400
- #### getFilterSettingsBySkippingGeneralScopes(settings)
7401
7437
 
7402
- Gets the filter settings when there are not general scopes allowed
7403
- The general scopes could be the GLOBAL, PAGE, TAB and PANEL types.
7438
+ ### dist/filters/helpers/settings/getFilterSettings.js
7439
+
7440
+
7441
+ #### getFilterSettings(filterSettings, allowedScopes, otherSettings)
7442
+
7443
+ Gets a new filter settings object according to various conditions
7444
+ - By allowed scopes. Different implementation could accept some scopes, so the forbidden scopes into the filter settings will be skipped
7445
+ - If there is not filter settings provived, a default one is returned
7446
+ - The returned filter settings depend on the coexisting scopes
7404
7447
 
7405
7448
 
7406
7449
 
@@ -7409,7 +7452,9 @@ The general scopes could be the GLOBAL, PAGE, TAB and PANEL types.
7409
7452
 
7410
7453
  | Name | Type | Description | |
7411
7454
  | ---- | ---- | ----------- | -------- |
7412
- | settings | `IFSettings` | the given filter settings | &nbsp; |
7455
+ | filterSettings | `IFSettings` | the given filter settings | &nbsp; |
7456
+ | allowedScopes | `Array.<IFScope>` | a collection of scope types that are permitted | &nbsp; |
7457
+ | otherSettings | `IFSettings` | another filter settings object to be merged with the filterSettings param | &nbsp; |
7413
7458
 
7414
7459
 
7415
7460
 
@@ -7421,9 +7466,9 @@ The general scopes could be the GLOBAL, PAGE, TAB and PANEL types.
7421
7466
 
7422
7467
 
7423
7468
 
7424
- #### getFilterSettingsByMultipleNoPanelScopes(settings)
7469
+ #### getFilterSettingsByMultipleScopes(settings, allowedScopes)
7425
7470
 
7426
- Gets the filter settings when there are no panel scopes and multiple scopes allowed.
7471
+ Gets the filter settings by multiple scopes conditions
7427
7472
 
7428
7473
 
7429
7474
 
@@ -7433,6 +7478,7 @@ Gets the filter settings when there are no panel scopes and multiple scopes allo
7433
7478
  | Name | Type | Description | |
7434
7479
  | ---- | ---- | ----------- | -------- |
7435
7480
  | settings | `IFSettings` | the given filter settings | &nbsp; |
7481
+ | allowedScopes | `Array.<IFScope>` | a collection of scope types that are permitted | &nbsp; |
7436
7482
 
7437
7483
 
7438
7484
 
@@ -7444,13 +7490,9 @@ Gets the filter settings when there are no panel scopes and multiple scopes allo
7444
7490
 
7445
7491
 
7446
7492
 
7493
+ #### getFilterSettingsByOnlyScope(settings, allowedScopes)
7447
7494
 
7448
- ### dist/filters/helpers/settings/getScopeColorSetting.js
7449
-
7450
-
7451
- #### getScopeColorSetting(settings, scope)
7452
-
7453
- Gets the color of the scope in the settings object
7495
+ Gets the filter settings when a single scope is permitted
7454
7496
 
7455
7497
 
7456
7498
 
@@ -7459,8 +7501,8 @@ Gets the color of the scope in the settings object
7459
7501
 
7460
7502
  | Name | Type | Description | |
7461
7503
  | ---- | ---- | ----------- | -------- |
7462
- | settings | `IFSettings` | the filter settings | &nbsp; |
7463
- | scope | `IFScope` | the scope type | &nbsp; |
7504
+ | settings | `IFSettings` | the given filter settings | &nbsp; |
7505
+ | allowedScopes | `Array.<IFScope>` | a collection of scope types that are permitted | &nbsp; |
7464
7506
 
7465
7507
 
7466
7508
 
@@ -7468,17 +7510,13 @@ Gets the color of the scope in the settings object
7468
7510
  ##### Returns
7469
7511
 
7470
7512
 
7471
- - an string with the color.
7472
-
7473
-
7474
-
7513
+ - a new filter settings object
7475
7514
 
7476
- ### dist/filters/helpers/settings/getScopeSettings.js
7477
7515
 
7478
7516
 
7479
- #### getScopeSettings(settings, scope)
7517
+ #### getFilterSettingsByNoScopes(settings)
7480
7518
 
7481
- Gets the scope settings by the scope type
7519
+ Gets the filter settings when there is not scope to accept
7482
7520
 
7483
7521
 
7484
7522
 
@@ -7487,8 +7525,7 @@ Gets the scope settings by the scope type
7487
7525
 
7488
7526
  | Name | Type | Description | |
7489
7527
  | ---- | ---- | ----------- | -------- |
7490
- | settings | `IFSettings` | the filter settings | &nbsp; |
7491
- | scope | `IFScope` | the scope type | &nbsp; |
7528
+ | settings | `IFSettings` | the given filter settings | &nbsp; |
7492
7529
 
7493
7530
 
7494
7531
 
@@ -7496,17 +7533,14 @@ Gets the scope settings by the scope type
7496
7533
  ##### Returns
7497
7534
 
7498
7535
 
7499
- - the scope settings
7500
-
7501
-
7502
-
7536
+ - a new filter settings object
7503
7537
 
7504
- ### dist/filters/helpers/settings/getScopesSettings.js
7505
7538
 
7506
7539
 
7507
- #### getScopesSettings(scopes)
7540
+ #### getFilterSettingsByGeneralOnlyScope(settings)
7508
7541
 
7509
- Gets the scopes settings as array
7542
+ Gets the filter settings when a general scope are only permitted
7543
+ The general scopes could be the GLOBAL, PAGE, TAB and PANEL types.
7510
7544
 
7511
7545
 
7512
7546
 
@@ -7515,7 +7549,7 @@ Gets the scopes settings as array
7515
7549
 
7516
7550
  | Name | Type | Description | |
7517
7551
  | ---- | ---- | ----------- | -------- |
7518
- | scopes | `IFSettingsScopes` | the scopes settings | &nbsp; |
7552
+ | settings | `IFSettings` | the given filter settings | &nbsp; |
7519
7553
 
7520
7554
 
7521
7555
 
@@ -7523,17 +7557,13 @@ Gets the scopes settings as array
7523
7557
  ##### Returns
7524
7558
 
7525
7559
 
7526
- - an array of the scopes settings
7527
-
7528
-
7529
-
7560
+ - a new filter settings object
7530
7561
 
7531
- ### dist/filters/helpers/settings/getScopesToDisplay.js
7532
7562
 
7533
7563
 
7534
- #### getScopesToDisplay(settings)
7564
+ #### getFilterSettingsByNoDefaultScope(settings)
7535
7565
 
7536
- Gets the scope allowed to display
7566
+ Gets the filter settings when there is not a default scope type
7537
7567
 
7538
7568
 
7539
7569
 
@@ -7542,7 +7572,7 @@ Gets the scope allowed to display
7542
7572
 
7543
7573
  | Name | Type | Description | |
7544
7574
  | ---- | ---- | ----------- | -------- |
7545
- | settings | `IFSettings` | the filter settings | &nbsp; |
7575
+ | settings | `IFSettings` | the given filter settings | &nbsp; |
7546
7576
 
7547
7577
 
7548
7578
 
@@ -7550,17 +7580,13 @@ Gets the scope allowed to display
7550
7580
  ##### Returns
7551
7581
 
7552
7582
 
7553
- - an array of the scopes settings
7554
-
7555
-
7556
-
7583
+ - a new filter settings object
7557
7584
 
7558
- ### dist/filters/helpers/settings/isLeastSingleScopeByProperties.js
7559
7585
 
7560
7586
 
7561
- #### isLeastSingleScopeByProperties(settings, scopeProperties, condition)
7587
+ #### getFilterSettingsByOnlyDefaultScope(settings)
7562
7588
 
7563
- Validates if the scope settings is satisfied by properties at least in one scope
7589
+ Gets the filter settings when there is only a default scope type
7564
7590
 
7565
7591
 
7566
7592
 
@@ -7569,9 +7595,7 @@ Validates if the scope settings is satisfied by properties at least in one scope
7569
7595
 
7570
7596
  | Name | Type | Description | |
7571
7597
  | ---- | ---- | ----------- | -------- |
7572
- | settings | `IFSettings` | the filter setting | &nbsp; |
7573
- | scopeProperties | `string` | the property or the string path of the scope settings | &nbsp; |
7574
- | condition | `string` | validate with AND or OR condition | &nbsp; |
7598
+ | settings | `IFSettings` | the given filter settings | &nbsp; |
7575
7599
 
7576
7600
 
7577
7601
 
@@ -7579,17 +7603,13 @@ Validates if the scope settings is satisfied by properties at least in one scope
7579
7603
  ##### Returns
7580
7604
 
7581
7605
 
7582
- - true if there is one scope to be satisfied; false: none scopes to be satisfied
7583
-
7584
-
7585
-
7606
+ - a new filter settings object
7586
7607
 
7587
- ### dist/filters/helpers/settings/isLeastSingleScopeByProperty.js
7588
7608
 
7589
7609
 
7590
- #### isLeastSingleScopeByProperty(settings, property)
7610
+ #### getFilterSettingsByDefaultWithOneAdditionalScope(settings)
7591
7611
 
7592
- Validates if the scope settings is satisfied by a property at least in one scope
7612
+ Gets the filter settings when there are a default scope and other single scope
7593
7613
 
7594
7614
 
7595
7615
 
@@ -7598,8 +7618,7 @@ Validates if the scope settings is satisfied by a property at least in one scope
7598
7618
 
7599
7619
  | Name | Type | Description | |
7600
7620
  | ---- | ---- | ----------- | -------- |
7601
- | settings | `IFSettings` | the filter setting | &nbsp; |
7602
- | property | `string` | the property or the string path of the scope settings | &nbsp; |
7621
+ | settings | `IFSettings` | the given filter settings | &nbsp; |
7603
7622
 
7604
7623
 
7605
7624
 
@@ -7607,17 +7626,13 @@ Validates if the scope settings is satisfied by a property at least in one scope
7607
7626
  ##### Returns
7608
7627
 
7609
7628
 
7610
- - true if there is one scope to be satisfied; false: none scopes to be satisfied
7611
-
7612
-
7613
-
7629
+ - a new filter settings object
7614
7630
 
7615
- ### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
7616
7631
 
7617
7632
 
7618
- #### excludeUIFiltersByAggregate(uFilters)
7633
+ #### getFilterSettingsByOnlyPanelScope(settings)
7619
7634
 
7620
- Excludes Aggregate Filters in the Flattened UI Filters array
7635
+ Gets the filter settings when there is only the panel scope
7621
7636
 
7622
7637
 
7623
7638
 
@@ -7626,7 +7641,7 @@ Excludes Aggregate Filters in the Flattened UI Filters array
7626
7641
 
7627
7642
  | Name | Type | Description | |
7628
7643
  | ---- | ---- | ----------- | -------- |
7629
- | uFilters | | Collection of Flat UI Filters | &nbsp; |
7644
+ | settings | `IFSettings` | the given filter settings | &nbsp; |
7630
7645
 
7631
7646
 
7632
7647
 
@@ -7634,17 +7649,13 @@ Excludes Aggregate Filters in the Flattened UI Filters array
7634
7649
  ##### Returns
7635
7650
 
7636
7651
 
7637
- - a new Flat UI Filters that were excluded the aggregate filters
7638
-
7639
-
7640
-
7652
+ - a new filter settings object
7641
7653
 
7642
- ### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
7643
7654
 
7644
7655
 
7645
- #### excludeUIFlatFiltersByScopes(uFilters, scopes)
7656
+ #### getFilterSettingsByOnlyDataScope(settings)
7646
7657
 
7647
- Excludes and returns a UI Flat Filters without filters by the given scopes
7658
+ Gets the filter settings when there is only the data scope
7648
7659
 
7649
7660
 
7650
7661
 
@@ -7653,8 +7664,7 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
7653
7664
 
7654
7665
  | Name | Type | Description | |
7655
7666
  | ---- | ---- | ----------- | -------- |
7656
- | uFilters | | The Flatten UI Filters | &nbsp; |
7657
- | scopes | | collection of scopes types | &nbsp; |
7667
+ | settings | `IFSettings` | the given filter settings | &nbsp; |
7658
7668
 
7659
7669
 
7660
7670
 
@@ -7662,17 +7672,14 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
7662
7672
  ##### Returns
7663
7673
 
7664
7674
 
7665
- - The new array of UI Flattened filters
7666
-
7667
-
7668
-
7675
+ - a new filter settings object
7669
7676
 
7670
- ### dist/filters/helpers/ui/getFilterPropertyLabel.js
7671
7677
 
7672
7678
 
7673
- #### getFilterPropertyLabel(filter)
7679
+ #### getFilterSettingsBySkippingGeneralScopes(settings)
7674
7680
 
7675
- Gets the label of the filter property
7681
+ Gets the filter settings when there are not general scopes allowed
7682
+ The general scopes could be the GLOBAL, PAGE, TAB and PANEL types.
7676
7683
 
7677
7684
 
7678
7685
 
@@ -7681,7 +7688,7 @@ Gets the label of the filter property
7681
7688
 
7682
7689
  | Name | Type | Description | |
7683
7690
  | ---- | ---- | ----------- | -------- |
7684
- | filter | | The UI Filter | &nbsp; |
7691
+ | settings | `IFSettings` | the given filter settings | &nbsp; |
7685
7692
 
7686
7693
 
7687
7694
 
@@ -7689,17 +7696,13 @@ Gets the label of the filter property
7689
7696
  ##### Returns
7690
7697
 
7691
7698
 
7692
- - a string of the filter property label
7693
-
7694
-
7695
-
7699
+ - a new filter settings object
7696
7700
 
7697
- ### dist/filters/helpers/ui/getOutputFormatByColumn.js
7698
7701
 
7699
7702
 
7700
- #### getOutputFormatByColumn(column, datasets)
7703
+ #### getFilterSettingsByMultipleNoPanelGlobalScopes(settings)
7701
7704
 
7702
- Gets output format object from Datasets by the given column. Item of the datasets array must have outputformat item in order to be returned
7705
+ Gets the filter settings when there are no panel scopes and multiple scopes allowed.
7703
7706
 
7704
7707
 
7705
7708
 
@@ -7708,8 +7711,7 @@ Gets output format object from Datasets by the given column. Item of the dataset
7708
7711
 
7709
7712
  | Name | Type | Description | |
7710
7713
  | ---- | ---- | ----------- | -------- |
7711
- | column | | The column | &nbsp; |
7712
- | datasets | | array of datasets | &nbsp; |
7714
+ | settings | `IFSettings` | the given filter settings | &nbsp; |
7713
7715
 
7714
7716
 
7715
7717
 
@@ -7717,18 +7719,13 @@ Gets output format object from Datasets by the given column. Item of the dataset
7717
7719
  ##### Returns
7718
7720
 
7719
7721
 
7720
- - The output format object
7721
-
7722
-
7723
-
7722
+ - a new filter settings object
7724
7723
 
7725
- ### dist/filters/helpers/ui/getQrveyIdsByUIFilters.js
7726
7724
 
7727
7725
 
7728
- #### getQrveyIdsByUIFilters(uiFilter)
7726
+ #### getFilterSettingsByMultipleNoPanelScopes(settings)
7729
7727
 
7730
- Gets a collection of Qrvey IDs in the UI Filter structure.
7731
- Looks around all filter structure finding the qrveyid propertty in each dataset
7728
+ Gets the filter settings when there are no panel scopes and multiple scopes allowed.
7732
7729
 
7733
7730
 
7734
7731
 
@@ -7737,7 +7734,7 @@ Looks around all filter structure finding the qrveyid propertty in each dataset
7737
7734
 
7738
7735
  | Name | Type | Description | |
7739
7736
  | ---- | ---- | ----------- | -------- |
7740
- | uiFilter | | | &nbsp; |
7737
+ | settings | `IFSettings` | the given filter settings | &nbsp; |
7741
7738
 
7742
7739
 
7743
7740
 
@@ -7745,74 +7742,73 @@ Looks around all filter structure finding the qrveyid propertty in each dataset
7745
7742
  ##### Returns
7746
7743
 
7747
7744
 
7748
- - `Void`
7745
+ - a new filter settings object
7749
7746
 
7750
7747
 
7751
7748
 
7752
7749
 
7753
- ### dist/filters/helpers/ui/getUIFlatFilterByParams.js
7750
+ ### dist/filters/helpers/settings/getScopeColorSetting.js
7754
7751
 
7755
7752
 
7756
- #### getUIFlatFilterByParams()
7753
+ #### getScopeColorSetting(settings, scope)
7757
7754
 
7758
- Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
7759
- The validation to filter the stored filter is depending on:
7760
- - Column
7761
- - Qrvey ID,
7762
- - Scope type
7763
- - Scope ID
7764
- - Panel ID
7765
- - Validator type
7766
- - Property type
7755
+ Gets the color of the scope in the settings object
7767
7756
 
7768
7757
 
7769
7758
 
7770
7759
 
7760
+ ##### Parameters
7761
+
7762
+ | Name | Type | Description | |
7763
+ | ---- | ---- | ----------- | -------- |
7764
+ | settings | `IFSettings` | the filter settings | &nbsp; |
7765
+ | scope | `IFScope` | the scope type | &nbsp; |
7766
+
7767
+
7771
7768
 
7772
7769
 
7773
7770
  ##### Returns
7774
7771
 
7775
7772
 
7776
- - The index of the uFilter array or the Filter object s
7773
+ - an string with the color.
7777
7774
 
7778
7775
 
7779
7776
 
7780
7777
 
7781
- ### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
7778
+ ### dist/filters/helpers/settings/getScopeSettings.js
7782
7779
 
7783
7780
 
7784
- #### getUIFlatFiltersByParams()
7781
+ #### getScopeSettings(settings, scope)
7785
7782
 
7786
- Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
7787
- The validation to filter the stored filter is depending on:
7788
- - Column
7789
- - Qrvey ID,
7790
- - Scope type
7791
- - Scope ID
7792
- - Panel ID
7793
- - Validator type
7794
- - Property type
7795
- - Enabled flags
7783
+ Gets the scope settings by the scope type
7796
7784
 
7797
7785
 
7798
7786
 
7799
7787
 
7788
+ ##### Parameters
7789
+
7790
+ | Name | Type | Description | |
7791
+ | ---- | ---- | ----------- | -------- |
7792
+ | settings | `IFSettings` | the filter settings | &nbsp; |
7793
+ | scope | `IFScope` | the scope type | &nbsp; |
7794
+
7795
+
7800
7796
 
7801
7797
 
7802
7798
  ##### Returns
7803
7799
 
7804
7800
 
7805
- - The index of the uFilter array or the Filter object s
7801
+ - the scope settings
7806
7802
 
7807
7803
 
7808
7804
 
7809
7805
 
7810
- ### dist/filters/helpers/ui/getUIValues.js
7806
+ ### dist/filters/helpers/settings/getScopesToDisplay.js
7811
7807
 
7812
7808
 
7813
- #### getUIValues(filter, settings)
7809
+ #### getScopesToDisplay(settings)
7814
7810
 
7815
- Gets the UI Values generated depending on the validator
7811
+ Gets the scope allowed to display
7816
7812
 
7817
7813
 
7818
7814
 
@@ -7821,8 +7817,7 @@ Gets the UI Values generated depending on the validator
7821
7817
 
7822
7818
  | Name | Type | Description | |
7823
7819
  | ---- | ---- | ----------- | -------- |
7824
- | filter | | the filter structure | &nbsp; |
7825
- | settings | | a settings for this function | &nbsp; |
7820
+ | settings | `IFSettings` | the filter settings | &nbsp; |
7826
7821
 
7827
7822
 
7828
7823
 
@@ -7830,17 +7825,17 @@ Gets the UI Values generated depending on the validator
7830
7825
  ##### Returns
7831
7826
 
7832
7827
 
7833
- - an array of values
7828
+ - an array of the scopes settings
7834
7829
 
7835
7830
 
7836
7831
 
7837
7832
 
7838
- ### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
7833
+ ### dist/filters/helpers/settings/getScopesSettings.js
7839
7834
 
7840
7835
 
7841
- #### getUIFlatFiltersByScopes(uFilters, scopes)
7836
+ #### getScopesSettings(scopes)
7842
7837
 
7843
- Filters and gets a UI Flatten Filters by the given scopes
7838
+ Gets the scopes settings as array
7844
7839
 
7845
7840
 
7846
7841
 
@@ -7849,8 +7844,7 @@ Filters and gets a UI Flatten Filters by the given scopes
7849
7844
 
7850
7845
  | Name | Type | Description | |
7851
7846
  | ---- | ---- | ----------- | -------- |
7852
- | uFilters | | The Flatten UI Filters | &nbsp; |
7853
- | scopes | | collection of scopes types | &nbsp; |
7847
+ | scopes | `IFSettingsScopes` | the scopes settings | &nbsp; |
7854
7848
 
7855
7849
 
7856
7850
 
@@ -7858,17 +7852,17 @@ Filters and gets a UI Flatten Filters by the given scopes
7858
7852
  ##### Returns
7859
7853
 
7860
7854
 
7861
- - The new array of UI Flattened filters
7855
+ - an array of the scopes settings
7862
7856
 
7863
7857
 
7864
7858
 
7865
7859
 
7866
- ### dist/filters/helpers/ui/getUpdatedUIFilters.js
7860
+ ### dist/filters/helpers/settings/isLeastSingleScopeByProperties.js
7867
7861
 
7868
7862
 
7869
- #### getUpdatedUIFilters(data, datasets)
7863
+ #### isLeastSingleScopeByProperties(settings, scopeProperties, condition)
7870
7864
 
7871
- Gets a new UI Filter structure with a datasets/columns info updates
7865
+ Validates if the scope settings is satisfied by properties at least in one scope
7872
7866
 
7873
7867
 
7874
7868
 
@@ -7877,8 +7871,9 @@ Gets a new UI Filter structure with a datasets/columns info updates
7877
7871
 
7878
7872
  | Name | Type | Description | |
7879
7873
  | ---- | ---- | ----------- | -------- |
7880
- | data | | The UI Filter structure | &nbsp; |
7881
- | datasets | | An array of datasets/column info used for updating the data | &nbsp; |
7874
+ | settings | `IFSettings` | the filter setting | &nbsp; |
7875
+ | scopeProperties | `string` | the property or the string path of the scope settings | &nbsp; |
7876
+ | condition | `string` | validate with AND or OR condition | &nbsp; |
7882
7877
 
7883
7878
 
7884
7879
 
@@ -7886,17 +7881,17 @@ Gets a new UI Filter structure with a datasets/columns info updates
7886
7881
  ##### Returns
7887
7882
 
7888
7883
 
7889
- - A new UI FIlter structure
7884
+ - true if there is one scope to be satisfied; false: none scopes to be satisfied
7890
7885
 
7891
7886
 
7892
7887
 
7893
7888
 
7894
- ### dist/filters/helpers/ui/resolveUIFlatFilterByParams.js
7889
+ ### dist/filters/helpers/settings/isLeastSingleScopeByProperty.js
7895
7890
 
7896
7891
 
7897
- #### resolveUIFlatFilterByParams(filter, params)
7892
+ #### isLeastSingleScopeByProperty(settings, property)
7898
7893
 
7899
- Resolves conditions between UI flattened filter and given parameters
7894
+ Validates if the scope settings is satisfied by a property at least in one scope
7900
7895
 
7901
7896
 
7902
7897
 
@@ -7905,8 +7900,8 @@ Resolves conditions between UI flattened filter and given parameters
7905
7900
 
7906
7901
  | Name | Type | Description | |
7907
7902
  | ---- | ---- | ----------- | -------- |
7908
- | filter | | UI Flatten Filter | &nbsp; |
7909
- | params | | Parameters to validate | &nbsp; |
7903
+ | settings | `IFSettings` | the filter setting | &nbsp; |
7904
+ | property | `string` | the property or the string path of the scope settings | &nbsp; |
7910
7905
 
7911
7906
 
7912
7907
 
@@ -7914,7 +7909,7 @@ Resolves conditions between UI flattened filter and given parameters
7914
7909
  ##### Returns
7915
7910
 
7916
7911
 
7917
- - true: the conditions are satisfied.
7912
+ - true if there is one scope to be satisfied; false: none scopes to be satisfied
7918
7913
 
7919
7914
 
7920
7915