@qrvey/utils 1.2.9-29 → 1.2.9-31
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 +449 -449
- package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderTableCalculation.d.ts +1 -0
- package/dist/cjs/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL.js +2 -2
- package/dist/cjs/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL_OPTIONS.js +1 -0
- package/dist/cjs/globalization/labels/panel/I18N_PANEL.js +1 -1
- package/dist/cjs/services/api/getAllDatasets.api.js +1 -2
- package/dist/globalization/interfaces/chart_builder/II18nChartBuilderTableCalculation.d.ts +1 -0
- package/dist/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL.js +2 -2
- package/dist/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL_OPTIONS.js +1 -0
- package/dist/globalization/labels/panel/I18N_PANEL.js +1 -1
- package/dist/services/api/getAllDatasets.api.js +1 -2
- package/package.json +4 -7
- package/src/globalization/interfaces/chart_builder/II18nChartBuilderTableCalculation.ts +1 -0
- package/src/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL.ts +2 -2
- package/src/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL_OPTIONS.ts +1 -0
- package/src/globalization/labels/panel/I18N_PANEL.ts +1 -1
- package/src/services/api/getAllDatasets.api.ts +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-
|
|
1
|
+
# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-31*
|
|
2
2
|
|
|
3
3
|
> Helper, Utils for all Qrvey Projects
|
|
4
4
|
|
|
@@ -417,64 +417,6 @@ Validates the given string as Date by its date format.
|
|
|
417
417
|
|
|
418
418
|
|
|
419
419
|
|
|
420
|
-
### dist/dates/range/getDateRange.js
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
#### getDateRange(value, dateGroupLabel, withTime)
|
|
424
|
-
|
|
425
|
-
Get date range object from a string date value
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
##### Parameters
|
|
431
|
-
|
|
432
|
-
| Name | Type | Description | |
|
|
433
|
-
| ---- | ---- | ----------- | -------- |
|
|
434
|
-
| value | `String` | string date value | |
|
|
435
|
-
| dateGroupLabel | `String` | could be 'YEAR', 'QUARTER', 'MONTH' or 'DAY'. Deafult is 'DAY' | |
|
|
436
|
-
| withTime | `Boolean` | determines if the date range will include time. Default is true | |
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
##### Examples
|
|
442
|
-
|
|
443
|
-
```javascript
|
|
444
|
-
// 1) Year:
|
|
445
|
-
getDateRange('2020', 'YEAR');
|
|
446
|
-
// Will return:
|
|
447
|
-
{
|
|
448
|
-
from: '01/01/2020 00:00:00',
|
|
449
|
-
to: '12/31/2020 23:59:59'
|
|
450
|
-
}
|
|
451
|
-
|
|
452
|
-
// 2) Quarter:
|
|
453
|
-
getDateRange('Q3 2020', 'QUARTER');
|
|
454
|
-
// Will return:
|
|
455
|
-
{
|
|
456
|
-
from: '07/01/2020 00:00:00',
|
|
457
|
-
to: '09/30/2020 23:59:59'
|
|
458
|
-
}
|
|
459
|
-
|
|
460
|
-
// 3) Month:
|
|
461
|
-
getDateRange('Oct 2020', 'MONTH');
|
|
462
|
-
// Will return:
|
|
463
|
-
{
|
|
464
|
-
from: '10/01/2020 00:00:00',
|
|
465
|
-
to: '10/31/2020 23:59:59'
|
|
466
|
-
}
|
|
467
|
-
```
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
##### Returns
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
- `Object` an object with the date range with two string date properties: from and to
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
420
|
### dist/dates/relative/Adapter.js
|
|
479
421
|
|
|
480
422
|
|
|
@@ -688,6 +630,64 @@ Output:
|
|
|
688
630
|
|
|
689
631
|
|
|
690
632
|
|
|
633
|
+
### dist/dates/range/getDateRange.js
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
#### getDateRange(value, dateGroupLabel, withTime)
|
|
637
|
+
|
|
638
|
+
Get date range object from a string date value
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
##### Parameters
|
|
644
|
+
|
|
645
|
+
| Name | Type | Description | |
|
|
646
|
+
| ---- | ---- | ----------- | -------- |
|
|
647
|
+
| value | `String` | string date value | |
|
|
648
|
+
| dateGroupLabel | `String` | could be 'YEAR', 'QUARTER', 'MONTH' or 'DAY'. Deafult is 'DAY' | |
|
|
649
|
+
| withTime | `Boolean` | determines if the date range will include time. Default is true | |
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
##### Examples
|
|
655
|
+
|
|
656
|
+
```javascript
|
|
657
|
+
// 1) Year:
|
|
658
|
+
getDateRange('2020', 'YEAR');
|
|
659
|
+
// Will return:
|
|
660
|
+
{
|
|
661
|
+
from: '01/01/2020 00:00:00',
|
|
662
|
+
to: '12/31/2020 23:59:59'
|
|
663
|
+
}
|
|
664
|
+
|
|
665
|
+
// 2) Quarter:
|
|
666
|
+
getDateRange('Q3 2020', 'QUARTER');
|
|
667
|
+
// Will return:
|
|
668
|
+
{
|
|
669
|
+
from: '07/01/2020 00:00:00',
|
|
670
|
+
to: '09/30/2020 23:59:59'
|
|
671
|
+
}
|
|
672
|
+
|
|
673
|
+
// 3) Month:
|
|
674
|
+
getDateRange('Oct 2020', 'MONTH');
|
|
675
|
+
// Will return:
|
|
676
|
+
{
|
|
677
|
+
from: '10/01/2020 00:00:00',
|
|
678
|
+
to: '10/31/2020 23:59:59'
|
|
679
|
+
}
|
|
680
|
+
```
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
##### Returns
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
- `Object` an object with the date range with two string date properties: from and to
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
|
|
691
691
|
### dist/filters/adapters/FDToFlatUI.js
|
|
692
692
|
|
|
693
693
|
|
|
@@ -974,13 +974,12 @@ Get the new property base on the old date grouping properties
|
|
|
974
974
|
|
|
975
975
|
|
|
976
976
|
|
|
977
|
-
### dist/filters/adapters/
|
|
977
|
+
### dist/filters/adapters/adaptFilterData.js
|
|
978
978
|
|
|
979
979
|
|
|
980
|
-
####
|
|
980
|
+
#### adaptFilterData(filterData, getUIFilterData, datasetsInfo)
|
|
981
981
|
|
|
982
|
-
|
|
983
|
-
Gets an adapted filter value array. Validates the enabled property and sets
|
|
982
|
+
Checks and adapts the v2.0 Filter Data Structure to the v2.1
|
|
984
983
|
|
|
985
984
|
|
|
986
985
|
|
|
@@ -989,7 +988,9 @@ Gets an adapted filter value array. Validates the enabled property and sets
|
|
|
989
988
|
|
|
990
989
|
| Name | Type | Description | |
|
|
991
990
|
| ---- | ---- | ----------- | -------- |
|
|
992
|
-
|
|
|
991
|
+
| filterData | | The filter data structure. Accepts both v2.1 or v2.0 | |
|
|
992
|
+
| getUIFilterData | | Flag to get a Filter Data (False) or the UI Filter Data (True) | |
|
|
993
|
+
| datasetsInfo | | Collection of datasets information. If getUIFilterData is true, the datasetsInfo should be mandatory | |
|
|
993
994
|
|
|
994
995
|
|
|
995
996
|
|
|
@@ -997,17 +998,18 @@ Gets an adapted filter value array. Validates the enabled property and sets
|
|
|
997
998
|
##### Returns
|
|
998
999
|
|
|
999
1000
|
|
|
1000
|
-
- A new
|
|
1001
|
+
- A new filter data structure v2.1
|
|
1001
1002
|
|
|
1002
1003
|
|
|
1003
1004
|
|
|
1004
1005
|
|
|
1005
|
-
### dist/filters/adapters/
|
|
1006
|
+
### dist/filters/adapters/adaptFilterValues.js
|
|
1006
1007
|
|
|
1007
1008
|
|
|
1008
|
-
####
|
|
1009
|
+
#### adaptFilterValues(filter)
|
|
1009
1010
|
|
|
1010
|
-
|
|
1011
|
+
[TODO: For 2022, eliminate this adapter]
|
|
1012
|
+
Gets an adapted filter value array. Validates the enabled property and sets
|
|
1011
1013
|
|
|
1012
1014
|
|
|
1013
1015
|
|
|
@@ -1016,9 +1018,7 @@ Checks and adapts the v2.0 Filter Data Structure to the v2.1
|
|
|
1016
1018
|
|
|
1017
1019
|
| Name | Type | Description | |
|
|
1018
1020
|
| ---- | ---- | ----------- | -------- |
|
|
1019
|
-
|
|
|
1020
|
-
| getUIFilterData | | Flag to get a Filter Data (False) or the UI Filter Data (True) | |
|
|
1021
|
-
| datasetsInfo | | Collection of datasets information. If getUIFilterData is true, the datasetsInfo should be mandatory | |
|
|
1021
|
+
| filter | | The filter | |
|
|
1022
1022
|
|
|
1023
1023
|
|
|
1024
1024
|
|
|
@@ -1026,7 +1026,7 @@ Checks and adapts the v2.0 Filter Data Structure to the v2.1
|
|
|
1026
1026
|
##### Returns
|
|
1027
1027
|
|
|
1028
1028
|
|
|
1029
|
-
- A new
|
|
1029
|
+
- A new value array with the filled properties.
|
|
1030
1030
|
|
|
1031
1031
|
|
|
1032
1032
|
|
|
@@ -1669,12 +1669,12 @@ Gets the Scopes IDS for the Available Scope function by any config
|
|
|
1669
1669
|
|
|
1670
1670
|
|
|
1671
1671
|
|
|
1672
|
-
### dist/general/
|
|
1672
|
+
### dist/general/array/delete.js
|
|
1673
1673
|
|
|
1674
1674
|
|
|
1675
|
-
####
|
|
1675
|
+
#### ArrayDelete(array, index)
|
|
1676
1676
|
|
|
1677
|
-
|
|
1677
|
+
Inmutable Array Item deletion
|
|
1678
1678
|
|
|
1679
1679
|
|
|
1680
1680
|
|
|
@@ -1683,8 +1683,8 @@ Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last
|
|
|
1683
1683
|
|
|
1684
1684
|
| Name | Type | Description | |
|
|
1685
1685
|
| ---- | ---- | ----------- | -------- |
|
|
1686
|
-
|
|
|
1687
|
-
|
|
|
1686
|
+
| array | `Array` | a collection of items to delete | |
|
|
1687
|
+
| index | `Number` | the position of the item to delete | |
|
|
1688
1688
|
|
|
1689
1689
|
|
|
1690
1690
|
|
|
@@ -1692,17 +1692,20 @@ Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last
|
|
|
1692
1692
|
##### Returns
|
|
1693
1693
|
|
|
1694
1694
|
|
|
1695
|
-
-
|
|
1695
|
+
- a new Array or the given parameter when is empty or not an array
|
|
1696
1696
|
|
|
1697
1697
|
|
|
1698
1698
|
|
|
1699
1699
|
|
|
1700
|
-
### dist/general/
|
|
1700
|
+
### dist/general/array/filterNestedTree.js
|
|
1701
1701
|
|
|
1702
1702
|
|
|
1703
|
-
####
|
|
1703
|
+
#### filterNestedTree(arr, childArrKey, condition)
|
|
1704
1704
|
|
|
1705
|
-
|
|
1705
|
+
Filters a nested tree array by a custom condition on the last child node
|
|
1706
|
+
- If the given arguments are not valid, the function returns the first argument.
|
|
1707
|
+
- If the childArrKey is not matched in the object, the condition tries to resolve the filter anyway and returns an empty array.
|
|
1708
|
+
- If the condition is not fulfilled, the function returns a filtered array, probably a empty array inside of the child array
|
|
1706
1709
|
|
|
1707
1710
|
|
|
1708
1711
|
|
|
@@ -1711,8 +1714,9 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
|
|
|
1711
1714
|
|
|
1712
1715
|
| Name | Type | Description | |
|
|
1713
1716
|
| ---- | ---- | ----------- | -------- |
|
|
1714
|
-
|
|
|
1715
|
-
|
|
|
1717
|
+
| arr | | nested tree array | |
|
|
1718
|
+
| childArrKey | | property representing the children array on the nested tree | |
|
|
1719
|
+
| condition | | function callback that determines if the filter is applied on the last child node of the nested tree | |
|
|
1716
1720
|
|
|
1717
1721
|
|
|
1718
1722
|
|
|
@@ -1720,17 +1724,17 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
|
|
|
1720
1724
|
##### Returns
|
|
1721
1725
|
|
|
1722
1726
|
|
|
1723
|
-
-
|
|
1727
|
+
- array filtered
|
|
1724
1728
|
|
|
1725
1729
|
|
|
1726
1730
|
|
|
1727
1731
|
|
|
1728
|
-
### dist/general/array/
|
|
1732
|
+
### dist/general/array/flattenDeep.js
|
|
1729
1733
|
|
|
1730
1734
|
|
|
1731
|
-
####
|
|
1735
|
+
#### flattenDeep(arr)
|
|
1732
1736
|
|
|
1733
|
-
|
|
1737
|
+
Flat deeply an array
|
|
1734
1738
|
|
|
1735
1739
|
|
|
1736
1740
|
|
|
@@ -1739,8 +1743,7 @@ Inmutable Array Item deletion
|
|
|
1739
1743
|
|
|
1740
1744
|
| Name | Type | Description | |
|
|
1741
1745
|
| ---- | ---- | ----------- | -------- |
|
|
1742
|
-
|
|
|
1743
|
-
| index | `Number` | the position of the item to delete | |
|
|
1746
|
+
| arr | | Array to flat deeply | |
|
|
1744
1747
|
|
|
1745
1748
|
|
|
1746
1749
|
|
|
@@ -1748,20 +1751,17 @@ Inmutable Array Item deletion
|
|
|
1748
1751
|
##### Returns
|
|
1749
1752
|
|
|
1750
1753
|
|
|
1751
|
-
-
|
|
1754
|
+
- flatten array
|
|
1752
1755
|
|
|
1753
1756
|
|
|
1754
1757
|
|
|
1755
1758
|
|
|
1756
|
-
### dist/general/array/
|
|
1759
|
+
### dist/general/array/getFirstIndexFromArray.js
|
|
1757
1760
|
|
|
1758
1761
|
|
|
1759
|
-
####
|
|
1762
|
+
#### getFirstIndexFromArray(array, callback)
|
|
1760
1763
|
|
|
1761
|
-
|
|
1762
|
-
- If the given arguments are not valid, the function returns the first argument.
|
|
1763
|
-
- If the childArrKey is not matched in the object, the condition tries to resolve the filter anyway and returns an empty array.
|
|
1764
|
-
- If the condition is not fulfilled, the function returns a filtered array, probably a empty array inside of the child array
|
|
1764
|
+
Gets the first index from the array by a callback condition
|
|
1765
1765
|
|
|
1766
1766
|
|
|
1767
1767
|
|
|
@@ -1770,9 +1770,8 @@ Filters a nested tree array by a custom condition on the last child node
|
|
|
1770
1770
|
|
|
1771
1771
|
| Name | Type | Description | |
|
|
1772
1772
|
| ---- | ---- | ----------- | -------- |
|
|
1773
|
-
|
|
|
1774
|
-
|
|
|
1775
|
-
| condition | | function callback that determines if the filter is applied on the last child node of the nested tree | |
|
|
1773
|
+
| array | | | |
|
|
1774
|
+
| callback | | function callback | |
|
|
1776
1775
|
|
|
1777
1776
|
|
|
1778
1777
|
|
|
@@ -1780,17 +1779,17 @@ Filters a nested tree array by a custom condition on the last child node
|
|
|
1780
1779
|
##### Returns
|
|
1781
1780
|
|
|
1782
1781
|
|
|
1783
|
-
- array
|
|
1782
|
+
- the first index of the array. -1 when the condition is not satisfied
|
|
1784
1783
|
|
|
1785
1784
|
|
|
1786
1785
|
|
|
1787
1786
|
|
|
1788
|
-
### dist/general/array/
|
|
1787
|
+
### dist/general/array/getLastIndexFromArray.js
|
|
1789
1788
|
|
|
1790
1789
|
|
|
1791
|
-
####
|
|
1790
|
+
#### getLastIndexFromArray(array, callback)
|
|
1792
1791
|
|
|
1793
|
-
|
|
1792
|
+
Gets the last index from the array by a callback condition
|
|
1794
1793
|
|
|
1795
1794
|
|
|
1796
1795
|
|
|
@@ -1799,7 +1798,8 @@ Flat deeply an array
|
|
|
1799
1798
|
|
|
1800
1799
|
| Name | Type | Description | |
|
|
1801
1800
|
| ---- | ---- | ----------- | -------- |
|
|
1802
|
-
|
|
|
1801
|
+
| array | | | |
|
|
1802
|
+
| callback | | function callback | |
|
|
1803
1803
|
|
|
1804
1804
|
|
|
1805
1805
|
|
|
@@ -1807,17 +1807,17 @@ Flat deeply an array
|
|
|
1807
1807
|
##### Returns
|
|
1808
1808
|
|
|
1809
1809
|
|
|
1810
|
-
-
|
|
1810
|
+
- the last index of the array. -1 when the condition is not satisfied
|
|
1811
1811
|
|
|
1812
1812
|
|
|
1813
1813
|
|
|
1814
1814
|
|
|
1815
|
-
### dist/general/
|
|
1815
|
+
### dist/general/function/debounce.js
|
|
1816
1816
|
|
|
1817
1817
|
|
|
1818
|
-
####
|
|
1818
|
+
#### debounce(fn, time)
|
|
1819
1819
|
|
|
1820
|
-
|
|
1820
|
+
Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last time the debounced function was invoked.
|
|
1821
1821
|
|
|
1822
1822
|
|
|
1823
1823
|
|
|
@@ -1826,8 +1826,8 @@ Gets the first index from the array by a callback condition
|
|
|
1826
1826
|
|
|
1827
1827
|
| Name | Type | Description | |
|
|
1828
1828
|
| ---- | ---- | ----------- | -------- |
|
|
1829
|
-
|
|
|
1830
|
-
|
|
|
1829
|
+
| fn | `Function` | original Function | |
|
|
1830
|
+
| time | `Number` | default 500ms | |
|
|
1831
1831
|
|
|
1832
1832
|
|
|
1833
1833
|
|
|
@@ -1835,17 +1835,17 @@ Gets the first index from the array by a callback condition
|
|
|
1835
1835
|
##### Returns
|
|
1836
1836
|
|
|
1837
1837
|
|
|
1838
|
-
-
|
|
1838
|
+
- `Function` debounced functions
|
|
1839
1839
|
|
|
1840
1840
|
|
|
1841
1841
|
|
|
1842
1842
|
|
|
1843
|
-
### dist/general/
|
|
1843
|
+
### dist/general/function/throttled.js
|
|
1844
1844
|
|
|
1845
1845
|
|
|
1846
|
-
####
|
|
1846
|
+
#### throttled(fn, time)
|
|
1847
1847
|
|
|
1848
|
-
|
|
1848
|
+
Make sure to only invokes _fn_ at most once per every _time_ milliseconds
|
|
1849
1849
|
|
|
1850
1850
|
|
|
1851
1851
|
|
|
@@ -1854,8 +1854,8 @@ Gets the last index from the array by a callback condition
|
|
|
1854
1854
|
|
|
1855
1855
|
| Name | Type | Description | |
|
|
1856
1856
|
| ---- | ---- | ----------- | -------- |
|
|
1857
|
-
|
|
|
1858
|
-
|
|
|
1857
|
+
| fn | `Function` | original Function | |
|
|
1858
|
+
| time | `Number` | default 500ms | |
|
|
1859
1859
|
|
|
1860
1860
|
|
|
1861
1861
|
|
|
@@ -1863,7 +1863,7 @@ Gets the last index from the array by a callback condition
|
|
|
1863
1863
|
##### Returns
|
|
1864
1864
|
|
|
1865
1865
|
|
|
1866
|
-
-
|
|
1866
|
+
- `Function` throttled function
|
|
1867
1867
|
|
|
1868
1868
|
|
|
1869
1869
|
|
|
@@ -2722,47 +2722,50 @@ Gets the format config
|
|
|
2722
2722
|
|
|
2723
2723
|
|
|
2724
2724
|
|
|
2725
|
-
### dist/
|
|
2726
|
-
|
|
2725
|
+
### dist/services/api/getAllDatasets.api.js
|
|
2727
2726
|
|
|
2728
|
-
#### Config()
|
|
2729
2727
|
|
|
2730
|
-
|
|
2731
|
-
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
|
|
2732
|
-
But for this, is required ask for a property in `snake_case` style
|
|
2728
|
+
#### getAllDatasets(config, pickDatasets)
|
|
2733
2729
|
|
|
2730
|
+
Get a dataset list from a collection of Qrvey IDs
|
|
2734
2731
|
|
|
2735
2732
|
|
|
2736
2733
|
|
|
2737
2734
|
|
|
2735
|
+
##### Parameters
|
|
2738
2736
|
|
|
2739
|
-
|
|
2737
|
+
| Name | Type | Description | |
|
|
2738
|
+
| ---- | ---- | ----------- | -------- |
|
|
2739
|
+
| config | | the widget config. Includes the appid and others configuration properties | |
|
|
2740
|
+
| pickDatasets | | Collection of Qrvey IDs for filtering the request | |
|
|
2740
2741
|
|
|
2741
|
-
```javascript
|
|
2742
|
-
\ @Config() @Prop() settings;
|
|
2743
2742
|
|
|
2744
|
-
someMethod() {
|
|
2745
|
-
this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
|
|
2746
|
-
}
|
|
2747
|
-
```
|
|
2748
2743
|
|
|
2749
2744
|
|
|
2750
2745
|
##### Returns
|
|
2751
2746
|
|
|
2752
2747
|
|
|
2753
|
-
-
|
|
2748
|
+
- a promise
|
|
2754
2749
|
|
|
2755
2750
|
|
|
2756
2751
|
|
|
2757
2752
|
|
|
2758
|
-
### dist/
|
|
2753
|
+
### dist/services/api/getAllQrveys.api.js
|
|
2754
|
+
|
|
2755
|
+
|
|
2756
|
+
#### getAllQrveys(config, params)
|
|
2757
|
+
|
|
2758
|
+
POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
|
|
2759
2759
|
|
|
2760
2760
|
|
|
2761
|
-
#### createRef()
|
|
2762
2761
|
|
|
2763
|
-
lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
|
|
2764
2762
|
|
|
2763
|
+
##### Parameters
|
|
2765
2764
|
|
|
2765
|
+
| Name | Type | Description | |
|
|
2766
|
+
| ---- | ---- | ----------- | -------- |
|
|
2767
|
+
| config | | Configuration | |
|
|
2768
|
+
| params | | Object for getting precise data | |
|
|
2766
2769
|
|
|
2767
2770
|
|
|
2768
2771
|
|
|
@@ -2770,21 +2773,17 @@ lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom
|
|
|
2770
2773
|
##### Returns
|
|
2771
2774
|
|
|
2772
2775
|
|
|
2773
|
-
-
|
|
2776
|
+
- `Void`
|
|
2774
2777
|
|
|
2775
2778
|
|
|
2776
2779
|
|
|
2777
2780
|
|
|
2778
|
-
### dist/
|
|
2781
|
+
### dist/services/api/getDatasetColumns.api.js
|
|
2779
2782
|
|
|
2780
2783
|
|
|
2781
|
-
####
|
|
2784
|
+
#### getDatasetColumns(qrveyid)
|
|
2782
2785
|
|
|
2783
|
-
|
|
2784
|
-
- In case _cfg_ is a string, first try to make a JSON parse in other case
|
|
2785
|
-
try to find this string as a variable on Windows object
|
|
2786
|
-
- If _cfg_ is a fuction, tis is invoked and parsed
|
|
2787
|
-
- Finally, if is an object, _cfg_ is inmediatly returned
|
|
2786
|
+
Get a dataset by Qrvey ID
|
|
2788
2787
|
|
|
2789
2788
|
|
|
2790
2789
|
|
|
@@ -2793,7 +2792,7 @@ try to find this string as a variable on Windows object
|
|
|
2793
2792
|
|
|
2794
2793
|
| Name | Type | Description | |
|
|
2795
2794
|
| ---- | ---- | ----------- | -------- |
|
|
2796
|
-
|
|
|
2795
|
+
| qrveyid | | The Qrvey ID | |
|
|
2797
2796
|
|
|
2798
2797
|
|
|
2799
2798
|
|
|
@@ -2801,55 +2800,52 @@ try to find this string as a variable on Windows object
|
|
|
2801
2800
|
##### Returns
|
|
2802
2801
|
|
|
2803
2802
|
|
|
2804
|
-
-
|
|
2805
|
-
|
|
2806
|
-
|
|
2803
|
+
- a promise
|
|
2807
2804
|
|
|
2808
2805
|
|
|
2809
|
-
### dist/services/api/getAllDatasets.api.js
|
|
2810
2806
|
|
|
2811
2807
|
|
|
2812
|
-
|
|
2808
|
+
### dist/stencil/decorators/Config.js
|
|
2813
2809
|
|
|
2814
|
-
Get a dataset list from a collection of Qrvey IDs
|
|
2815
2810
|
|
|
2811
|
+
#### Config()
|
|
2816
2812
|
|
|
2813
|
+
Stencil.js - Prop Decorator
|
|
2814
|
+
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
|
|
2815
|
+
But for this, is required ask for a property in `snake_case` style
|
|
2817
2816
|
|
|
2818
2817
|
|
|
2819
|
-
##### Parameters
|
|
2820
2818
|
|
|
2821
|
-
| Name | Type | Description | |
|
|
2822
|
-
| ---- | ---- | ----------- | -------- |
|
|
2823
|
-
| config | | the widget config. Includes the appid and others configuration properties | |
|
|
2824
|
-
| pickDatasets | | Collection of Qrvey IDs for filtering the request | |
|
|
2825
2819
|
|
|
2826
2820
|
|
|
2827
2821
|
|
|
2822
|
+
##### Examples
|
|
2828
2823
|
|
|
2829
|
-
|
|
2824
|
+
```javascript
|
|
2825
|
+
\ @Config() @Prop() settings;
|
|
2830
2826
|
|
|
2827
|
+
someMethod() {
|
|
2828
|
+
this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
|
|
2829
|
+
}
|
|
2830
|
+
```
|
|
2831
2831
|
|
|
2832
|
-
- a promise
|
|
2833
2832
|
|
|
2833
|
+
##### Returns
|
|
2834
2834
|
|
|
2835
2835
|
|
|
2836
|
+
- `Void`
|
|
2836
2837
|
|
|
2837
|
-
### dist/services/api/getAllQrveys.api.js
|
|
2838
2838
|
|
|
2839
2839
|
|
|
2840
|
-
#### getAllQrveys(config, params)
|
|
2841
2840
|
|
|
2842
|
-
|
|
2841
|
+
### dist/stencil/util/createRef.js
|
|
2843
2842
|
|
|
2844
2843
|
|
|
2844
|
+
#### createRef()
|
|
2845
2845
|
|
|
2846
|
+
lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
|
|
2846
2847
|
|
|
2847
|
-
##### Parameters
|
|
2848
2848
|
|
|
2849
|
-
| Name | Type | Description | |
|
|
2850
|
-
| ---- | ---- | ----------- | -------- |
|
|
2851
|
-
| config | | Configuration | |
|
|
2852
|
-
| params | | Object for getting precise data | |
|
|
2853
2849
|
|
|
2854
2850
|
|
|
2855
2851
|
|
|
@@ -2857,17 +2853,21 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
|
|
|
2857
2853
|
##### Returns
|
|
2858
2854
|
|
|
2859
2855
|
|
|
2860
|
-
-
|
|
2856
|
+
- function - Function to use in ref prop in html elements
|
|
2861
2857
|
|
|
2862
2858
|
|
|
2863
2859
|
|
|
2864
2860
|
|
|
2865
|
-
### dist/
|
|
2861
|
+
### dist/stencil/util/getConfig.js
|
|
2866
2862
|
|
|
2867
2863
|
|
|
2868
|
-
####
|
|
2864
|
+
#### getConfig(cfg)
|
|
2869
2865
|
|
|
2870
|
-
|
|
2866
|
+
verify the Config object type and try to return a parsed Object
|
|
2867
|
+
- In case _cfg_ is a string, first try to make a JSON parse in other case
|
|
2868
|
+
try to find this string as a variable on Windows object
|
|
2869
|
+
- If _cfg_ is a fuction, tis is invoked and parsed
|
|
2870
|
+
- Finally, if is an object, _cfg_ is inmediatly returned
|
|
2871
2871
|
|
|
2872
2872
|
|
|
2873
2873
|
|
|
@@ -2876,7 +2876,7 @@ Get a dataset by Qrvey ID
|
|
|
2876
2876
|
|
|
2877
2877
|
| Name | Type | Description | |
|
|
2878
2878
|
| ---- | ---- | ----------- | -------- |
|
|
2879
|
-
|
|
|
2879
|
+
| cfg | | | |
|
|
2880
2880
|
|
|
2881
2881
|
|
|
2882
2882
|
|
|
@@ -2884,17 +2884,17 @@ Get a dataset by Qrvey ID
|
|
|
2884
2884
|
##### Returns
|
|
2885
2885
|
|
|
2886
2886
|
|
|
2887
|
-
-
|
|
2887
|
+
- `Void`
|
|
2888
2888
|
|
|
2889
2889
|
|
|
2890
2890
|
|
|
2891
2891
|
|
|
2892
|
-
### dist/typescript/decorators/
|
|
2892
|
+
### dist/typescript/decorators/Throttled.js
|
|
2893
2893
|
|
|
2894
2894
|
|
|
2895
|
-
####
|
|
2895
|
+
#### Throttled(time)
|
|
2896
2896
|
|
|
2897
|
-
(Method Decorator)
|
|
2897
|
+
(Method Decorator) Throttled Class Method
|
|
2898
2898
|
|
|
2899
2899
|
|
|
2900
2900
|
|
|
@@ -2916,12 +2916,12 @@ Get a dataset by Qrvey ID
|
|
|
2916
2916
|
|
|
2917
2917
|
|
|
2918
2918
|
|
|
2919
|
-
### dist/typescript/decorators/
|
|
2919
|
+
### dist/typescript/decorators/Debounce.js
|
|
2920
2920
|
|
|
2921
2921
|
|
|
2922
|
-
####
|
|
2922
|
+
#### Debounce(time)
|
|
2923
2923
|
|
|
2924
|
-
(Method Decorator)
|
|
2924
|
+
(Method Decorator) Debounce Class Method
|
|
2925
2925
|
|
|
2926
2926
|
|
|
2927
2927
|
|
|
@@ -3052,12 +3052,13 @@ Returns a filter builder config object by a any given config
|
|
|
3052
3052
|
|
|
3053
3053
|
|
|
3054
3054
|
|
|
3055
|
-
### dist/filters/helpers/
|
|
3055
|
+
### dist/filters/helpers/backend/buildExpression.js
|
|
3056
3056
|
|
|
3057
3057
|
|
|
3058
|
-
####
|
|
3058
|
+
#### buildExpression(filter)
|
|
3059
3059
|
|
|
3060
|
-
|
|
3060
|
+
Builds filter expression by the filter data.
|
|
3061
|
+
- If the resulting value array is empty the enabled property will be false.
|
|
3061
3062
|
|
|
3062
3063
|
|
|
3063
3064
|
|
|
@@ -3066,8 +3067,7 @@ Validates if both filters are the same
|
|
|
3066
3067
|
|
|
3067
3068
|
| Name | Type | Description | |
|
|
3068
3069
|
| ---- | ---- | ----------- | -------- |
|
|
3069
|
-
|
|
|
3070
|
-
| filter2 | | filter 2 | |
|
|
3070
|
+
| filter | | The filter to transform | |
|
|
3071
3071
|
|
|
3072
3072
|
|
|
3073
3073
|
|
|
@@ -3075,17 +3075,17 @@ Validates if both filters are the same
|
|
|
3075
3075
|
##### Returns
|
|
3076
3076
|
|
|
3077
3077
|
|
|
3078
|
-
-
|
|
3078
|
+
- a filter expression
|
|
3079
3079
|
|
|
3080
3080
|
|
|
3081
3081
|
|
|
3082
3082
|
|
|
3083
|
-
### dist/filters/helpers/
|
|
3083
|
+
### dist/filters/helpers/backend/buildUserFilters.js
|
|
3084
3084
|
|
|
3085
3085
|
|
|
3086
|
-
####
|
|
3086
|
+
#### buildUserFilters(userFilters)
|
|
3087
3087
|
|
|
3088
|
-
|
|
3088
|
+
Transform user Filters array into Filter Logic structure
|
|
3089
3089
|
|
|
3090
3090
|
|
|
3091
3091
|
|
|
@@ -3094,7 +3094,7 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
|
|
|
3094
3094
|
|
|
3095
3095
|
| Name | Type | Description | |
|
|
3096
3096
|
| ---- | ---- | ----------- | -------- |
|
|
3097
|
-
|
|
|
3097
|
+
| userFilters | | The filters that the user defined. | |
|
|
3098
3098
|
|
|
3099
3099
|
|
|
3100
3100
|
|
|
@@ -3102,26 +3102,17 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
|
|
|
3102
3102
|
##### Returns
|
|
3103
3103
|
|
|
3104
3104
|
|
|
3105
|
-
- The
|
|
3105
|
+
- The filter logic for the given user filters. if No a given object is recieved, it will return an empty array.
|
|
3106
3106
|
|
|
3107
3107
|
|
|
3108
3108
|
|
|
3109
3109
|
|
|
3110
|
-
### dist/filters/helpers/
|
|
3110
|
+
### dist/filters/helpers/backend/getAggFiltersBySummaryIndex.js
|
|
3111
3111
|
|
|
3112
3112
|
|
|
3113
|
-
####
|
|
3113
|
+
#### getAggFiltersBySummaryIndex(aggFilters, summaryIndex)
|
|
3114
|
+
|
|
3114
3115
|
|
|
3115
|
-
Excludes filters from the given Filters.
|
|
3116
|
-
The validation to filter the stored filter is depending on:
|
|
3117
|
-
- Column
|
|
3118
|
-
- Qrvey ID
|
|
3119
|
-
- Scope type
|
|
3120
|
-
- Scope ID
|
|
3121
|
-
- Panel ID
|
|
3122
|
-
- Validator type
|
|
3123
|
-
- Property type
|
|
3124
|
-
- Enabled flags
|
|
3125
3116
|
|
|
3126
3117
|
|
|
3127
3118
|
|
|
@@ -3130,8 +3121,8 @@ The validation to filter the stored filter is depending on:
|
|
|
3130
3121
|
|
|
3131
3122
|
| Name | Type | Description | |
|
|
3132
3123
|
| ---- | ---- | ----------- | -------- |
|
|
3133
|
-
|
|
|
3134
|
-
|
|
|
3124
|
+
| aggFilters | | | |
|
|
3125
|
+
| summaryIndex | | | |
|
|
3135
3126
|
|
|
3136
3127
|
|
|
3137
3128
|
|
|
@@ -3139,17 +3130,17 @@ The validation to filter the stored filter is depending on:
|
|
|
3139
3130
|
##### Returns
|
|
3140
3131
|
|
|
3141
3132
|
|
|
3142
|
-
-
|
|
3133
|
+
-
|
|
3143
3134
|
|
|
3144
3135
|
|
|
3145
3136
|
|
|
3146
3137
|
|
|
3147
|
-
### dist/filters/helpers/
|
|
3138
|
+
### dist/filters/helpers/backend/getBackendGroupValue.js
|
|
3148
3139
|
|
|
3149
3140
|
|
|
3150
|
-
####
|
|
3141
|
+
#### getBackendGroupValue(filter)
|
|
3151
3142
|
|
|
3152
|
-
|
|
3143
|
+
Gets a group value for the backend logic structure
|
|
3153
3144
|
|
|
3154
3145
|
|
|
3155
3146
|
|
|
@@ -3158,8 +3149,7 @@ Excludes and returns a filter data without filters by the given scopes
|
|
|
3158
3149
|
|
|
3159
3150
|
| Name | Type | Description | |
|
|
3160
3151
|
| ---- | ---- | ----------- | -------- |
|
|
3161
|
-
|
|
|
3162
|
-
| scopes | | collection of scopes to be as filtering parameters | |
|
|
3152
|
+
| filter | | The filter | |
|
|
3163
3153
|
|
|
3164
3154
|
|
|
3165
3155
|
|
|
@@ -3167,17 +3157,17 @@ Excludes and returns a filter data without filters by the given scopes
|
|
|
3167
3157
|
##### Returns
|
|
3168
3158
|
|
|
3169
3159
|
|
|
3170
|
-
-
|
|
3160
|
+
- a property
|
|
3171
3161
|
|
|
3172
3162
|
|
|
3173
3163
|
|
|
3174
3164
|
|
|
3175
|
-
### dist/filters/helpers/
|
|
3165
|
+
### dist/filters/helpers/backend/getBackendProperty.js
|
|
3176
3166
|
|
|
3177
3167
|
|
|
3178
|
-
####
|
|
3168
|
+
#### getBackendProperty(filter)
|
|
3179
3169
|
|
|
3180
|
-
|
|
3170
|
+
Gets a property for the logic structure
|
|
3181
3171
|
|
|
3182
3172
|
|
|
3183
3173
|
|
|
@@ -3186,7 +3176,7 @@ Get an string of the properties of the given filter column.
|
|
|
3186
3176
|
|
|
3187
3177
|
| Name | Type | Description | |
|
|
3188
3178
|
| ---- | ---- | ----------- | -------- |
|
|
3189
|
-
|
|
|
3179
|
+
| filter | | The filter | |
|
|
3190
3180
|
|
|
3191
3181
|
|
|
3192
3182
|
|
|
@@ -3194,17 +3184,17 @@ Get an string of the properties of the given filter column.
|
|
|
3194
3184
|
##### Returns
|
|
3195
3185
|
|
|
3196
3186
|
|
|
3197
|
-
-
|
|
3187
|
+
- a property
|
|
3198
3188
|
|
|
3199
3189
|
|
|
3200
3190
|
|
|
3201
3191
|
|
|
3202
|
-
### dist/filters/helpers/
|
|
3192
|
+
### dist/filters/helpers/backend/getBackendValidator.js
|
|
3203
3193
|
|
|
3204
3194
|
|
|
3205
|
-
####
|
|
3195
|
+
#### getBackendValidator(validator)
|
|
3206
3196
|
|
|
3207
|
-
Gets the
|
|
3197
|
+
Gets the Validator that is used in requests
|
|
3208
3198
|
|
|
3209
3199
|
|
|
3210
3200
|
|
|
@@ -3213,7 +3203,7 @@ Gets the Filter Label + Column label
|
|
|
3213
3203
|
|
|
3214
3204
|
| Name | Type | Description | |
|
|
3215
3205
|
| ---- | ---- | ----------- | -------- |
|
|
3216
|
-
|
|
|
3206
|
+
| validator | | Filter Validator used in UI | |
|
|
3217
3207
|
|
|
3218
3208
|
|
|
3219
3209
|
|
|
@@ -3221,28 +3211,17 @@ Gets the Filter Label + Column label
|
|
|
3221
3211
|
##### Returns
|
|
3222
3212
|
|
|
3223
3213
|
|
|
3224
|
-
-
|
|
3214
|
+
- Filter Validator used in Backend
|
|
3225
3215
|
|
|
3226
3216
|
|
|
3227
3217
|
|
|
3228
3218
|
|
|
3229
|
-
### dist/filters/helpers/
|
|
3219
|
+
### dist/filters/helpers/backend/getBackendValues.js
|
|
3230
3220
|
|
|
3231
3221
|
|
|
3232
|
-
####
|
|
3222
|
+
#### getBackendValues(filter)
|
|
3233
3223
|
|
|
3234
|
-
|
|
3235
|
-
The order of the epression ID is:
|
|
3236
|
-
- Scope Type
|
|
3237
|
-
- scopeid
|
|
3238
|
-
- qrveyid
|
|
3239
|
-
- panelid
|
|
3240
|
-
- columnid
|
|
3241
|
-
- validator
|
|
3242
|
-
- property
|
|
3243
|
-
- Column Aggregate
|
|
3244
|
-
- Column Calculation
|
|
3245
|
-
- Optional Index
|
|
3224
|
+
Gets the expresion values in the logic format
|
|
3246
3225
|
|
|
3247
3226
|
|
|
3248
3227
|
|
|
@@ -3251,7 +3230,7 @@ The order of the epression ID is:
|
|
|
3251
3230
|
|
|
3252
3231
|
| Name | Type | Description | |
|
|
3253
3232
|
| ---- | ---- | ----------- | -------- |
|
|
3254
|
-
| filter | |
|
|
3233
|
+
| filter | | The filter structure | |
|
|
3255
3234
|
|
|
3256
3235
|
|
|
3257
3236
|
|
|
@@ -3259,17 +3238,13 @@ The order of the epression ID is:
|
|
|
3259
3238
|
##### Returns
|
|
3260
3239
|
|
|
3261
3240
|
|
|
3262
|
-
-
|
|
3263
|
-
|
|
3264
|
-
|
|
3265
|
-
|
|
3241
|
+
- A collection of backend expression value
|
|
3266
3242
|
|
|
3267
|
-
### dist/filters/helpers/common/getFiltersByAggregateColumn.js
|
|
3268
3243
|
|
|
3269
3244
|
|
|
3270
|
-
####
|
|
3245
|
+
#### getResultValues(values, filter)
|
|
3271
3246
|
|
|
3272
|
-
Gets
|
|
3247
|
+
Gets the expression values. Depending on the column type
|
|
3273
3248
|
|
|
3274
3249
|
|
|
3275
3250
|
|
|
@@ -3278,7 +3253,8 @@ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggr
|
|
|
3278
3253
|
|
|
3279
3254
|
| Name | Type | Description | |
|
|
3280
3255
|
| ---- | ---- | ----------- | -------- |
|
|
3281
|
-
|
|
|
3256
|
+
| values | | a collection of filter values | |
|
|
3257
|
+
| filter | | The filter structure | |
|
|
3282
3258
|
|
|
3283
3259
|
|
|
3284
3260
|
|
|
@@ -3286,17 +3262,13 @@ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggr
|
|
|
3286
3262
|
##### Returns
|
|
3287
3263
|
|
|
3288
3264
|
|
|
3289
|
-
-
|
|
3290
|
-
|
|
3291
|
-
|
|
3292
|
-
|
|
3265
|
+
-
|
|
3293
3266
|
|
|
3294
|
-
### dist/filters/helpers/common/getFiltersByScopes.js
|
|
3295
3267
|
|
|
3296
3268
|
|
|
3297
|
-
####
|
|
3269
|
+
#### getRankingValues(values, rankingGroupIndex)
|
|
3298
3270
|
|
|
3299
|
-
|
|
3271
|
+
Gets the Ranking values.
|
|
3300
3272
|
|
|
3301
3273
|
|
|
3302
3274
|
|
|
@@ -3305,8 +3277,8 @@ Filters and gets a Filter Data by the given scopes
|
|
|
3305
3277
|
|
|
3306
3278
|
| Name | Type | Description | |
|
|
3307
3279
|
| ---- | ---- | ----------- | -------- |
|
|
3308
|
-
|
|
|
3309
|
-
|
|
|
3280
|
+
| values | | a collection of filter values in the ranking structure | |
|
|
3281
|
+
| rankingGroupIndex | | determine the value by this index to build and return it | |
|
|
3310
3282
|
|
|
3311
3283
|
|
|
3312
3284
|
|
|
@@ -3314,26 +3286,17 @@ Filters and gets a Filter Data by the given scopes
|
|
|
3314
3286
|
##### Returns
|
|
3315
3287
|
|
|
3316
3288
|
|
|
3317
|
-
-
|
|
3289
|
+
- Expression values for ranking
|
|
3318
3290
|
|
|
3319
3291
|
|
|
3320
3292
|
|
|
3321
3293
|
|
|
3322
|
-
### dist/filters/helpers/
|
|
3294
|
+
### dist/filters/helpers/backend/getLogicByScopes.js
|
|
3323
3295
|
|
|
3324
3296
|
|
|
3325
|
-
####
|
|
3297
|
+
#### getLogicByScopes(logics, scopes)
|
|
3326
3298
|
|
|
3327
|
-
Gets filters from
|
|
3328
|
-
The validation to filter the stored filter is depending on:
|
|
3329
|
-
- Column
|
|
3330
|
-
- Qrvey ID
|
|
3331
|
-
- Scope type
|
|
3332
|
-
- Scope ID
|
|
3333
|
-
- Panel ID
|
|
3334
|
-
- Validator type
|
|
3335
|
-
- Property type
|
|
3336
|
-
- Enabled flags
|
|
3299
|
+
Gets the filters from logic data by Scopes/Scope IDs.
|
|
3337
3300
|
|
|
3338
3301
|
|
|
3339
3302
|
|
|
@@ -3342,8 +3305,8 @@ The validation to filter the stored filter is depending on:
|
|
|
3342
3305
|
|
|
3343
3306
|
| Name | Type | Description | |
|
|
3344
3307
|
| ---- | ---- | ----------- | -------- |
|
|
3345
|
-
|
|
|
3346
|
-
|
|
|
3308
|
+
| logics | | The logic array | |
|
|
3309
|
+
| scopes | | The collection of Scopes/Scope IDs | |
|
|
3347
3310
|
|
|
3348
3311
|
|
|
3349
3312
|
|
|
@@ -3351,17 +3314,17 @@ The validation to filter the stored filter is depending on:
|
|
|
3351
3314
|
##### Returns
|
|
3352
3315
|
|
|
3353
3316
|
|
|
3354
|
-
- a new
|
|
3317
|
+
- a new Logic array
|
|
3355
3318
|
|
|
3356
3319
|
|
|
3357
3320
|
|
|
3358
3321
|
|
|
3359
|
-
### dist/filters/helpers/
|
|
3322
|
+
### dist/filters/helpers/backend/getLogicByScopesHierarchy.js
|
|
3360
3323
|
|
|
3361
3324
|
|
|
3362
|
-
####
|
|
3325
|
+
#### getLogicByScopesHierarchy(filterData, scopes, currentScope)
|
|
3363
3326
|
|
|
3364
|
-
Gets filters from
|
|
3327
|
+
Gets filters from the logic by the scopes hierarchy.
|
|
3365
3328
|
|
|
3366
3329
|
|
|
3367
3330
|
|
|
@@ -3370,8 +3333,9 @@ Gets filters from Filter Data by Scopes/Scope IDs.
|
|
|
3370
3333
|
|
|
3371
3334
|
| Name | Type | Description | |
|
|
3372
3335
|
| ---- | ---- | ----------- | -------- |
|
|
3373
|
-
| filterData | |
|
|
3374
|
-
| scopes | |
|
|
3336
|
+
| filterData | | | |
|
|
3337
|
+
| scopes | | | |
|
|
3338
|
+
| currentScope | | | |
|
|
3375
3339
|
|
|
3376
3340
|
|
|
3377
3341
|
|
|
@@ -3379,17 +3343,17 @@ Gets filters from Filter Data by Scopes/Scope IDs.
|
|
|
3379
3343
|
##### Returns
|
|
3380
3344
|
|
|
3381
3345
|
|
|
3382
|
-
- a new
|
|
3346
|
+
- a new array of Logic
|
|
3383
3347
|
|
|
3384
3348
|
|
|
3385
3349
|
|
|
3386
3350
|
|
|
3387
|
-
### dist/filters/helpers/common/
|
|
3351
|
+
### dist/filters/helpers/common/areFiltersEquals.js
|
|
3388
3352
|
|
|
3389
3353
|
|
|
3390
|
-
####
|
|
3354
|
+
#### areFiltersEquals(filter1, filter2)
|
|
3391
3355
|
|
|
3392
|
-
|
|
3356
|
+
Validates if both filters are the same
|
|
3393
3357
|
|
|
3394
3358
|
|
|
3395
3359
|
|
|
@@ -3398,8 +3362,8 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
|
|
|
3398
3362
|
|
|
3399
3363
|
| Name | Type | Description | |
|
|
3400
3364
|
| ---- | ---- | ----------- | -------- |
|
|
3401
|
-
|
|
|
3402
|
-
|
|
|
3365
|
+
| filter1 | | filter 1 | |
|
|
3366
|
+
| filter2 | | filter 2 | |
|
|
3403
3367
|
|
|
3404
3368
|
|
|
3405
3369
|
|
|
@@ -3407,17 +3371,17 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
|
|
|
3407
3371
|
##### Returns
|
|
3408
3372
|
|
|
3409
3373
|
|
|
3410
|
-
-
|
|
3374
|
+
- true: the filters are equal; false: the filters are NOT equal
|
|
3411
3375
|
|
|
3412
3376
|
|
|
3413
3377
|
|
|
3414
3378
|
|
|
3415
|
-
### dist/filters/helpers/common/
|
|
3379
|
+
### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
|
|
3416
3380
|
|
|
3417
3381
|
|
|
3418
|
-
####
|
|
3382
|
+
#### excludeFiltersByAggregateColumn(filterData)
|
|
3419
3383
|
|
|
3420
|
-
|
|
3384
|
+
Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
|
|
3421
3385
|
|
|
3422
3386
|
|
|
3423
3387
|
|
|
@@ -3426,7 +3390,7 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
|
|
|
3426
3390
|
|
|
3427
3391
|
| Name | Type | Description | |
|
|
3428
3392
|
| ---- | ---- | ----------- | -------- |
|
|
3429
|
-
|
|
|
3393
|
+
| filterData | | The filter data object | |
|
|
3430
3394
|
|
|
3431
3395
|
|
|
3432
3396
|
|
|
@@ -3434,17 +3398,26 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
|
|
|
3434
3398
|
##### Returns
|
|
3435
3399
|
|
|
3436
3400
|
|
|
3437
|
-
-
|
|
3401
|
+
- The new filter data object that were excluded the aggregate filters
|
|
3438
3402
|
|
|
3439
3403
|
|
|
3440
3404
|
|
|
3441
3405
|
|
|
3442
|
-
### dist/filters/helpers/common/
|
|
3406
|
+
### dist/filters/helpers/common/excludeFiltersByParams.js
|
|
3443
3407
|
|
|
3444
3408
|
|
|
3445
|
-
####
|
|
3409
|
+
#### excludeFiltersByParams(filterData, params)
|
|
3446
3410
|
|
|
3447
|
-
|
|
3411
|
+
Excludes filters from the given Filters.
|
|
3412
|
+
The validation to filter the stored filter is depending on:
|
|
3413
|
+
- Column
|
|
3414
|
+
- Qrvey ID
|
|
3415
|
+
- Scope type
|
|
3416
|
+
- Scope ID
|
|
3417
|
+
- Panel ID
|
|
3418
|
+
- Validator type
|
|
3419
|
+
- Property type
|
|
3420
|
+
- Enabled flags
|
|
3448
3421
|
|
|
3449
3422
|
|
|
3450
3423
|
|
|
@@ -3453,7 +3426,8 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
|
|
|
3453
3426
|
|
|
3454
3427
|
| Name | Type | Description | |
|
|
3455
3428
|
| ---- | ---- | ----------- | -------- |
|
|
3456
|
-
|
|
|
3429
|
+
| filterData | | The Filter Data or the UI Filter Data | |
|
|
3430
|
+
| params | | given parameters to validate the filter data | |
|
|
3457
3431
|
|
|
3458
3432
|
|
|
3459
3433
|
|
|
@@ -3461,17 +3435,17 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
|
|
|
3461
3435
|
##### Returns
|
|
3462
3436
|
|
|
3463
3437
|
|
|
3464
|
-
- a new
|
|
3438
|
+
- a new Filter object structure
|
|
3465
3439
|
|
|
3466
3440
|
|
|
3467
3441
|
|
|
3468
3442
|
|
|
3469
|
-
### dist/filters/helpers/common/
|
|
3443
|
+
### dist/filters/helpers/common/excludeFiltersByScopes.js
|
|
3470
3444
|
|
|
3471
3445
|
|
|
3472
|
-
####
|
|
3446
|
+
#### excludeFiltersByScopes(filterData, scopes)
|
|
3473
3447
|
|
|
3474
|
-
|
|
3448
|
+
Excludes and returns a filter data without filters by the given scopes
|
|
3475
3449
|
|
|
3476
3450
|
|
|
3477
3451
|
|
|
@@ -3480,8 +3454,8 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
|
|
|
3480
3454
|
|
|
3481
3455
|
| Name | Type | Description | |
|
|
3482
3456
|
| ---- | ---- | ----------- | -------- |
|
|
3483
|
-
| filterData | |
|
|
3484
|
-
|
|
|
3457
|
+
| filterData | | The Filter Data | |
|
|
3458
|
+
| scopes | | collection of scopes to be as filtering parameters | |
|
|
3485
3459
|
|
|
3486
3460
|
|
|
3487
3461
|
|
|
@@ -3489,17 +3463,17 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
|
|
|
3489
3463
|
##### Returns
|
|
3490
3464
|
|
|
3491
3465
|
|
|
3492
|
-
-
|
|
3466
|
+
- The new Filter Data without filters by the given scopes.
|
|
3493
3467
|
|
|
3494
3468
|
|
|
3495
3469
|
|
|
3496
3470
|
|
|
3497
|
-
### dist/filters/helpers/common/
|
|
3471
|
+
### dist/filters/helpers/common/getFilterColumnLabel.js
|
|
3498
3472
|
|
|
3499
3473
|
|
|
3500
|
-
####
|
|
3474
|
+
#### getFilterColumnLabel(column)
|
|
3501
3475
|
|
|
3502
|
-
|
|
3476
|
+
Get an string of the properties of the given filter column.
|
|
3503
3477
|
|
|
3504
3478
|
|
|
3505
3479
|
|
|
@@ -3508,7 +3482,7 @@ Validates if the given validator is a Between type
|
|
|
3508
3482
|
|
|
3509
3483
|
| Name | Type | Description | |
|
|
3510
3484
|
| ---- | ---- | ----------- | -------- |
|
|
3511
|
-
|
|
|
3485
|
+
| column | | The filter column | |
|
|
3512
3486
|
|
|
3513
3487
|
|
|
3514
3488
|
|
|
@@ -3516,17 +3490,28 @@ Validates if the given validator is a Between type
|
|
|
3516
3490
|
##### Returns
|
|
3517
3491
|
|
|
3518
3492
|
|
|
3519
|
-
-
|
|
3493
|
+
- an string with the property, aggregate or calculation label.
|
|
3520
3494
|
|
|
3521
3495
|
|
|
3522
3496
|
|
|
3523
3497
|
|
|
3524
|
-
### dist/filters/helpers/common/
|
|
3498
|
+
### dist/filters/helpers/common/getFilterid.js
|
|
3525
3499
|
|
|
3526
3500
|
|
|
3527
|
-
####
|
|
3501
|
+
#### getFilterid(filter)
|
|
3528
3502
|
|
|
3529
|
-
|
|
3503
|
+
Get the Filter ID by the filter structure
|
|
3504
|
+
The order of the epression ID is:
|
|
3505
|
+
- Scope Type
|
|
3506
|
+
- scopeid
|
|
3507
|
+
- qrveyid
|
|
3508
|
+
- panelid
|
|
3509
|
+
- columnid
|
|
3510
|
+
- validator
|
|
3511
|
+
- property
|
|
3512
|
+
- Column Aggregate
|
|
3513
|
+
- Column Calculation
|
|
3514
|
+
- Optional Index
|
|
3530
3515
|
|
|
3531
3516
|
|
|
3532
3517
|
|
|
@@ -3535,8 +3520,7 @@ Determines if the filter column and property is a distinct group dates type
|
|
|
3535
3520
|
|
|
3536
3521
|
| Name | Type | Description | |
|
|
3537
3522
|
| ---- | ---- | ----------- | -------- |
|
|
3538
|
-
|
|
|
3539
|
-
| property | | The filter property | |
|
|
3523
|
+
| filter | | the filter structure | |
|
|
3540
3524
|
|
|
3541
3525
|
|
|
3542
3526
|
|
|
@@ -3544,17 +3528,17 @@ Determines if the filter column and property is a distinct group dates type
|
|
|
3544
3528
|
##### Returns
|
|
3545
3529
|
|
|
3546
3530
|
|
|
3547
|
-
-
|
|
3531
|
+
- a text to identify the filter
|
|
3548
3532
|
|
|
3549
3533
|
|
|
3550
3534
|
|
|
3551
3535
|
|
|
3552
|
-
### dist/filters/helpers/common/
|
|
3536
|
+
### dist/filters/helpers/common/getFilterLabel.js
|
|
3553
3537
|
|
|
3554
3538
|
|
|
3555
|
-
####
|
|
3539
|
+
#### getFilterLabel(filter)
|
|
3556
3540
|
|
|
3557
|
-
|
|
3541
|
+
Gets the Filter Label + Column label
|
|
3558
3542
|
|
|
3559
3543
|
|
|
3560
3544
|
|
|
@@ -3563,7 +3547,7 @@ Validates if the given validator is a In type
|
|
|
3563
3547
|
|
|
3564
3548
|
| Name | Type | Description | |
|
|
3565
3549
|
| ---- | ---- | ----------- | -------- |
|
|
3566
|
-
|
|
|
3550
|
+
| filter | | the UI filter | |
|
|
3567
3551
|
|
|
3568
3552
|
|
|
3569
3553
|
|
|
@@ -3571,17 +3555,17 @@ Validates if the given validator is a In type
|
|
|
3571
3555
|
##### Returns
|
|
3572
3556
|
|
|
3573
3557
|
|
|
3574
|
-
-
|
|
3558
|
+
- a sring label
|
|
3575
3559
|
|
|
3576
3560
|
|
|
3577
3561
|
|
|
3578
3562
|
|
|
3579
|
-
### dist/filters/helpers/common/
|
|
3563
|
+
### dist/filters/helpers/common/getFiltersByAggregateColumn.js
|
|
3580
3564
|
|
|
3581
3565
|
|
|
3582
|
-
####
|
|
3566
|
+
#### getFiltersByAggregateColumn(filterData)
|
|
3583
3567
|
|
|
3584
|
-
|
|
3568
|
+
Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
|
|
3585
3569
|
|
|
3586
3570
|
|
|
3587
3571
|
|
|
@@ -3590,7 +3574,7 @@ Checks if the given validator is a Null type.
|
|
|
3590
3574
|
|
|
3591
3575
|
| Name | Type | Description | |
|
|
3592
3576
|
| ---- | ---- | ----------- | -------- |
|
|
3593
|
-
|
|
|
3577
|
+
| filterData | | The filter data object | |
|
|
3594
3578
|
|
|
3595
3579
|
|
|
3596
3580
|
|
|
@@ -3598,17 +3582,26 @@ Checks if the given validator is a Null type.
|
|
|
3598
3582
|
##### Returns
|
|
3599
3583
|
|
|
3600
3584
|
|
|
3601
|
-
-
|
|
3585
|
+
- The new filter data object that were get the aggregate filters
|
|
3602
3586
|
|
|
3603
3587
|
|
|
3604
3588
|
|
|
3605
3589
|
|
|
3606
|
-
### dist/filters/helpers/common/
|
|
3590
|
+
### dist/filters/helpers/common/getFiltersByParams.js
|
|
3607
3591
|
|
|
3608
3592
|
|
|
3609
|
-
####
|
|
3593
|
+
#### getFiltersByParams(filterData, params)
|
|
3610
3594
|
|
|
3611
|
-
|
|
3595
|
+
Gets filters from the given params.
|
|
3596
|
+
The validation to filter the stored filter is depending on:
|
|
3597
|
+
- Column
|
|
3598
|
+
- Qrvey ID
|
|
3599
|
+
- Scope type
|
|
3600
|
+
- Scope ID
|
|
3601
|
+
- Panel ID
|
|
3602
|
+
- Validator type
|
|
3603
|
+
- Property type
|
|
3604
|
+
- Enabled flags
|
|
3612
3605
|
|
|
3613
3606
|
|
|
3614
3607
|
|
|
@@ -3617,7 +3610,8 @@ Validates if the given validator is a Range type. Range type means the value has
|
|
|
3617
3610
|
|
|
3618
3611
|
| Name | Type | Description | |
|
|
3619
3612
|
| ---- | ---- | ----------- | -------- |
|
|
3620
|
-
|
|
|
3613
|
+
| filterData | | The Filter Data or the UI Filter Data | |
|
|
3614
|
+
| params | | given parameters to validate the dataset | |
|
|
3621
3615
|
|
|
3622
3616
|
|
|
3623
3617
|
|
|
@@ -3625,17 +3619,17 @@ Validates if the given validator is a Range type. Range type means the value has
|
|
|
3625
3619
|
##### Returns
|
|
3626
3620
|
|
|
3627
3621
|
|
|
3628
|
-
-
|
|
3622
|
+
- a new Filter object structure
|
|
3629
3623
|
|
|
3630
3624
|
|
|
3631
3625
|
|
|
3632
3626
|
|
|
3633
|
-
### dist/filters/helpers/common/
|
|
3627
|
+
### dist/filters/helpers/common/getFiltersByScopes.js
|
|
3634
3628
|
|
|
3635
3629
|
|
|
3636
|
-
####
|
|
3630
|
+
#### getFiltersByScopes(filterData, scopes)
|
|
3637
3631
|
|
|
3638
|
-
|
|
3632
|
+
Filters and gets a Filter Data by the given scopes
|
|
3639
3633
|
|
|
3640
3634
|
|
|
3641
3635
|
|
|
@@ -3644,7 +3638,8 @@ Validates if the given validator is a regular type. Regular type means the filte
|
|
|
3644
3638
|
|
|
3645
3639
|
| Name | Type | Description | |
|
|
3646
3640
|
| ---- | ---- | ----------- | -------- |
|
|
3647
|
-
|
|
|
3641
|
+
| filterData | | The Filter Data | |
|
|
3642
|
+
| scopes | | collection of scopes types | |
|
|
3648
3643
|
|
|
3649
3644
|
|
|
3650
3645
|
|
|
@@ -3652,17 +3647,17 @@ Validates if the given validator is a regular type. Regular type means the filte
|
|
|
3652
3647
|
##### Returns
|
|
3653
3648
|
|
|
3654
3649
|
|
|
3655
|
-
-
|
|
3650
|
+
- The new Filter Data
|
|
3656
3651
|
|
|
3657
3652
|
|
|
3658
3653
|
|
|
3659
3654
|
|
|
3660
|
-
### dist/filters/helpers/common/
|
|
3655
|
+
### dist/filters/helpers/common/getFiltersByScopesIds.js
|
|
3661
3656
|
|
|
3662
3657
|
|
|
3663
|
-
####
|
|
3658
|
+
#### getFiltersByScopesIds(filterData, scopes)
|
|
3664
3659
|
|
|
3665
|
-
|
|
3660
|
+
Gets filters from Filter Data by Scopes/Scope IDs.
|
|
3666
3661
|
|
|
3667
3662
|
|
|
3668
3663
|
|
|
@@ -3671,9 +3666,8 @@ Merge filter data structures in a new one. The first Filter Data passed in the a
|
|
|
3671
3666
|
|
|
3672
3667
|
| Name | Type | Description | |
|
|
3673
3668
|
| ---- | ---- | ----------- | -------- |
|
|
3674
|
-
|
|
|
3675
|
-
|
|
|
3676
|
-
| overwriteValues | | Flag to overwrite or not the filter values | |
|
|
3669
|
+
| filterData | | The filter data | |
|
|
3670
|
+
| scopes | | The collection of Scopes/Scope IDs | |
|
|
3677
3671
|
|
|
3678
3672
|
|
|
3679
3673
|
|
|
@@ -3681,13 +3675,17 @@ Merge filter data structures in a new one. The first Filter Data passed in the a
|
|
|
3681
3675
|
##### Returns
|
|
3682
3676
|
|
|
3683
3677
|
|
|
3684
|
-
- a new
|
|
3678
|
+
- a new Filter Data
|
|
3685
3679
|
|
|
3686
3680
|
|
|
3687
3681
|
|
|
3688
|
-
#### mergeScopes(scopes1, scopes2, overwriteValues)
|
|
3689
3682
|
|
|
3690
|
-
|
|
3683
|
+
### dist/filters/helpers/common/getFiltersByVisibility.js
|
|
3684
|
+
|
|
3685
|
+
|
|
3686
|
+
#### getFiltersByVisibility(filterData, scopes)
|
|
3687
|
+
|
|
3688
|
+
Get a new Filter Data by filtering scopes/scope IDs and enabled flags
|
|
3691
3689
|
|
|
3692
3690
|
|
|
3693
3691
|
|
|
@@ -3696,9 +3694,8 @@ Gets a new scope structure array by merging two scope structures
|
|
|
3696
3694
|
|
|
3697
3695
|
| Name | Type | Description | |
|
|
3698
3696
|
| ---- | ---- | ----------- | -------- |
|
|
3699
|
-
|
|
|
3700
|
-
|
|
|
3701
|
-
| overwriteValues | | Flag to overwrite or not the filter values | |
|
|
3697
|
+
| filterData | | a Filter Data or UI Filter Data | |
|
|
3698
|
+
| scopes | | a Scopes/Scope IDs array | |
|
|
3702
3699
|
|
|
3703
3700
|
|
|
3704
3701
|
|
|
@@ -3706,13 +3703,17 @@ Gets a new scope structure array by merging two scope structures
|
|
|
3706
3703
|
##### Returns
|
|
3707
3704
|
|
|
3708
3705
|
|
|
3709
|
-
- a new
|
|
3706
|
+
- a new Filter Data
|
|
3710
3707
|
|
|
3711
3708
|
|
|
3712
3709
|
|
|
3713
|
-
#### mergeDatasets(datasets1, datasets2, overwriteValues)
|
|
3714
3710
|
|
|
3715
|
-
|
|
3711
|
+
### dist/filters/helpers/common/getMergeFiltersSettings.js
|
|
3712
|
+
|
|
3713
|
+
|
|
3714
|
+
#### getMergeFiltersSettings(settings)
|
|
3715
|
+
|
|
3716
|
+
Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
|
|
3716
3717
|
|
|
3717
3718
|
|
|
3718
3719
|
|
|
@@ -3721,9 +3722,7 @@ Gets a new dataset structure array by merging two dataset structures
|
|
|
3721
3722
|
|
|
3722
3723
|
| Name | Type | Description | |
|
|
3723
3724
|
| ---- | ---- | ----------- | -------- |
|
|
3724
|
-
|
|
|
3725
|
-
| datasets2 | | the dataset to be merged | |
|
|
3726
|
-
| overwriteValues | | Flag to overwrite or not the filter values | |
|
|
3725
|
+
| settings | | an object to the MergeFilters settings | |
|
|
3727
3726
|
|
|
3728
3727
|
|
|
3729
3728
|
|
|
@@ -3731,13 +3730,17 @@ Gets a new dataset structure array by merging two dataset structures
|
|
|
3731
3730
|
##### Returns
|
|
3732
3731
|
|
|
3733
3732
|
|
|
3734
|
-
- a new
|
|
3733
|
+
- a new MergeFilters settings object.
|
|
3735
3734
|
|
|
3736
3735
|
|
|
3737
3736
|
|
|
3738
|
-
#### mergeFilterss(filters1, filters2, overwriteValues)
|
|
3739
3737
|
|
|
3740
|
-
|
|
3738
|
+
### dist/filters/helpers/common/getParamsToGetFilterSettings.js
|
|
3739
|
+
|
|
3740
|
+
|
|
3741
|
+
#### getParamsToGetFilterSettings(settings)
|
|
3742
|
+
|
|
3743
|
+
Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
|
|
3741
3744
|
|
|
3742
3745
|
|
|
3743
3746
|
|
|
@@ -3746,9 +3749,7 @@ Gets a new filter structure array by merging two filter structures
|
|
|
3746
3749
|
|
|
3747
3750
|
| Name | Type | Description | |
|
|
3748
3751
|
| ---- | ---- | ----------- | -------- |
|
|
3749
|
-
|
|
|
3750
|
-
| filters2 | | the filter to be merged | |
|
|
3751
|
-
| overwriteValues | | Flag to overwrite or not the filter values | |
|
|
3752
|
+
| settings | | an object to the ParamsToGetFilter settings | |
|
|
3752
3753
|
|
|
3753
3754
|
|
|
3754
3755
|
|
|
@@ -3756,13 +3757,17 @@ Gets a new filter structure array by merging two filter structures
|
|
|
3756
3757
|
##### Returns
|
|
3757
3758
|
|
|
3758
3759
|
|
|
3759
|
-
- a new
|
|
3760
|
+
- a new ParamsToGetFilter settings object.
|
|
3760
3761
|
|
|
3761
3762
|
|
|
3762
3763
|
|
|
3763
|
-
#### mergeValues(filter1, filter2, overwrite)
|
|
3764
3764
|
|
|
3765
|
-
|
|
3765
|
+
### dist/filters/helpers/common/haveFiltersByDataset.js
|
|
3766
|
+
|
|
3767
|
+
|
|
3768
|
+
#### haveFiltersByDataset(filterData, qrveyid)
|
|
3769
|
+
|
|
3770
|
+
Validates if the filter data has filters by a dataset ID (Qrvey ID).
|
|
3766
3771
|
|
|
3767
3772
|
|
|
3768
3773
|
|
|
@@ -3771,9 +3776,8 @@ Gets a new value structure array by merging two value structures
|
|
|
3771
3776
|
|
|
3772
3777
|
| Name | Type | Description | |
|
|
3773
3778
|
| ---- | ---- | ----------- | -------- |
|
|
3774
|
-
|
|
|
3775
|
-
|
|
|
3776
|
-
| overwrite | | Flag to overwrite or not the filter values | |
|
|
3779
|
+
| filterData | | the filter data or the UI filter data. | |
|
|
3780
|
+
| qrveyid | | The Qrvey ID | |
|
|
3777
3781
|
|
|
3778
3782
|
|
|
3779
3783
|
|
|
@@ -3781,17 +3785,17 @@ Gets a new value structure array by merging two value structures
|
|
|
3781
3785
|
##### Returns
|
|
3782
3786
|
|
|
3783
3787
|
|
|
3784
|
-
-
|
|
3788
|
+
- true: the filter data has filters by the Qrvey ID
|
|
3785
3789
|
|
|
3786
3790
|
|
|
3787
3791
|
|
|
3788
3792
|
|
|
3789
|
-
### dist/filters/helpers/common/
|
|
3793
|
+
### dist/filters/helpers/common/isBetweenValidator.js
|
|
3790
3794
|
|
|
3791
3795
|
|
|
3792
|
-
####
|
|
3796
|
+
#### isBetweenValidator(validator)
|
|
3793
3797
|
|
|
3794
|
-
|
|
3798
|
+
Validates if the given validator is a Between type
|
|
3795
3799
|
|
|
3796
3800
|
|
|
3797
3801
|
|
|
@@ -3800,10 +3804,7 @@ Resolves the conditions by given params
|
|
|
3800
3804
|
|
|
3801
3805
|
| Name | Type | Description | |
|
|
3802
3806
|
| ---- | ---- | ----------- | -------- |
|
|
3803
|
-
|
|
|
3804
|
-
| params | | given parameters to validate the dataset | |
|
|
3805
|
-
| letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined | |
|
|
3806
|
-
| letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. | |
|
|
3807
|
+
| validator | | The validator | |
|
|
3807
3808
|
|
|
3808
3809
|
|
|
3809
3810
|
|
|
@@ -3811,17 +3812,17 @@ Resolves the conditions by given params
|
|
|
3811
3812
|
##### Returns
|
|
3812
3813
|
|
|
3813
3814
|
|
|
3814
|
-
- true:
|
|
3815
|
+
- true: it is a between validator; false: it is not a between validator
|
|
3815
3816
|
|
|
3816
3817
|
|
|
3817
3818
|
|
|
3818
3819
|
|
|
3819
|
-
### dist/filters/helpers/common/
|
|
3820
|
+
### dist/filters/helpers/common/isDateDistinctProperty.js
|
|
3820
3821
|
|
|
3821
3822
|
|
|
3822
|
-
####
|
|
3823
|
+
#### isDateDistinctProperty(column, property)
|
|
3823
3824
|
|
|
3824
|
-
|
|
3825
|
+
Determines if the filter column and property is a distinct group dates type
|
|
3825
3826
|
|
|
3826
3827
|
|
|
3827
3828
|
|
|
@@ -3830,10 +3831,8 @@ Resolves the conditions by given params
|
|
|
3830
3831
|
|
|
3831
3832
|
| Name | Type | Description | |
|
|
3832
3833
|
| ---- | ---- | ----------- | -------- |
|
|
3833
|
-
|
|
|
3834
|
-
|
|
|
3835
|
-
| letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined | |
|
|
3836
|
-
| letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. | |
|
|
3834
|
+
| column | | The filter column | |
|
|
3835
|
+
| property | | The filter property | |
|
|
3837
3836
|
|
|
3838
3837
|
|
|
3839
3838
|
|
|
@@ -3841,17 +3840,17 @@ Resolves the conditions by given params
|
|
|
3841
3840
|
##### Returns
|
|
3842
3841
|
|
|
3843
3842
|
|
|
3844
|
-
-
|
|
3843
|
+
- True if the given property is included from distinct group dates type
|
|
3845
3844
|
|
|
3846
3845
|
|
|
3847
3846
|
|
|
3848
3847
|
|
|
3849
|
-
### dist/filters/helpers/common/
|
|
3848
|
+
### dist/filters/helpers/common/isInValidator.js
|
|
3850
3849
|
|
|
3851
3850
|
|
|
3852
|
-
####
|
|
3851
|
+
#### isInValidator(validator)
|
|
3853
3852
|
|
|
3854
|
-
|
|
3853
|
+
Validates if the given validator is a In type
|
|
3855
3854
|
|
|
3856
3855
|
|
|
3857
3856
|
|
|
@@ -3860,10 +3859,7 @@ Resolves the conditions by given params
|
|
|
3860
3859
|
|
|
3861
3860
|
| Name | Type | Description | |
|
|
3862
3861
|
| ---- | ---- | ----------- | -------- |
|
|
3863
|
-
|
|
|
3864
|
-
| params | | given parameters to validate the filter | |
|
|
3865
|
-
| letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined | |
|
|
3866
|
-
| letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. | |
|
|
3862
|
+
| validator | | The validator | |
|
|
3867
3863
|
|
|
3868
3864
|
|
|
3869
3865
|
|
|
@@ -3871,18 +3867,17 @@ Resolves the conditions by given params
|
|
|
3871
3867
|
##### Returns
|
|
3872
3868
|
|
|
3873
3869
|
|
|
3874
|
-
- true:
|
|
3870
|
+
- true: it is a In validator; false: it is not a In validator
|
|
3875
3871
|
|
|
3876
3872
|
|
|
3877
3873
|
|
|
3878
3874
|
|
|
3879
|
-
### dist/filters/helpers/
|
|
3875
|
+
### dist/filters/helpers/common/isNullValidator.js
|
|
3880
3876
|
|
|
3881
3877
|
|
|
3882
|
-
####
|
|
3878
|
+
#### isNullValidator(validator)
|
|
3883
3879
|
|
|
3884
|
-
|
|
3885
|
-
- If the resulting value array is empty the enabled property will be false.
|
|
3880
|
+
Checks if the given validator is a Null type.
|
|
3886
3881
|
|
|
3887
3882
|
|
|
3888
3883
|
|
|
@@ -3891,7 +3886,7 @@ Builds filter expression by the filter data.
|
|
|
3891
3886
|
|
|
3892
3887
|
| Name | Type | Description | |
|
|
3893
3888
|
| ---- | ---- | ----------- | -------- |
|
|
3894
|
-
|
|
|
3889
|
+
| validator | | The Filter Validator | |
|
|
3895
3890
|
|
|
3896
3891
|
|
|
3897
3892
|
|
|
@@ -3899,17 +3894,17 @@ Builds filter expression by the filter data.
|
|
|
3899
3894
|
##### Returns
|
|
3900
3895
|
|
|
3901
3896
|
|
|
3902
|
-
- a
|
|
3897
|
+
- True: It is a Null Validator; False: It is not a Null Validator.
|
|
3903
3898
|
|
|
3904
3899
|
|
|
3905
3900
|
|
|
3906
3901
|
|
|
3907
|
-
### dist/filters/helpers/
|
|
3902
|
+
### dist/filters/helpers/common/isRangeValidator.js
|
|
3908
3903
|
|
|
3909
3904
|
|
|
3910
|
-
####
|
|
3905
|
+
#### isRangeValidator(validator)
|
|
3911
3906
|
|
|
3912
|
-
|
|
3907
|
+
Validates if the given validator is a Range type. Range type means the value has min and max values to filter
|
|
3913
3908
|
|
|
3914
3909
|
|
|
3915
3910
|
|
|
@@ -3918,7 +3913,7 @@ Transform user Filters array into Filter Logic structure
|
|
|
3918
3913
|
|
|
3919
3914
|
| Name | Type | Description | |
|
|
3920
3915
|
| ---- | ---- | ----------- | -------- |
|
|
3921
|
-
|
|
|
3916
|
+
| validator | | The filter validator | |
|
|
3922
3917
|
|
|
3923
3918
|
|
|
3924
3919
|
|
|
@@ -3926,17 +3921,17 @@ Transform user Filters array into Filter Logic structure
|
|
|
3926
3921
|
##### Returns
|
|
3927
3922
|
|
|
3928
3923
|
|
|
3929
|
-
-
|
|
3930
|
-
|
|
3924
|
+
- true: it is a range validator
|
|
3931
3925
|
|
|
3932
3926
|
|
|
3933
3927
|
|
|
3934
|
-
### dist/filters/helpers/backend/getAggFiltersBySummaryIndex.js
|
|
3935
3928
|
|
|
3929
|
+
### dist/filters/helpers/common/isRegularValidator.js
|
|
3936
3930
|
|
|
3937
|
-
#### getAggFiltersBySummaryIndex(aggFilters, summaryIndex)
|
|
3938
3931
|
|
|
3932
|
+
#### isRegularValidator(validator)
|
|
3939
3933
|
|
|
3934
|
+
Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
|
|
3940
3935
|
|
|
3941
3936
|
|
|
3942
3937
|
|
|
@@ -3945,8 +3940,7 @@ Transform user Filters array into Filter Logic structure
|
|
|
3945
3940
|
|
|
3946
3941
|
| Name | Type | Description | |
|
|
3947
3942
|
| ---- | ---- | ----------- | -------- |
|
|
3948
|
-
|
|
|
3949
|
-
| summaryIndex | | | |
|
|
3943
|
+
| validator | | The filter validator | |
|
|
3950
3944
|
|
|
3951
3945
|
|
|
3952
3946
|
|
|
@@ -3954,17 +3948,17 @@ Transform user Filters array into Filter Logic structure
|
|
|
3954
3948
|
##### Returns
|
|
3955
3949
|
|
|
3956
3950
|
|
|
3957
|
-
-
|
|
3951
|
+
- true: it is a range validator
|
|
3958
3952
|
|
|
3959
3953
|
|
|
3960
3954
|
|
|
3961
3955
|
|
|
3962
|
-
### dist/filters/helpers/
|
|
3956
|
+
### dist/filters/helpers/common/mergeFilters.js
|
|
3963
3957
|
|
|
3964
3958
|
|
|
3965
|
-
####
|
|
3959
|
+
#### mergeFilters(filterData1, filterData2, overwriteValues)
|
|
3966
3960
|
|
|
3967
|
-
|
|
3961
|
+
Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
|
|
3968
3962
|
|
|
3969
3963
|
|
|
3970
3964
|
|
|
@@ -3973,7 +3967,9 @@ Gets a group value for the backend logic structure
|
|
|
3973
3967
|
|
|
3974
3968
|
| Name | Type | Description | |
|
|
3975
3969
|
| ---- | ---- | ----------- | -------- |
|
|
3976
|
-
|
|
|
3970
|
+
| filterData1 | | The target filter data | |
|
|
3971
|
+
| filterData2 | | the filter data to be merged | |
|
|
3972
|
+
| overwriteValues | | Flag to overwrite or not the filter values | |
|
|
3977
3973
|
|
|
3978
3974
|
|
|
3979
3975
|
|
|
@@ -3981,17 +3977,13 @@ Gets a group value for the backend logic structure
|
|
|
3981
3977
|
##### Returns
|
|
3982
3978
|
|
|
3983
3979
|
|
|
3984
|
-
- a
|
|
3985
|
-
|
|
3986
|
-
|
|
3987
|
-
|
|
3980
|
+
- a new filter data structure
|
|
3988
3981
|
|
|
3989
|
-
### dist/filters/helpers/backend/getBackendProperty.js
|
|
3990
3982
|
|
|
3991
3983
|
|
|
3992
|
-
####
|
|
3984
|
+
#### mergeScopes(scopes1, scopes2, overwriteValues)
|
|
3993
3985
|
|
|
3994
|
-
Gets a
|
|
3986
|
+
Gets a new scope structure array by merging two scope structures
|
|
3995
3987
|
|
|
3996
3988
|
|
|
3997
3989
|
|
|
@@ -4000,7 +3992,9 @@ Gets a property for the logic structure
|
|
|
4000
3992
|
|
|
4001
3993
|
| Name | Type | Description | |
|
|
4002
3994
|
| ---- | ---- | ----------- | -------- |
|
|
4003
|
-
|
|
|
3995
|
+
| scopes1 | | the target scope structure | |
|
|
3996
|
+
| scopes2 | | the scope to be merged | |
|
|
3997
|
+
| overwriteValues | | Flag to overwrite or not the filter values | |
|
|
4004
3998
|
|
|
4005
3999
|
|
|
4006
4000
|
|
|
@@ -4008,17 +4002,13 @@ Gets a property for the logic structure
|
|
|
4008
4002
|
##### Returns
|
|
4009
4003
|
|
|
4010
4004
|
|
|
4011
|
-
- a
|
|
4012
|
-
|
|
4013
|
-
|
|
4014
|
-
|
|
4005
|
+
- a new scope structure array
|
|
4015
4006
|
|
|
4016
|
-
### dist/filters/helpers/backend/getBackendValidator.js
|
|
4017
4007
|
|
|
4018
4008
|
|
|
4019
|
-
####
|
|
4009
|
+
#### mergeDatasets(datasets1, datasets2, overwriteValues)
|
|
4020
4010
|
|
|
4021
|
-
Gets
|
|
4011
|
+
Gets a new dataset structure array by merging two dataset structures
|
|
4022
4012
|
|
|
4023
4013
|
|
|
4024
4014
|
|
|
@@ -4027,7 +4017,9 @@ Gets the Validator that is used in requests
|
|
|
4027
4017
|
|
|
4028
4018
|
| Name | Type | Description | |
|
|
4029
4019
|
| ---- | ---- | ----------- | -------- |
|
|
4030
|
-
|
|
|
4020
|
+
| datasets1 | | the target dataset structure | |
|
|
4021
|
+
| datasets2 | | the dataset to be merged | |
|
|
4022
|
+
| overwriteValues | | Flag to overwrite or not the filter values | |
|
|
4031
4023
|
|
|
4032
4024
|
|
|
4033
4025
|
|
|
@@ -4035,17 +4027,13 @@ Gets the Validator that is used in requests
|
|
|
4035
4027
|
##### Returns
|
|
4036
4028
|
|
|
4037
4029
|
|
|
4038
|
-
-
|
|
4039
|
-
|
|
4040
|
-
|
|
4041
|
-
|
|
4030
|
+
- a new dataset structure array
|
|
4042
4031
|
|
|
4043
|
-
### dist/filters/helpers/backend/getBackendValues.js
|
|
4044
4032
|
|
|
4045
4033
|
|
|
4046
|
-
####
|
|
4034
|
+
#### mergeFilterss(filters1, filters2, overwriteValues)
|
|
4047
4035
|
|
|
4048
|
-
Gets
|
|
4036
|
+
Gets a new filter structure array by merging two filter structures
|
|
4049
4037
|
|
|
4050
4038
|
|
|
4051
4039
|
|
|
@@ -4054,7 +4042,9 @@ Gets the expresion values in the logic format
|
|
|
4054
4042
|
|
|
4055
4043
|
| Name | Type | Description | |
|
|
4056
4044
|
| ---- | ---- | ----------- | -------- |
|
|
4057
|
-
|
|
|
4045
|
+
| filters1 | | the target filter structure | |
|
|
4046
|
+
| filters2 | | the filter to be merged | |
|
|
4047
|
+
| overwriteValues | | Flag to overwrite or not the filter values | |
|
|
4058
4048
|
|
|
4059
4049
|
|
|
4060
4050
|
|
|
@@ -4062,13 +4052,13 @@ Gets the expresion values in the logic format
|
|
|
4062
4052
|
##### Returns
|
|
4063
4053
|
|
|
4064
4054
|
|
|
4065
|
-
-
|
|
4055
|
+
- a new filter structure array
|
|
4066
4056
|
|
|
4067
4057
|
|
|
4068
4058
|
|
|
4069
|
-
####
|
|
4059
|
+
#### mergeValues(filter1, filter2, overwrite)
|
|
4070
4060
|
|
|
4071
|
-
Gets
|
|
4061
|
+
Gets a new value structure array by merging two value structures
|
|
4072
4062
|
|
|
4073
4063
|
|
|
4074
4064
|
|
|
@@ -4077,8 +4067,9 @@ Gets the expression values. Depending on the column type
|
|
|
4077
4067
|
|
|
4078
4068
|
| Name | Type | Description | |
|
|
4079
4069
|
| ---- | ---- | ----------- | -------- |
|
|
4080
|
-
|
|
|
4081
|
-
|
|
|
4070
|
+
| filter1 | | the target filter structure | |
|
|
4071
|
+
| filter2 | | the filter to be used to merge the values | |
|
|
4072
|
+
| overwrite | | Flag to overwrite or not the filter values | |
|
|
4082
4073
|
|
|
4083
4074
|
|
|
4084
4075
|
|
|
@@ -4086,13 +4077,17 @@ Gets the expression values. Depending on the column type
|
|
|
4086
4077
|
##### Returns
|
|
4087
4078
|
|
|
4088
4079
|
|
|
4089
|
-
-
|
|
4080
|
+
- a new value structure array
|
|
4090
4081
|
|
|
4091
4082
|
|
|
4092
4083
|
|
|
4093
|
-
#### getRankingValues(values, rankingGroupIndex)
|
|
4094
4084
|
|
|
4095
|
-
|
|
4085
|
+
### dist/filters/helpers/common/resolveDatasetConditions.js
|
|
4086
|
+
|
|
4087
|
+
|
|
4088
|
+
#### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
|
|
4089
|
+
|
|
4090
|
+
Resolves the conditions by given params
|
|
4096
4091
|
|
|
4097
4092
|
|
|
4098
4093
|
|
|
@@ -4101,8 +4096,10 @@ Gets the Ranking values.
|
|
|
4101
4096
|
|
|
4102
4097
|
| Name | Type | Description | |
|
|
4103
4098
|
| ---- | ---- | ----------- | -------- |
|
|
4104
|
-
|
|
|
4105
|
-
|
|
|
4099
|
+
| filter | | The dataset structure | |
|
|
4100
|
+
| params | | given parameters to validate the dataset | |
|
|
4101
|
+
| letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined | |
|
|
4102
|
+
| letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. | |
|
|
4106
4103
|
|
|
4107
4104
|
|
|
4108
4105
|
|
|
@@ -4110,17 +4107,17 @@ Gets the Ranking values.
|
|
|
4110
4107
|
##### Returns
|
|
4111
4108
|
|
|
4112
4109
|
|
|
4113
|
-
-
|
|
4110
|
+
- true: the condition is satisfied
|
|
4114
4111
|
|
|
4115
4112
|
|
|
4116
4113
|
|
|
4117
4114
|
|
|
4118
|
-
### dist/filters/helpers/
|
|
4115
|
+
### dist/filters/helpers/common/resolveFilterConditions.js
|
|
4119
4116
|
|
|
4120
4117
|
|
|
4121
|
-
####
|
|
4118
|
+
#### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
|
|
4122
4119
|
|
|
4123
|
-
|
|
4120
|
+
Resolves the conditions by given params
|
|
4124
4121
|
|
|
4125
4122
|
|
|
4126
4123
|
|
|
@@ -4129,8 +4126,10 @@ Gets the filters from logic data by Scopes/Scope IDs.
|
|
|
4129
4126
|
|
|
4130
4127
|
| Name | Type | Description | |
|
|
4131
4128
|
| ---- | ---- | ----------- | -------- |
|
|
4132
|
-
|
|
|
4133
|
-
|
|
|
4129
|
+
| filter | | The filter | |
|
|
4130
|
+
| params | | given parameters to validate the filter | |
|
|
4131
|
+
| letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined | |
|
|
4132
|
+
| letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. | |
|
|
4134
4133
|
|
|
4135
4134
|
|
|
4136
4135
|
|
|
@@ -4138,17 +4137,17 @@ Gets the filters from logic data by Scopes/Scope IDs.
|
|
|
4138
4137
|
##### Returns
|
|
4139
4138
|
|
|
4140
4139
|
|
|
4141
|
-
-
|
|
4140
|
+
- true: the condition is satisfied
|
|
4142
4141
|
|
|
4143
4142
|
|
|
4144
4143
|
|
|
4145
4144
|
|
|
4146
|
-
### dist/filters/helpers/
|
|
4145
|
+
### dist/filters/helpers/common/resolveScopeConditions.js
|
|
4147
4146
|
|
|
4148
4147
|
|
|
4149
|
-
####
|
|
4148
|
+
#### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
|
|
4150
4149
|
|
|
4151
|
-
|
|
4150
|
+
Resolves the conditions by given params
|
|
4152
4151
|
|
|
4153
4152
|
|
|
4154
4153
|
|
|
@@ -4157,9 +4156,10 @@ Gets filters from the logic by the scopes hierarchy.
|
|
|
4157
4156
|
|
|
4158
4157
|
| Name | Type | Description | |
|
|
4159
4158
|
| ---- | ---- | ----------- | -------- |
|
|
4160
|
-
|
|
|
4161
|
-
|
|
|
4162
|
-
|
|
|
4159
|
+
| filter | | The filter scope structure | |
|
|
4160
|
+
| params | | given parameters to validate the filter | |
|
|
4161
|
+
| letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined | |
|
|
4162
|
+
| letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. | |
|
|
4163
4163
|
|
|
4164
4164
|
|
|
4165
4165
|
|
|
@@ -4167,7 +4167,7 @@ Gets filters from the logic by the scopes hierarchy.
|
|
|
4167
4167
|
##### Returns
|
|
4168
4168
|
|
|
4169
4169
|
|
|
4170
|
-
-
|
|
4170
|
+
- true: the condition is satisfied
|
|
4171
4171
|
|
|
4172
4172
|
|
|
4173
4173
|
|