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