@qrvey/utils 1.2.4-17 → 1.2.4-18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.4-17*
1
+ # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.4-18*
2
2
 
3
3
  > Helper, Utils for all Qrvey Projects
4
4
 
@@ -688,26 +688,6 @@ Output:
688
688
 
689
689
 
690
690
 
691
- ### dist/filters/classes/FilterInputErrorHandler.js
692
-
693
-
694
- #### new FilterInputErrorHandler()
695
-
696
-
697
-
698
-
699
-
700
-
701
-
702
-
703
- ##### Returns
704
-
705
-
706
- - `Void`
707
-
708
-
709
-
710
-
711
691
  ### dist/filters/adapters/FDToFlatUI.js
712
692
 
713
693
 
@@ -1558,6 +1538,26 @@ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
1558
1538
 
1559
1539
 
1560
1540
 
1541
+ ### dist/filters/classes/FilterInputErrorHandler.js
1542
+
1543
+
1544
+ #### new FilterInputErrorHandler()
1545
+
1546
+
1547
+
1548
+
1549
+
1550
+
1551
+
1552
+
1553
+ ##### Returns
1554
+
1555
+
1556
+ - `Void`
1557
+
1558
+
1559
+
1560
+
1561
1561
  ### dist/filters/helpers/applyHierarchyForAggFilters.js
1562
1562
 
1563
1563
 
@@ -1669,6 +1669,34 @@ Gets the Scopes IDS for the Available Scope function by any config
1669
1669
 
1670
1670
 
1671
1671
 
1672
+ ### dist/general/array/delete.js
1673
+
1674
+
1675
+ #### ArrayDelete(array, index)
1676
+
1677
+ Inmutable Array Item deletion
1678
+
1679
+
1680
+
1681
+
1682
+ ##### Parameters
1683
+
1684
+ | Name | Type | Description | |
1685
+ | ---- | ---- | ----------- | -------- |
1686
+ | array | `Array` | a collection of items to delete |   |
1687
+ | index | `Number` | the position of the item to delete |   |
1688
+
1689
+
1690
+
1691
+
1692
+ ##### Returns
1693
+
1694
+
1695
+ - a new Array or the given parameter when is empty or not an array
1696
+
1697
+
1698
+
1699
+
1672
1700
  ### dist/general/array/filterNestedTree.js
1673
1701
 
1674
1702
 
@@ -1784,12 +1812,12 @@ Gets the last index from the array by a callback condition
1784
1812
 
1785
1813
 
1786
1814
 
1787
- ### dist/general/array/delete.js
1815
+ ### dist/general/function/debounce.js
1788
1816
 
1789
1817
 
1790
- #### ArrayDelete(array, index)
1818
+ #### debounce(fn, time)
1791
1819
 
1792
- Inmutable Array Item deletion
1820
+ Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last time the debounced function was invoked.
1793
1821
 
1794
1822
 
1795
1823
 
@@ -1798,8 +1826,8 @@ Inmutable Array Item deletion
1798
1826
 
1799
1827
  | Name | Type | Description | |
1800
1828
  | ---- | ---- | ----------- | -------- |
1801
- | array | `Array` | a collection of items to delete |   |
1802
- | index | `Number` | the position of the item to delete |   |
1829
+ | fn | `Function` | original Function |   |
1830
+ | time | `Number` | default 500ms |   |
1803
1831
 
1804
1832
 
1805
1833
 
@@ -1807,17 +1835,17 @@ Inmutable Array Item deletion
1807
1835
  ##### Returns
1808
1836
 
1809
1837
 
1810
- - a new Array or the given parameter when is empty or not an array
1838
+ - `Function` debounced functions
1811
1839
 
1812
1840
 
1813
1841
 
1814
1842
 
1815
- ### dist/general/function/debounce.js
1843
+ ### dist/general/function/throttled.js
1816
1844
 
1817
1845
 
1818
- #### debounce(fn, time)
1846
+ #### throttled(fn, time)
1819
1847
 
1820
- Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last time the debounced function was invoked.
1848
+ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
1821
1849
 
1822
1850
 
1823
1851
 
@@ -1835,17 +1863,18 @@ Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last
1835
1863
  ##### Returns
1836
1864
 
1837
1865
 
1838
- - `Function` debounced functions
1866
+ - `Function` throttled function
1839
1867
 
1840
1868
 
1841
1869
 
1842
1870
 
1843
- ### dist/general/function/throttled.js
1871
+ ### dist/general/mix/compareDeep.js
1844
1872
 
1845
1873
 
1846
- #### throttled(fn, time)
1874
+ #### compareDeep(object1, object2)
1847
1875
 
1848
- Make sure to only invokes _fn_ at most once per every _time_ milliseconds
1876
+ Compares two objects to know if they are equals. Go across nested objects.
1877
+ Includes arrays in the comparison.
1849
1878
 
1850
1879
 
1851
1880
 
@@ -1854,8 +1883,8 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
1854
1883
 
1855
1884
  | Name | Type | Description | |
1856
1885
  | ---- | ---- | ----------- | -------- |
1857
- | fn | `Function` | original Function |   |
1858
- | time | `Number` | default 500ms |   |
1886
+ | object1 | | First Object to compare |   |
1887
+ | object2 | | Second Object to compare |   |
1859
1888
 
1860
1889
 
1861
1890
 
@@ -1863,18 +1892,17 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
1863
1892
  ##### Returns
1864
1893
 
1865
1894
 
1866
- - `Function` throttled function
1895
+ - True: objects are equal. False: Objects are not equal. Undefined: invalid
1867
1896
 
1868
1897
 
1869
1898
 
1870
1899
 
1871
- ### dist/general/object/cloneDeep.js
1900
+ ### dist/general/mix/getTag.js
1872
1901
 
1873
1902
 
1874
- #### cloneDeep(obj)
1903
+ #### getTag(value)
1875
1904
 
1876
- A simple Deep Cloning function. Valid only for primivite values and object with primitive values.
1877
- Not to use this function with inner objects and functions
1905
+ Gets the `toStringTag` of `value`.
1878
1906
 
1879
1907
 
1880
1908
 
@@ -1883,7 +1911,7 @@ Not to use this function with inner objects and functions
1883
1911
 
1884
1912
  | Name | Type | Description | |
1885
1913
  | ---- | ---- | ----------- | -------- |
1886
- | obj | | The object |   |
1914
+ | value | | The value to query. |   |
1887
1915
 
1888
1916
 
1889
1917
 
@@ -1891,21 +1919,17 @@ Not to use this function with inner objects and functions
1891
1919
  ##### Returns
1892
1920
 
1893
1921
 
1894
- - The new reference object or the given object if the parsing is incorrect or empty
1895
-
1922
+ - `string` Returns the `toStringTag`.
1896
1923
 
1897
1924
 
1898
1925
 
1899
- ### dist/general/object/get.js
1900
1926
 
1927
+ ### dist/general/mix/importScripts.js
1901
1928
 
1902
- #### _get(baseObject, path, defaultValue)
1903
1929
 
1904
- Like lodash _.get.
1905
- Gets the value at path of object. If the resolved value is undefined, the defaultValue is returned in its place.
1930
+ #### importScripts(scripts)
1906
1931
 
1907
- Empty arrays and empty objects are returned but the defaultValue is not
1908
- Undefined and null values will return the defaultValue.
1932
+ Import a set of external Scripts given the URL in both serie and cascade way
1909
1933
 
1910
1934
 
1911
1935
 
@@ -1914,9 +1938,12 @@ Undefined and null values will return the defaultValue.
1914
1938
 
1915
1939
  | Name | Type | Description | |
1916
1940
  | ---- | ---- | ----------- | -------- |
1917
- | baseObject | | The object to query |   |
1918
- | path | | The string path or collection of string paths of the property to get. |   |
1919
- | defaultValue | | The value returned for undefined resolved values. |   |
1941
+ | scripts | `Array.<String>` `Array.<Object>` | can be an array of string or an array of object with the follow structure: | &nbsp; |
1942
+ | scripts.url | `String` | CDN URL | &nbsp; |
1943
+ | scripts.namespace | `String` `Function` | (Optional) if is a String, that name is evaluated on Window[namespace] object otherwise the Function is invoked expecting a Thrutly value | &nbsp; |
1944
+ | scripts.type | `String` | (Optional) it could be `module` of `text/javascript`. Default `text/javascript` | &nbsp; |
1945
+ | scripts.noModule | `Boolean` | (Optional) add `momodule` attribute to script tag. Default `false` | &nbsp; |
1946
+ | scripts.dependencies | `Array.<Object>` | an array with the same structure to load in cascade mode | &nbsp; |
1920
1947
 
1921
1948
 
1922
1949
 
@@ -1924,49 +1951,41 @@ Undefined and null values will return the defaultValue.
1924
1951
  ##### Examples
1925
1952
 
1926
1953
  ```javascript
1927
- // returns 'Hello'
1928
- _get({ item1: 'Hello', item2: 'World' }, 'item1')
1929
- ```
1930
- ```javascript
1931
- // returns 'A simple Hello'
1932
- _get({ item1: 'Hello', item2: 'World' }, 'item3', 'A simple Hello')
1933
- ```
1934
- ```javascript
1935
- // returns 'Hello Again'
1936
- _get({ item1: { item11: 'Hello Again' }, item2: {} }, 'item1.item11')
1937
- ```
1938
- ```javascript
1939
- // returns 'Hello 2'
1940
- _get({ item1: ['Hello 1', 'Hello 2' }, item2: [] }, 'item1[1]')
1941
- ```
1942
- ```javascript
1943
- // returns 'Hello Again'
1944
- _get({ item1: { item11: 'Hello Again' }, item2: {} }, ['item1', 'item11'])
1945
- ```
1954
+ // 1) Simple script (paralell loading)
1955
+ importScripts(['http://myscript.js', 'http://another.js']);
1946
1956
 
1957
+ // 2) Loading `.js` and `.esm.js` script (parallel loading)
1958
+ importScripts([
1959
+ { url: 'http://myscript.esm.js', type: 'module' },
1960
+ { url: 'http://myscript.js', noModule: true }
1961
+ ]);
1947
1962
 
1948
- ##### Returns
1963
+ // 3) import dependent scripts (cascade)
1964
+ importScripts([
1965
+ { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] }
1966
+ ]);
1949
1967
 
1968
+ // 4) mix
1969
+ importScripts([
1970
+ { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] },
1971
+ { url: 'http://another.esm.js', type: 'module' },
1972
+ { url: 'http://another.js', noModule: true },
1973
+ 'http://simplescript.js'
1974
+ ]);
1975
+ ```
1950
1976
 
1951
- - the resolved value.
1952
1977
 
1978
+ ##### Returns
1953
1979
 
1954
1980
 
1981
+ - `Promise` Promise when all script have been loaded
1955
1982
 
1956
- ### dist/general/object/getAttribute.js
1957
1983
 
1958
1984
 
1959
- #### getAttribute(obj, key)
1985
+ #### loadScript(url, type, noModule)
1960
1986
 
1961
- Searchs for properties in different case styles such as: lower, upper, camel and pascal
1962
- - To optimize the searching, it is required a key in a snake_case style
1963
- - List of cases that do not match
1964
- -- From lower to snake case
1965
- -- From upper to snake case
1966
- -- From lower to camel case
1967
- -- From upper to camel case
1968
- -- From lower to pascal case
1969
- -- From upper to pascal case
1987
+ Creates the script element and appends to document.head
1988
+ return a Promise that is resolved when the script is loaded
1970
1989
 
1971
1990
 
1972
1991
 
@@ -1975,17 +1994,11 @@ Searchs for properties in different case styles such as: lower, upper, camel and
1975
1994
 
1976
1995
  | Name | Type | Description | |
1977
1996
  | ---- | ---- | ----------- | -------- |
1978
- | obj | `object` | object to look for | &nbsp; |
1979
- | key | `string` | String attribute in snake_case style | &nbsp; |
1980
-
1981
-
1982
-
1997
+ | url | `String` | Cdn Url | &nbsp; |
1998
+ | type | `String` | (Optional) it could be `module` of `text/javascript`. Default `text/javascript` | &nbsp; |
1999
+ | noModule | `boolean` | (Optional) add `momodule` attribute to script tag. Default `false` | &nbsp; |
1983
2000
 
1984
- ##### Examples
1985
2001
 
1986
- ```javascript
1987
- getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
1988
- ```
1989
2002
 
1990
2003
 
1991
2004
  ##### Returns
@@ -1996,12 +2009,12 @@ getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase
1996
2009
 
1997
2010
 
1998
2011
 
1999
- ### dist/general/object/hasProperty.js
2012
+ ### dist/general/mix/isEmpty.js
2000
2013
 
2001
2014
 
2002
- #### _hasProperty(obj, property)
2015
+ #### isEmpty(variable, includeFalsy)
2003
2016
 
2004
- Use the hasOwnProperty in order to verify if the given property exists in the object.
2017
+ Validates if the given argument is empty
2005
2018
 
2006
2019
 
2007
2020
 
@@ -2010,38 +2023,28 @@ Use the hasOwnProperty in order to verify if the given property exists in the ob
2010
2023
 
2011
2024
  | Name | Type | Description | |
2012
2025
  | ---- | ---- | ----------- | -------- |
2013
- | obj | `object` | an object | &nbsp; |
2014
- | property | `string` | String to verify if exists in the object as property | &nbsp; |
2015
-
2016
-
2017
-
2018
-
2019
- ##### Examples
2026
+ | variable | | the given variable | &nbsp; |
2027
+ | includeFalsy | | flag to determine include the falsy variables into the validation | &nbsp; |
2020
2028
 
2021
- ```javascript
2022
- const prop = 'prop2'
2023
- const obj1 = { prop1: 'hello', prop2: 'world'}
2024
- _hasProperty(ob1, prop1) // true
2025
2029
 
2026
- const obj2 = { prop1: 'hello world' }
2027
- _hasProperty(ob1, prop2) // false
2028
- ```
2029
2030
 
2030
2031
 
2031
2032
  ##### Returns
2032
2033
 
2033
2034
 
2034
- - True if the object has the given property; otherwise, false.
2035
+ - true: the given argument is empty; false: is not.
2035
2036
 
2036
2037
 
2037
2038
 
2038
2039
 
2039
- ### dist/general/object/isObject.js
2040
+ ### dist/general/mix/isNaNV2.js
2040
2041
 
2041
2042
 
2042
- #### isObject(obj)
2043
+ #### isNaNV2(variable)
2043
2044
 
2044
- Checks if the given argument is an object type
2045
+ Validates if the recieved number is NaN type.
2046
+ This function recieves any variable but will return false.
2047
+ Validates if variable is null, undefined, or an empty string, also, the function uses isNaN native function.
2045
2048
 
2046
2049
 
2047
2050
 
@@ -2050,7 +2053,7 @@ Checks if the given argument is an object type
2050
2053
 
2051
2054
  | Name | Type | Description | |
2052
2055
  | ---- | ---- | ----------- | -------- |
2053
- | obj | | the variable to check | &nbsp; |
2056
+ | variable | | the variable to validate | &nbsp; |
2054
2057
 
2055
2058
 
2056
2059
 
@@ -2058,18 +2061,18 @@ Checks if the given argument is an object type
2058
2061
  ##### Returns
2059
2062
 
2060
2063
 
2061
- - True: It is an object; False: It is not.
2064
+ - True if variable is a NaN or false otherwise
2062
2065
 
2063
2066
 
2064
2067
 
2065
2068
 
2066
- ### dist/general/object/mapValues.js
2069
+ ### dist/general/mix/isNull.js
2067
2070
 
2068
2071
 
2069
- #### mapValues(baseObject, iteratee)
2072
+ #### isNull(arg)
2070
2073
 
2071
- Invoke iteratee (function) for each object key-value pair
2072
- and return a mapped object
2074
+ return if a given variable is either `null` or `undefined`
2075
+ useful to avoid falsify validating Number Zero (0)
2073
2076
 
2074
2077
 
2075
2078
 
@@ -2078,8 +2081,7 @@ and return a mapped object
2078
2081
 
2079
2082
  | Name | Type | Description | |
2080
2083
  | ---- | ---- | ----------- | -------- |
2081
- | baseObject | `Object` | Base object. | &nbsp; |
2082
- | iteratee | `Function` | The executed per iteration. | &nbsp; |
2084
+ | arg | `any` | | &nbsp; |
2083
2085
 
2084
2086
 
2085
2087
 
@@ -2087,18 +2089,19 @@ and return a mapped object
2087
2089
  ##### Returns
2088
2090
 
2089
2091
 
2090
- - `Object` New mapped object.
2091
-
2092
-
2092
+ - `Boolean`
2093
2093
 
2094
2094
 
2095
- ### dist/general/object/mergeDeep.js
2096
2095
 
2097
2096
 
2098
- #### mergeDeep(obj1, obj2, settings)
2097
+ ### dist/general/mix/randomId.js
2099
2098
 
2100
- Merges two objects into a new one.
2101
- The second given argument to the first given argument.
2099
+
2100
+ #### randomId(length, exclude)
2101
+
2102
+ Creates a random string
2103
+ - If the first given argument is different than a length number, the variable is replaced by a default number
2104
+ - If the optional second given argument is passed the random string is permutated.
2102
2105
 
2103
2106
 
2104
2107
 
@@ -2107,9 +2110,8 @@ The second given argument to the first given argument.
2107
2110
 
2108
2111
  | Name | Type | Description | |
2109
2112
  | ---- | ---- | ----------- | -------- |
2110
- | obj1 | | The target object | &nbsp; |
2111
- | obj2 | | The object to be merged | &nbsp; |
2112
- | settings | | Object settings for this function | &nbsp; |
2113
+ | length | `Number` | size of the generated string. Default 8 | &nbsp; |
2114
+ | exclude | `Array` | collection of strings that is going to be excluded of the random string. | &nbsp; |
2113
2115
 
2114
2116
 
2115
2117
 
@@ -2117,13 +2119,19 @@ The second given argument to the first given argument.
2117
2119
  ##### Returns
2118
2120
 
2119
2121
 
2120
- - a new merged object
2122
+ - `String` Random string
2121
2123
 
2122
2124
 
2123
2125
 
2124
- #### isValid(obj1, obj2)
2125
2126
 
2126
- Validates if the two arguments are objects
2127
+ ### dist/general/mix/size.js
2128
+
2129
+
2130
+ #### size(obj)
2131
+
2132
+ Gets the length of the given array.
2133
+ - Useful for Object, Array and string type.
2134
+ - For `null` or `undefined` or else argument the returned value will be 0.
2127
2135
 
2128
2136
 
2129
2137
 
@@ -2132,8 +2140,7 @@ Validates if the two arguments are objects
2132
2140
 
2133
2141
  | Name | Type | Description | |
2134
2142
  | ---- | ---- | ----------- | -------- |
2135
- | obj1 | | The target object | &nbsp; |
2136
- | obj2 | | The object to be merged | &nbsp; |
2143
+ | obj | `Any` | Any object-type variable | &nbsp; |
2137
2144
 
2138
2145
 
2139
2146
 
@@ -2141,13 +2148,18 @@ Validates if the two arguments are objects
2141
2148
  ##### Returns
2142
2149
 
2143
2150
 
2144
- - true: they are valid; false: they are not
2151
+ - `Number` the size of the given variable
2145
2152
 
2146
2153
 
2147
2154
 
2148
- #### getParamsToMergeDeep(settings)
2149
2155
 
2150
- Validates and gets the settings with all set parameters.
2156
+ ### dist/general/object/cloneDeep.js
2157
+
2158
+
2159
+ #### cloneDeep(obj)
2160
+
2161
+ A simple Deep Cloning function. Valid only for primivite values and object with primitive values.
2162
+ Not to use this function with inner objects and functions
2151
2163
 
2152
2164
 
2153
2165
 
@@ -2156,7 +2168,7 @@ Validates and gets the settings with all set parameters.
2156
2168
 
2157
2169
  | Name | Type | Description | |
2158
2170
  | ---- | ---- | ----------- | -------- |
2159
- | settings | | the settings object | &nbsp; |
2171
+ | obj | | The object | &nbsp; |
2160
2172
 
2161
2173
 
2162
2174
 
@@ -2164,17 +2176,21 @@ Validates and gets the settings with all set parameters.
2164
2176
  ##### Returns
2165
2177
 
2166
2178
 
2167
- - a new settings object with all set parameters.
2179
+ - The new reference object or the given object if the parsing is incorrect or empty
2168
2180
 
2169
2181
 
2170
2182
 
2171
2183
 
2172
- ### dist/general/object/objectCopy.js
2184
+ ### dist/general/object/get.js
2173
2185
 
2174
2186
 
2175
- #### objectCopy(entity, cache)
2187
+ #### _get(baseObject, path, defaultValue)
2176
2188
 
2177
- Created a new reference of the given argument
2189
+ Like lodash _.get.
2190
+ Gets the value at path of object. If the resolved value is undefined, the defaultValue is returned in its place.
2191
+
2192
+ Empty arrays and empty objects are returned but the defaultValue is not
2193
+ Undefined and null values will return the defaultValue.
2178
2194
 
2179
2195
 
2180
2196
 
@@ -2183,26 +2199,59 @@ Created a new reference of the given argument
2183
2199
 
2184
2200
  | Name | Type | Description | |
2185
2201
  | ---- | ---- | ----------- | -------- |
2186
- | entity | | The variable to be copied | &nbsp; |
2187
- | cache | | | &nbsp; |
2202
+ | baseObject | | The object to query | &nbsp; |
2203
+ | path | | The string path or collection of string paths of the property to get. | &nbsp; |
2204
+ | defaultValue | | The value returned for undefined resolved values. | &nbsp; |
2188
2205
 
2189
2206
 
2190
2207
 
2191
2208
 
2209
+ ##### Examples
2210
+
2211
+ ```javascript
2212
+ // returns 'Hello'
2213
+ _get({ item1: 'Hello', item2: 'World' }, 'item1')
2214
+ ```
2215
+ ```javascript
2216
+ // returns 'A simple Hello'
2217
+ _get({ item1: 'Hello', item2: 'World' }, 'item3', 'A simple Hello')
2218
+ ```
2219
+ ```javascript
2220
+ // returns 'Hello Again'
2221
+ _get({ item1: { item11: 'Hello Again' }, item2: {} }, 'item1.item11')
2222
+ ```
2223
+ ```javascript
2224
+ // returns 'Hello 2'
2225
+ _get({ item1: ['Hello 1', 'Hello 2' }, item2: [] }, 'item1[1]')
2226
+ ```
2227
+ ```javascript
2228
+ // returns 'Hello Again'
2229
+ _get({ item1: { item11: 'Hello Again' }, item2: {} }, ['item1', 'item11'])
2230
+ ```
2231
+
2232
+
2192
2233
  ##### Returns
2193
2234
 
2194
2235
 
2195
- - A new reference of the given argument
2236
+ - the resolved value.
2196
2237
 
2197
2238
 
2198
2239
 
2199
2240
 
2200
- ### dist/general/object/omit.js
2241
+ ### dist/general/object/getAttribute.js
2201
2242
 
2202
2243
 
2203
- #### omit(obj, props)
2244
+ #### getAttribute(obj, key)
2204
2245
 
2205
- return a new Object excluding attributes in _props_ list
2246
+ Searchs for properties in different case styles such as: lower, upper, camel and pascal
2247
+ - To optimize the searching, it is required a key in a snake_case style
2248
+ - List of cases that do not match
2249
+ -- From lower to snake case
2250
+ -- From upper to snake case
2251
+ -- From lower to camel case
2252
+ -- From upper to camel case
2253
+ -- From lower to pascal case
2254
+ -- From upper to pascal case
2206
2255
 
2207
2256
 
2208
2257
 
@@ -2211,26 +2260,33 @@ return a new Object excluding attributes in _props_ list
2211
2260
 
2212
2261
  | Name | Type | Description | |
2213
2262
  | ---- | ---- | ----------- | -------- |
2214
- | obj | `Object` | base object | &nbsp; |
2215
- | props | `Array.<String>` | list of attribute to exclude | &nbsp; |
2263
+ | obj | `object` | object to look for | &nbsp; |
2264
+ | key | `string` | String attribute in snake_case style | &nbsp; |
2265
+
2266
+
2216
2267
 
2217
2268
 
2269
+ ##### Examples
2270
+
2271
+ ```javascript
2272
+ getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
2273
+ ```
2218
2274
 
2219
2275
 
2220
2276
  ##### Returns
2221
2277
 
2222
2278
 
2223
- - `Object` clean object
2279
+ - `Void`
2224
2280
 
2225
2281
 
2226
2282
 
2227
2283
 
2228
- ### dist/general/object/pick.js
2284
+ ### dist/general/object/hasProperty.js
2229
2285
 
2230
2286
 
2231
- #### pick(baseObject, keys)
2287
+ #### _hasProperty(obj, property)
2232
2288
 
2233
- return a new object just with attributes in _keys_ list
2289
+ Use the hasOwnProperty in order to verify if the given property exists in the object.
2234
2290
 
2235
2291
 
2236
2292
 
@@ -2239,26 +2295,38 @@ return a new object just with attributes in _keys_ list
2239
2295
 
2240
2296
  | Name | Type | Description | |
2241
2297
  | ---- | ---- | ----------- | -------- |
2242
- | baseObject | `Object` | base object | &nbsp; |
2243
- | keys | `Array.<String>` | list of attributes to preserve | &nbsp; |
2298
+ | obj | `object` | an object | &nbsp; |
2299
+ | property | `string` | String to verify if exists in the object as property | &nbsp; |
2300
+
2301
+
2302
+
2303
+
2304
+ ##### Examples
2244
2305
 
2306
+ ```javascript
2307
+ const prop = 'prop2'
2308
+ const obj1 = { prop1: 'hello', prop2: 'world'}
2309
+ _hasProperty(ob1, prop1) // true
2245
2310
 
2311
+ const obj2 = { prop1: 'hello world' }
2312
+ _hasProperty(ob1, prop2) // false
2313
+ ```
2246
2314
 
2247
2315
 
2248
2316
  ##### Returns
2249
2317
 
2250
2318
 
2251
- - `Object` new object just with desired attributes
2319
+ - True if the object has the given property; otherwise, false.
2252
2320
 
2253
2321
 
2254
2322
 
2255
2323
 
2256
- ### dist/general/object/serialize.js
2324
+ ### dist/general/object/isObject.js
2257
2325
 
2258
2326
 
2259
- #### serialize(obj)
2327
+ #### isObject(obj)
2260
2328
 
2261
- serialize object to url param
2329
+ Checks if the given argument is an object type
2262
2330
 
2263
2331
 
2264
2332
 
@@ -2267,7 +2335,7 @@ serialize object to url param
2267
2335
 
2268
2336
  | Name | Type | Description | |
2269
2337
  | ---- | ---- | ----------- | -------- |
2270
- | obj | | - Object to be serialized | &nbsp; |
2338
+ | obj | | the variable to check | &nbsp; |
2271
2339
 
2272
2340
 
2273
2341
 
@@ -2275,18 +2343,18 @@ serialize object to url param
2275
2343
  ##### Returns
2276
2344
 
2277
2345
 
2278
- - `Void`
2346
+ - True: It is an object; False: It is not.
2279
2347
 
2280
2348
 
2281
2349
 
2282
2350
 
2283
- ### dist/general/mix/compareDeep.js
2351
+ ### dist/general/object/mapValues.js
2284
2352
 
2285
2353
 
2286
- #### compareDeep(object1, object2)
2354
+ #### mapValues(baseObject, iteratee)
2287
2355
 
2288
- Compares two objects to know if they are equals. Go across nested objects.
2289
- Includes arrays in the comparison.
2356
+ Invoke iteratee (function) for each object key-value pair
2357
+ and return a mapped object
2290
2358
 
2291
2359
 
2292
2360
 
@@ -2295,8 +2363,8 @@ Includes arrays in the comparison.
2295
2363
 
2296
2364
  | Name | Type | Description | |
2297
2365
  | ---- | ---- | ----------- | -------- |
2298
- | object1 | | First Object to compare | &nbsp; |
2299
- | object2 | | Second Object to compare | &nbsp; |
2366
+ | baseObject | `Object` | Base object. | &nbsp; |
2367
+ | iteratee | `Function` | The executed per iteration. | &nbsp; |
2300
2368
 
2301
2369
 
2302
2370
 
@@ -2304,17 +2372,18 @@ Includes arrays in the comparison.
2304
2372
  ##### Returns
2305
2373
 
2306
2374
 
2307
- - True: objects are equal. False: Objects are not equal. Undefined: invalid
2375
+ - `Object` New mapped object.
2308
2376
 
2309
2377
 
2310
2378
 
2311
2379
 
2312
- ### dist/general/mix/getTag.js
2380
+ ### dist/general/object/mergeDeep.js
2313
2381
 
2314
2382
 
2315
- #### getTag(value)
2383
+ #### mergeDeep(obj1, obj2, settings)
2316
2384
 
2317
- Gets the `toStringTag` of `value`.
2385
+ Merges two objects into a new one.
2386
+ The second given argument to the first given argument.
2318
2387
 
2319
2388
 
2320
2389
 
@@ -2323,7 +2392,9 @@ Gets the `toStringTag` of `value`.
2323
2392
 
2324
2393
  | Name | Type | Description | |
2325
2394
  | ---- | ---- | ----------- | -------- |
2326
- | value | | The value to query. | &nbsp; |
2395
+ | obj1 | | The target object | &nbsp; |
2396
+ | obj2 | | The object to be merged | &nbsp; |
2397
+ | settings | | Object settings for this function | &nbsp; |
2327
2398
 
2328
2399
 
2329
2400
 
@@ -2331,17 +2402,13 @@ Gets the `toStringTag` of `value`.
2331
2402
  ##### Returns
2332
2403
 
2333
2404
 
2334
- - `string` Returns the `toStringTag`.
2335
-
2336
-
2337
-
2405
+ - a new merged object
2338
2406
 
2339
- ### dist/general/mix/importScripts.js
2340
2407
 
2341
2408
 
2342
- #### importScripts(scripts)
2409
+ #### isValid(obj1, obj2)
2343
2410
 
2344
- Import a set of external Scripts given the URL in both serie and cascade way
2411
+ Validates if the two arguments are objects
2345
2412
 
2346
2413
 
2347
2414
 
@@ -2350,54 +2417,49 @@ Import a set of external Scripts given the URL in both serie and cascade way
2350
2417
 
2351
2418
  | Name | Type | Description | |
2352
2419
  | ---- | ---- | ----------- | -------- |
2353
- | scripts | `Array.<String>` `Array.<Object>` | can be an array of string or an array of object with the follow structure: | &nbsp; |
2354
- | scripts.url | `String` | CDN URL | &nbsp; |
2355
- | scripts.namespace | `String` `Function` | (Optional) if is a String, that name is evaluated on Window[namespace] object otherwise the Function is invoked expecting a Thrutly value | &nbsp; |
2356
- | scripts.type | `String` | (Optional) it could be `module` of `text/javascript`. Default `text/javascript` | &nbsp; |
2357
- | scripts.noModule | `Boolean` | (Optional) add `momodule` attribute to script tag. Default `false` | &nbsp; |
2358
- | scripts.dependencies | `Array.<Object>` | an array with the same structure to load in cascade mode | &nbsp; |
2420
+ | obj1 | | The target object | &nbsp; |
2421
+ | obj2 | | The object to be merged | &nbsp; |
2359
2422
 
2360
2423
 
2361
2424
 
2362
2425
 
2363
- ##### Examples
2426
+ ##### Returns
2364
2427
 
2365
- ```javascript
2366
- // 1) Simple script (paralell loading)
2367
- importScripts(['http://myscript.js', 'http://another.js']);
2368
2428
 
2369
- // 2) Loading `.js` and `.esm.js` script (parallel loading)
2370
- importScripts([
2371
- { url: 'http://myscript.esm.js', type: 'module' },
2372
- { url: 'http://myscript.js', noModule: true }
2373
- ]);
2429
+ - true: they are valid; false: they are not
2430
+
2431
+
2432
+
2433
+ #### getParamsToMergeDeep(settings)
2434
+
2435
+ Validates and gets the settings with all set parameters.
2436
+
2437
+
2438
+
2439
+
2440
+ ##### Parameters
2441
+
2442
+ | Name | Type | Description | |
2443
+ | ---- | ---- | ----------- | -------- |
2444
+ | settings | | the settings object | &nbsp; |
2374
2445
 
2375
- // 3) import dependent scripts (cascade)
2376
- importScripts([
2377
- { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] }
2378
- ]);
2379
2446
 
2380
- // 4) mix
2381
- importScripts([
2382
- { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] },
2383
- { url: 'http://another.esm.js', type: 'module' },
2384
- { url: 'http://another.js', noModule: true },
2385
- 'http://simplescript.js'
2386
- ]);
2387
- ```
2388
2447
 
2389
2448
 
2390
2449
  ##### Returns
2391
2450
 
2392
2451
 
2393
- - `Promise` Promise when all script have been loaded
2452
+ - a new settings object with all set parameters.
2394
2453
 
2395
2454
 
2396
2455
 
2397
- #### loadScript(url, type, noModule)
2398
2456
 
2399
- Creates the script element and appends to document.head
2400
- return a Promise that is resolved when the script is loaded
2457
+ ### dist/general/object/objectCopy.js
2458
+
2459
+
2460
+ #### objectCopy(entity, cache)
2461
+
2462
+ Created a new reference of the given argument
2401
2463
 
2402
2464
 
2403
2465
 
@@ -2406,9 +2468,8 @@ return a Promise that is resolved when the script is loaded
2406
2468
 
2407
2469
  | Name | Type | Description | |
2408
2470
  | ---- | ---- | ----------- | -------- |
2409
- | url | `String` | Cdn Url | &nbsp; |
2410
- | type | `String` | (Optional) it could be `module` of `text/javascript`. Default `text/javascript` | &nbsp; |
2411
- | noModule | `boolean` | (Optional) add `momodule` attribute to script tag. Default `false` | &nbsp; |
2471
+ | entity | | The variable to be copied | &nbsp; |
2472
+ | cache | | | &nbsp; |
2412
2473
 
2413
2474
 
2414
2475
 
@@ -2416,17 +2477,17 @@ return a Promise that is resolved when the script is loaded
2416
2477
  ##### Returns
2417
2478
 
2418
2479
 
2419
- - `Void`
2480
+ - A new reference of the given argument
2420
2481
 
2421
2482
 
2422
2483
 
2423
2484
 
2424
- ### dist/general/mix/isEmpty.js
2485
+ ### dist/general/object/omit.js
2425
2486
 
2426
2487
 
2427
- #### isEmpty(variable, includeFalsy)
2488
+ #### omit(obj, props)
2428
2489
 
2429
- Validates if the given argument is empty
2490
+ return a new Object excluding attributes in _props_ list
2430
2491
 
2431
2492
 
2432
2493
 
@@ -2435,8 +2496,8 @@ Validates if the given argument is empty
2435
2496
 
2436
2497
  | Name | Type | Description | |
2437
2498
  | ---- | ---- | ----------- | -------- |
2438
- | variable | | the given variable | &nbsp; |
2439
- | includeFalsy | | flag to determine include the falsy variables into the validation | &nbsp; |
2499
+ | obj | `Object` | base object | &nbsp; |
2500
+ | props | `Array.<String>` | list of attribute to exclude | &nbsp; |
2440
2501
 
2441
2502
 
2442
2503
 
@@ -2444,19 +2505,17 @@ Validates if the given argument is empty
2444
2505
  ##### Returns
2445
2506
 
2446
2507
 
2447
- - true: the given argument is empty; false: is not.
2508
+ - `Object` clean object
2448
2509
 
2449
2510
 
2450
2511
 
2451
2512
 
2452
- ### dist/general/mix/isNaNV2.js
2513
+ ### dist/general/object/pick.js
2453
2514
 
2454
2515
 
2455
- #### isNaNV2(variable)
2516
+ #### pick(baseObject, keys)
2456
2517
 
2457
- Validates if the recieved number is NaN type.
2458
- This function recieves any variable but will return false.
2459
- Validates if variable is null, undefined, or an empty string, also, the function uses isNaN native function.
2518
+ return a new object just with attributes in _keys_ list
2460
2519
 
2461
2520
 
2462
2521
 
@@ -2465,7 +2524,8 @@ Validates if variable is null, undefined, or an empty string, also, the function
2465
2524
 
2466
2525
  | Name | Type | Description | |
2467
2526
  | ---- | ---- | ----------- | -------- |
2468
- | variable | | the variable to validate | &nbsp; |
2527
+ | baseObject | `Object` | base object | &nbsp; |
2528
+ | keys | `Array.<String>` | list of attributes to preserve | &nbsp; |
2469
2529
 
2470
2530
 
2471
2531
 
@@ -2473,18 +2533,17 @@ Validates if variable is null, undefined, or an empty string, also, the function
2473
2533
  ##### Returns
2474
2534
 
2475
2535
 
2476
- - True if variable is a NaN or false otherwise
2536
+ - `Object` new object just with desired attributes
2477
2537
 
2478
2538
 
2479
2539
 
2480
2540
 
2481
- ### dist/general/mix/isNull.js
2541
+ ### dist/general/object/serialize.js
2482
2542
 
2483
2543
 
2484
- #### isNull(arg)
2544
+ #### serialize(obj)
2485
2545
 
2486
- return if a given variable is either `null` or `undefined`
2487
- useful to avoid falsify validating Number Zero (0)
2546
+ serialize object to url param
2488
2547
 
2489
2548
 
2490
2549
 
@@ -2493,7 +2552,7 @@ useful to avoid falsify validating Number Zero (0)
2493
2552
 
2494
2553
  | Name | Type | Description | |
2495
2554
  | ---- | ---- | ----------- | -------- |
2496
- | arg | `any` | | &nbsp; |
2555
+ | obj | | - Object to be serialized | &nbsp; |
2497
2556
 
2498
2557
 
2499
2558
 
@@ -2501,19 +2560,17 @@ useful to avoid falsify validating Number Zero (0)
2501
2560
  ##### Returns
2502
2561
 
2503
2562
 
2504
- - `Boolean`
2563
+ - `Void`
2505
2564
 
2506
2565
 
2507
2566
 
2508
2567
 
2509
- ### dist/general/mix/randomId.js
2568
+ ### dist/general/string/capitalize.js
2510
2569
 
2511
2570
 
2512
- #### randomId(length, exclude)
2571
+ #### capitalize(text)
2513
2572
 
2514
- Creates a random string
2515
- - If the first given argument is different than a length number, the variable is replaced by a default number
2516
- - If the optional second given argument is passed the random string is permutated.
2573
+ Upper case the first letter of a given text
2517
2574
 
2518
2575
 
2519
2576
 
@@ -2522,8 +2579,7 @@ Creates a random string
2522
2579
 
2523
2580
  | Name | Type | Description | |
2524
2581
  | ---- | ---- | ----------- | -------- |
2525
- | length | `Number` | size of the generated string. Default 8 | &nbsp; |
2526
- | exclude | `Array` | collection of strings that is going to be excluded of the random string. | &nbsp; |
2582
+ | text | `String` | | &nbsp; |
2527
2583
 
2528
2584
 
2529
2585
 
@@ -2531,55 +2587,52 @@ Creates a random string
2531
2587
  ##### Returns
2532
2588
 
2533
2589
 
2534
- - `String` Random string
2535
-
2536
-
2590
+ - `String` a capitalized text
2537
2591
 
2538
2592
 
2539
- ### dist/general/mix/size.js
2540
2593
 
2541
2594
 
2542
- #### size(obj)
2595
+ ### dist/stencil/decorators/Config.js
2543
2596
 
2544
- Gets the length of the given array.
2545
- - Useful for Object, Array and string type.
2546
- - For `null` or `undefined` or else argument the returned value will be 0.
2547
2597
 
2598
+ #### Config()
2548
2599
 
2600
+ Stencil.js - Prop Decorator
2601
+ 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
2602
+ But for this, is required ask for a property in `snake_case` style
2549
2603
 
2550
2604
 
2551
- ##### Parameters
2552
2605
 
2553
- | Name | Type | Description | |
2554
- | ---- | ---- | ----------- | -------- |
2555
- | obj | `Any` | Any object-type variable | &nbsp; |
2556
2606
 
2557
2607
 
2558
2608
 
2609
+ ##### Examples
2559
2610
 
2560
- ##### Returns
2611
+ ```javascript
2612
+ \ @Config() @Prop() settings;
2561
2613
 
2614
+ someMethod() {
2615
+ this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
2616
+ }
2617
+ ```
2562
2618
 
2563
- - `Number` the size of the given variable
2564
2619
 
2620
+ ##### Returns
2565
2621
 
2566
2622
 
2623
+ - `Void`
2567
2624
 
2568
- ### dist/general/string/capitalize.js
2569
2625
 
2570
2626
 
2571
- #### capitalize(text)
2572
2627
 
2573
- Upper case the first letter of a given text
2628
+ ### dist/stencil/util/createRef.js
2574
2629
 
2575
2630
 
2631
+ #### createRef()
2576
2632
 
2633
+ lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
2577
2634
 
2578
- ##### Parameters
2579
2635
 
2580
- | Name | Type | Description | |
2581
- | ---- | ---- | ----------- | -------- |
2582
- | text | `String` | | &nbsp; |
2583
2636
 
2584
2637
 
2585
2638
 
@@ -2587,17 +2640,21 @@ Upper case the first letter of a given text
2587
2640
  ##### Returns
2588
2641
 
2589
2642
 
2590
- - `String` a capitalized text
2643
+ - function - Function to use in ref prop in html elements
2591
2644
 
2592
2645
 
2593
2646
 
2594
2647
 
2595
- ### dist/qrvey/helpers/getColumnsLabel.js
2648
+ ### dist/stencil/util/getConfig.js
2596
2649
 
2597
2650
 
2598
- #### getColumnLabels(column)
2651
+ #### getConfig(cfg)
2599
2652
 
2600
- Get an string of the properties of the given column.
2653
+ verify the Config object type and try to return a parsed Object
2654
+ - In case _cfg_ is a string, first try to make a JSON parse in other case
2655
+ try to find this string as a variable on Windows object
2656
+ - If _cfg_ is a fuction, tis is invoked and parsed
2657
+ - Finally, if is an object, _cfg_ is inmediatly returned
2601
2658
 
2602
2659
 
2603
2660
 
@@ -2606,7 +2663,7 @@ Get an string of the properties of the given column.
2606
2663
 
2607
2664
  | Name | Type | Description | |
2608
2665
  | ---- | ---- | ----------- | -------- |
2609
- | column | | The column | &nbsp; |
2666
+ | cfg | | | &nbsp; |
2610
2667
 
2611
2668
 
2612
2669
 
@@ -2614,7 +2671,7 @@ Get an string of the properties of the given column.
2614
2671
  ##### Returns
2615
2672
 
2616
2673
 
2617
- - an string with the property, aggregate or calculation label.
2674
+ - `Void`
2618
2675
 
2619
2676
 
2620
2677
 
@@ -2701,35 +2758,29 @@ Get a dataset by Qrvey ID
2701
2758
 
2702
2759
 
2703
2760
 
2704
- ### dist/stencil/decorators/Config.js
2705
-
2761
+ ### dist/qrvey/helpers/getColumnsLabel.js
2706
2762
 
2707
- #### Config()
2708
2763
 
2709
- Stencil.js - Prop Decorator
2710
- Get and Parse the Widget Configuration Object and also provide the ability to get properties in different case styles such as: lower, upper, camel and pascal
2711
- But for this, is required ask for a property in `snake_case` style
2764
+ #### getColumnLabels(column)
2712
2765
 
2766
+ Get an string of the properties of the given column.
2713
2767
 
2714
2768
 
2715
2769
 
2716
2770
 
2771
+ ##### Parameters
2717
2772
 
2718
- ##### Examples
2773
+ | Name | Type | Description | |
2774
+ | ---- | ---- | ----------- | -------- |
2775
+ | column | | The column | &nbsp; |
2719
2776
 
2720
- ```javascript
2721
- \ @Config() @Prop() settings;
2722
2777
 
2723
- someMethod() {
2724
- this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
2725
- }
2726
- ```
2727
2778
 
2728
2779
 
2729
2780
  ##### Returns
2730
2781
 
2731
2782
 
2732
- - `Void`
2783
+ - an string with the property, aggregate or calculation label.
2733
2784
 
2734
2785
 
2735
2786
 
@@ -2788,36 +2839,12 @@ someMethod() {
2788
2839
 
2789
2840
 
2790
2841
 
2791
- ### dist/stencil/util/createRef.js
2792
-
2793
-
2794
- #### createRef()
2795
-
2796
- lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
2797
-
2798
-
2799
-
2800
-
2801
-
2802
-
2803
- ##### Returns
2804
-
2805
-
2806
- - function - Function to use in ref prop in html elements
2807
-
2808
-
2809
-
2810
-
2811
- ### dist/stencil/util/getConfig.js
2842
+ ### dist/dates/relative/helpers/formatStatement.js
2812
2843
 
2813
2844
 
2814
- #### getConfig(cfg)
2845
+ #### formatStatement(statement)
2815
2846
 
2816
- verify the Config object type and try to return a parsed Object
2817
- - In case _cfg_ is a string, first try to make a JSON parse in other case
2818
- try to find this string as a variable on Windows object
2819
- - If _cfg_ is a fuction, tis is invoked and parsed
2820
- - Finally, if is an object, _cfg_ is inmediatly returned
2847
+ Build a proper relative date statement type
2821
2848
 
2822
2849
 
2823
2850
 
@@ -2826,7 +2853,7 @@ try to find this string as a variable on Windows object
2826
2853
 
2827
2854
  | Name | Type | Description | |
2828
2855
  | ---- | ---- | ----------- | -------- |
2829
- | cfg | | | &nbsp; |
2856
+ | statement | `RelativeStatement` | | &nbsp; |
2830
2857
 
2831
2858
 
2832
2859
 
@@ -2834,17 +2861,17 @@ try to find this string as a variable on Windows object
2834
2861
  ##### Returns
2835
2862
 
2836
2863
 
2837
- - `Void`
2864
+ - `RelativeStatement`
2838
2865
 
2839
2866
 
2840
2867
 
2841
2868
 
2842
- ### dist/dates/relative/helpers/formatStatement.js
2869
+ ### dist/dates/relative/helpers/getStatementCase.js
2843
2870
 
2844
2871
 
2845
- #### formatStatement(statement)
2872
+ #### getStatementCase(includeCurrent, isCalendarDate)
2846
2873
 
2847
- Build a proper relative date statement type
2874
+ Returns a number/constant that identifies a relative date case
2848
2875
 
2849
2876
 
2850
2877
 
@@ -2853,7 +2880,8 @@ Build a proper relative date statement type
2853
2880
 
2854
2881
  | Name | Type | Description | |
2855
2882
  | ---- | ---- | ----------- | -------- |
2856
- | statement | `RelativeStatement` | | &nbsp; |
2883
+ | includeCurrent | `boolean` | | &nbsp; |
2884
+ | isCalendarDate | `boolean` | | &nbsp; |
2857
2885
 
2858
2886
 
2859
2887
 
@@ -2861,17 +2889,17 @@ Build a proper relative date statement type
2861
2889
  ##### Returns
2862
2890
 
2863
2891
 
2864
- - `RelativeStatement`
2892
+ - `number`
2865
2893
 
2866
2894
 
2867
2895
 
2868
2896
 
2869
- ### dist/dates/relative/helpers/getStatementCase.js
2897
+ ### dist/dates/relative/helpers/parseDate.js
2870
2898
 
2871
2899
 
2872
- #### getStatementCase(includeCurrent, isCalendarDate)
2900
+ #### parseDate(date)
2873
2901
 
2874
- Returns a number/constant that identifies a relative date case
2902
+ Parses a string date and returns a dayjs date
2875
2903
 
2876
2904
 
2877
2905
 
@@ -2880,8 +2908,7 @@ Returns a number/constant that identifies a relative date case
2880
2908
 
2881
2909
  | Name | Type | Description | |
2882
2910
  | ---- | ---- | ----------- | -------- |
2883
- | includeCurrent | `boolean` | | &nbsp; |
2884
- | isCalendarDate | `boolean` | | &nbsp; |
2911
+ | date | `string` `Dayjs` `Date` | | &nbsp; |
2885
2912
 
2886
2913
 
2887
2914
 
@@ -2889,17 +2916,17 @@ Returns a number/constant that identifies a relative date case
2889
2916
  ##### Returns
2890
2917
 
2891
2918
 
2892
- - `number`
2919
+ - `Dayjs` A dayjs date
2893
2920
 
2894
2921
 
2895
2922
 
2896
2923
 
2897
- ### dist/dates/relative/helpers/parseDate.js
2924
+ ### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
2898
2925
 
2899
2926
 
2900
- #### parseDate(date)
2927
+ #### getFilterBuilderGeneralConfig(config)
2901
2928
 
2902
- Parses a string date and returns a dayjs date
2929
+ Returns a filter builder config object by a any given config
2903
2930
 
2904
2931
 
2905
2932
 
@@ -2908,7 +2935,7 @@ Parses a string date and returns a dayjs date
2908
2935
 
2909
2936
  | Name | Type | Description | |
2910
2937
  | ---- | ---- | ----------- | -------- |
2911
- | date | `string` `Dayjs` `Date` | | &nbsp; |
2938
+ | config | | any config object | &nbsp; |
2912
2939
 
2913
2940
 
2914
2941
 
@@ -2916,7 +2943,7 @@ Parses a string date and returns a dayjs date
2916
2943
  ##### Returns
2917
2944
 
2918
2945
 
2919
- - `Dayjs` A dayjs date
2946
+ - The filter builder config object
2920
2947
 
2921
2948
 
2922
2949
 
@@ -3004,12 +3031,12 @@ Transform user Filters array into Filter Logic structure
3004
3031
 
3005
3032
 
3006
3033
 
3007
- ### dist/filters/helpers/backend/getBackendGroupValue.js
3034
+ ### dist/filters/helpers/backend/getBackendProperty.js
3008
3035
 
3009
3036
 
3010
- #### getBackendGroupValue(filter)
3037
+ #### getBackendProperty(filter)
3011
3038
 
3012
- Gets a group value for the backend logic structure
3039
+ Gets a property for the logic structure
3013
3040
 
3014
3041
 
3015
3042
 
@@ -3031,12 +3058,12 @@ Gets a group value for the backend logic structure
3031
3058
 
3032
3059
 
3033
3060
 
3034
- ### dist/filters/helpers/backend/getBackendProperty.js
3061
+ ### dist/filters/helpers/backend/getBackendGroupValue.js
3035
3062
 
3036
3063
 
3037
- #### getBackendProperty(filter)
3064
+ #### getBackendGroupValue(filter)
3038
3065
 
3039
- Gets a property for the logic structure
3066
+ Gets a group value for the backend logic structure
3040
3067
 
3041
3068
 
3042
3069
 
@@ -3160,34 +3187,6 @@ Gets the Ranking values.
3160
3187
 
3161
3188
 
3162
3189
 
3163
- ### dist/filters/helpers/backend/getLogicByScopes.js
3164
-
3165
-
3166
- #### getLogicByScopes(logics, scopes)
3167
-
3168
- Gets the filters from logic data by Scopes/Scope IDs.
3169
-
3170
-
3171
-
3172
-
3173
- ##### Parameters
3174
-
3175
- | Name | Type | Description | |
3176
- | ---- | ---- | ----------- | -------- |
3177
- | logics | | The logic array | &nbsp; |
3178
- | scopes | | The collection of Scopes/Scope IDs | &nbsp; |
3179
-
3180
-
3181
-
3182
-
3183
- ##### Returns
3184
-
3185
-
3186
- - a new Logic array
3187
-
3188
-
3189
-
3190
-
3191
3190
  ### dist/filters/helpers/backend/getLogicByScopesHierarchy.js
3192
3191
 
3193
3192
 
@@ -3217,12 +3216,12 @@ Gets filters from the logic by the scopes hierarchy.
3217
3216
 
3218
3217
 
3219
3218
 
3220
- ### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
3219
+ ### dist/filters/helpers/backend/getLogicByScopes.js
3221
3220
 
3222
3221
 
3223
- #### getFilterBuilderGeneralConfig(config)
3222
+ #### getLogicByScopes(logics, scopes)
3224
3223
 
3225
- Returns a filter builder config object by a any given config
3224
+ Gets the filters from logic data by Scopes/Scope IDs.
3226
3225
 
3227
3226
 
3228
3227
 
@@ -3231,7 +3230,8 @@ Returns a filter builder config object by a any given config
3231
3230
 
3232
3231
  | Name | Type | Description | |
3233
3232
  | ---- | ---- | ----------- | -------- |
3234
- | config | | any config object | &nbsp; |
3233
+ | logics | | The logic array | &nbsp; |
3234
+ | scopes | | The collection of Scopes/Scope IDs | &nbsp; |
3235
3235
 
3236
3236
 
3237
3237
 
@@ -3239,17 +3239,17 @@ Returns a filter builder config object by a any given config
3239
3239
  ##### Returns
3240
3240
 
3241
3241
 
3242
- - The filter builder config object
3242
+ - a new Logic array
3243
3243
 
3244
3244
 
3245
3245
 
3246
3246
 
3247
- ### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
3247
+ ### dist/filters/helpers/common/areFiltersEquals.js
3248
3248
 
3249
3249
 
3250
- #### excludeUIFiltersByAggregate(uFilters)
3250
+ #### areFiltersEquals(filter1, filter2)
3251
3251
 
3252
- Excludes Aggregate Filters in the Flattened UI Filters array
3252
+ Validates if both filters are the same
3253
3253
 
3254
3254
 
3255
3255
 
@@ -3258,7 +3258,8 @@ Excludes Aggregate Filters in the Flattened UI Filters array
3258
3258
 
3259
3259
  | Name | Type | Description | |
3260
3260
  | ---- | ---- | ----------- | -------- |
3261
- | uFilters | | Collection of Flat UI Filters | &nbsp; |
3261
+ | filter1 | | filter 1 | &nbsp; |
3262
+ | filter2 | | filter 2 | &nbsp; |
3262
3263
 
3263
3264
 
3264
3265
 
@@ -3266,17 +3267,17 @@ Excludes Aggregate Filters in the Flattened UI Filters array
3266
3267
  ##### Returns
3267
3268
 
3268
3269
 
3269
- - a new Flat UI Filters that were excluded the aggregate filters
3270
+ - true: the filters are equal; false: the filters are NOT equal
3270
3271
 
3271
3272
 
3272
3273
 
3273
3274
 
3274
- ### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
3275
+ ### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
3275
3276
 
3276
3277
 
3277
- #### excludeUIFlatFiltersByScopes(uFilters, scopes)
3278
+ #### excludeFiltersByAggregateColumn(filterData)
3278
3279
 
3279
- Excludes and returns a UI Flat Filters without filters by the given scopes
3280
+ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
3280
3281
 
3281
3282
 
3282
3283
 
@@ -3285,8 +3286,7 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
3285
3286
 
3286
3287
  | Name | Type | Description | |
3287
3288
  | ---- | ---- | ----------- | -------- |
3288
- | uFilters | | The Flatten UI Filters | &nbsp; |
3289
- | scopes | | collection of scopes types | &nbsp; |
3289
+ | filterData | | The filter data object | &nbsp; |
3290
3290
 
3291
3291
 
3292
3292
 
@@ -3294,17 +3294,26 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
3294
3294
  ##### Returns
3295
3295
 
3296
3296
 
3297
- - The new array of UI Flattened filters
3297
+ - The new filter data object that were excluded the aggregate filters
3298
3298
 
3299
3299
 
3300
3300
 
3301
3301
 
3302
- ### dist/filters/helpers/ui/getFilterPropertyLabel.js
3302
+ ### dist/filters/helpers/common/excludeFiltersByParams.js
3303
3303
 
3304
3304
 
3305
- #### getFilterPropertyLabel(filter)
3305
+ #### excludeFiltersByParams(filterData, params)
3306
3306
 
3307
- Gets the label of the filter property
3307
+ Excludes filters from the given Filters.
3308
+ The validation to filter the stored filter is depending on:
3309
+ - Column
3310
+ - Qrvey ID
3311
+ - Scope type
3312
+ - Scope ID
3313
+ - Panel ID
3314
+ - Validator type
3315
+ - Property type
3316
+ - Enabled flags
3308
3317
 
3309
3318
 
3310
3319
 
@@ -3313,7 +3322,8 @@ Gets the label of the filter property
3313
3322
 
3314
3323
  | Name | Type | Description | |
3315
3324
  | ---- | ---- | ----------- | -------- |
3316
- | filter | | The UI Filter | &nbsp; |
3325
+ | filterData | | The Filter Data or the UI Filter Data | &nbsp; |
3326
+ | params | | given parameters to validate the filter data | &nbsp; |
3317
3327
 
3318
3328
 
3319
3329
 
@@ -3321,17 +3331,17 @@ Gets the label of the filter property
3321
3331
  ##### Returns
3322
3332
 
3323
3333
 
3324
- - a string of the filter property label
3334
+ - a new Filter object structure
3325
3335
 
3326
3336
 
3327
3337
 
3328
3338
 
3329
- ### dist/filters/helpers/ui/getOutputFormatByColumn.js
3339
+ ### dist/filters/helpers/common/excludeFiltersByScopes.js
3330
3340
 
3331
3341
 
3332
- #### getOutputFormatByColumn(column, datasets)
3342
+ #### excludeFiltersByScopes(filterData, scopes)
3333
3343
 
3334
- Gets output format object from Datasets by the given column. Item of the datasets array must have outputformat item in order to be returned
3344
+ Excludes and returns a filter data without filters by the given scopes
3335
3345
 
3336
3346
 
3337
3347
 
@@ -3340,8 +3350,8 @@ Gets output format object from Datasets by the given column. Item of the dataset
3340
3350
 
3341
3351
  | Name | Type | Description | |
3342
3352
  | ---- | ---- | ----------- | -------- |
3343
- | column | | The column | &nbsp; |
3344
- | datasets | | array of datasets | &nbsp; |
3353
+ | filterData | | The Filter Data | &nbsp; |
3354
+ | scopes | | collection of scopes to be as filtering parameters | &nbsp; |
3345
3355
 
3346
3356
 
3347
3357
 
@@ -3349,74 +3359,71 @@ Gets output format object from Datasets by the given column. Item of the dataset
3349
3359
  ##### Returns
3350
3360
 
3351
3361
 
3352
- - The output format object
3362
+ - The new Filter Data without filters by the given scopes.
3353
3363
 
3354
3364
 
3355
3365
 
3356
3366
 
3357
- ### dist/filters/helpers/ui/getUIFlatFilterByParams.js
3367
+ ### dist/filters/helpers/common/getFilterColumnLabel.js
3358
3368
 
3359
3369
 
3360
- #### getUIFlatFilterByParams()
3370
+ #### getFilterColumnLabel(column)
3361
3371
 
3362
- Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
3363
- The validation to filter the stored filter is depending on:
3364
- - Column
3365
- - Qrvey ID,
3366
- - Scope type
3367
- - Scope ID
3368
- - Panel ID
3369
- - Validator type
3370
- - Property type
3372
+ Get an string of the properties of the given filter column.
3371
3373
 
3372
3374
 
3373
3375
 
3374
3376
 
3377
+ ##### Parameters
3378
+
3379
+ | Name | Type | Description | |
3380
+ | ---- | ---- | ----------- | -------- |
3381
+ | column | | The filter column | &nbsp; |
3382
+
3383
+
3375
3384
 
3376
3385
 
3377
3386
  ##### Returns
3378
3387
 
3379
3388
 
3380
- - The index of the uFilter array or the Filter object s
3389
+ - an string with the property, aggregate or calculation label.
3381
3390
 
3382
3391
 
3383
3392
 
3384
3393
 
3385
- ### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
3394
+ ### dist/filters/helpers/common/getFilterLabel.js
3386
3395
 
3387
3396
 
3388
- #### getUIFlatFiltersByParams()
3397
+ #### getFilterLabel(filter)
3389
3398
 
3390
- Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
3391
- The validation to filter the stored filter is depending on:
3392
- - Column
3393
- - Qrvey ID,
3394
- - Scope type
3395
- - Scope ID
3396
- - Panel ID
3397
- - Validator type
3398
- - Property type
3399
- - Enabled flags
3399
+ Gets the Filter Label + Column label
3400
3400
 
3401
3401
 
3402
3402
 
3403
3403
 
3404
+ ##### Parameters
3405
+
3406
+ | Name | Type | Description | |
3407
+ | ---- | ---- | ----------- | -------- |
3408
+ | filter | | the UI filter | &nbsp; |
3409
+
3410
+
3404
3411
 
3405
3412
 
3406
3413
  ##### Returns
3407
3414
 
3408
3415
 
3409
- - The index of the uFilter array or the Filter object s
3416
+ - a sring label
3410
3417
 
3411
3418
 
3412
3419
 
3413
3420
 
3414
- ### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
3421
+ ### dist/filters/helpers/common/getFiltersByAggregateColumn.js
3415
3422
 
3416
3423
 
3417
- #### getUIFlatFiltersByScopes(uFilters, scopes)
3424
+ #### getFiltersByAggregateColumn(filterData)
3418
3425
 
3419
- Filters and gets a UI Flatten Filters by the given scopes
3426
+ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
3420
3427
 
3421
3428
 
3422
3429
 
@@ -3425,8 +3432,7 @@ Filters and gets a UI Flatten Filters by the given scopes
3425
3432
 
3426
3433
  | Name | Type | Description | |
3427
3434
  | ---- | ---- | ----------- | -------- |
3428
- | uFilters | | The Flatten UI Filters | &nbsp; |
3429
- | scopes | | collection of scopes types | &nbsp; |
3435
+ | filterData | | The filter data object | &nbsp; |
3430
3436
 
3431
3437
 
3432
3438
 
@@ -3434,17 +3440,28 @@ Filters and gets a UI Flatten Filters by the given scopes
3434
3440
  ##### Returns
3435
3441
 
3436
3442
 
3437
- - The new array of UI Flattened filters
3438
-
3443
+ - The new filter data object that were get the aggregate filters
3439
3444
 
3440
3445
 
3441
3446
 
3442
- ### dist/filters/helpers/ui/getUIValues.js
3443
3447
 
3448
+ ### dist/filters/helpers/common/getFilterid.js
3444
3449
 
3445
- #### getUIValues(filter, addEnableds, rankingGroupIndex)
3446
3450
 
3451
+ #### getFilterid(filter)
3447
3452
 
3453
+ Get the Filter ID by the filter structure
3454
+ The order of the epression ID is:
3455
+ - Scope Type
3456
+ - scopeid
3457
+ - qrveyid
3458
+ - panelid
3459
+ - columnid
3460
+ - validator
3461
+ - property
3462
+ - Column Aggregate
3463
+ - Column Calculation
3464
+ - Optional Index
3448
3465
 
3449
3466
 
3450
3467
 
@@ -3453,9 +3470,7 @@ Filters and gets a UI Flatten Filters by the given scopes
3453
3470
 
3454
3471
  | Name | Type | Description | |
3455
3472
  | ---- | ---- | ----------- | -------- |
3456
- | filter | | | &nbsp; |
3457
- | addEnableds | | | &nbsp; |
3458
- | rankingGroupIndex | | | &nbsp; |
3473
+ | filter | | the filter structure | &nbsp; |
3459
3474
 
3460
3475
 
3461
3476
 
@@ -3463,17 +3478,26 @@ Filters and gets a UI Flatten Filters by the given scopes
3463
3478
  ##### Returns
3464
3479
 
3465
3480
 
3466
- -
3481
+ - a text to identify the filter
3467
3482
 
3468
3483
 
3469
3484
 
3470
3485
 
3471
- ### dist/filters/helpers/ui/resolveUIFlatFiltersByParams.js
3486
+ ### dist/filters/helpers/common/getFiltersByParams.js
3472
3487
 
3473
3488
 
3474
- #### resolveUIFlatFilterByParams(filter, params)
3489
+ #### getFiltersByParams(filterData, params)
3475
3490
 
3476
- Resolves conditions between UI flattened filter and given parameters
3491
+ Gets filters from the given params.
3492
+ The validation to filter the stored filter is depending on:
3493
+ - Column
3494
+ - Qrvey ID
3495
+ - Scope type
3496
+ - Scope ID
3497
+ - Panel ID
3498
+ - Validator type
3499
+ - Property type
3500
+ - Enabled flags
3477
3501
 
3478
3502
 
3479
3503
 
@@ -3482,8 +3506,8 @@ Resolves conditions between UI flattened filter and given parameters
3482
3506
 
3483
3507
  | Name | Type | Description | |
3484
3508
  | ---- | ---- | ----------- | -------- |
3485
- | filter | | UI Flatten Filter | &nbsp; |
3486
- | params | | Parameters to validate | &nbsp; |
3509
+ | filterData | | The Filter Data or the UI Filter Data | &nbsp; |
3510
+ | params | | given parameters to validate the dataset | &nbsp; |
3487
3511
 
3488
3512
 
3489
3513
 
@@ -3491,17 +3515,17 @@ Resolves conditions between UI flattened filter and given parameters
3491
3515
  ##### Returns
3492
3516
 
3493
3517
 
3494
- - true: the conditions are satisfied.
3518
+ - a new Filter object structure
3495
3519
 
3496
3520
 
3497
3521
 
3498
3522
 
3499
- ### dist/filters/helpers/common/areFiltersEquals.js
3523
+ ### dist/filters/helpers/common/getFiltersByScopes.js
3500
3524
 
3501
3525
 
3502
- #### areFiltersEquals(filter1, filter2)
3526
+ #### getFiltersByScopes(filterData, scopes)
3503
3527
 
3504
- Validates if both filters are the same
3528
+ Filters and gets a Filter Data by the given scopes
3505
3529
 
3506
3530
 
3507
3531
 
@@ -3510,8 +3534,8 @@ Validates if both filters are the same
3510
3534
 
3511
3535
  | Name | Type | Description | |
3512
3536
  | ---- | ---- | ----------- | -------- |
3513
- | filter1 | | filter 1 | &nbsp; |
3514
- | filter2 | | filter 2 | &nbsp; |
3537
+ | filterData | | The Filter Data | &nbsp; |
3538
+ | scopes | | collection of scopes types | &nbsp; |
3515
3539
 
3516
3540
 
3517
3541
 
@@ -3519,17 +3543,17 @@ Validates if both filters are the same
3519
3543
  ##### Returns
3520
3544
 
3521
3545
 
3522
- - true: the filters are equal; false: the filters are NOT equal
3546
+ - The new Filter Data
3523
3547
 
3524
3548
 
3525
3549
 
3526
3550
 
3527
- ### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
3551
+ ### dist/filters/helpers/common/getFiltersByScopesIds.js
3528
3552
 
3529
3553
 
3530
- #### excludeFiltersByAggregateColumn(filterData)
3554
+ #### getFiltersByScopesIds(filterData, scopes)
3531
3555
 
3532
- Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
3556
+ Gets filters from Filter Data by Scopes/Scope IDs.
3533
3557
 
3534
3558
 
3535
3559
 
@@ -3538,7 +3562,8 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
3538
3562
 
3539
3563
  | Name | Type | Description | |
3540
3564
  | ---- | ---- | ----------- | -------- |
3541
- | filterData | | The filter data object | &nbsp; |
3565
+ | filterData | | The filter data | &nbsp; |
3566
+ | scopes | | The collection of Scopes/Scope IDs | &nbsp; |
3542
3567
 
3543
3568
 
3544
3569
 
@@ -3546,26 +3571,17 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
3546
3571
  ##### Returns
3547
3572
 
3548
3573
 
3549
- - The new filter data object that were excluded the aggregate filters
3574
+ - a new Filter Data
3550
3575
 
3551
3576
 
3552
3577
 
3553
3578
 
3554
- ### dist/filters/helpers/common/excludeFiltersByParams.js
3579
+ ### dist/filters/helpers/common/getFiltersByVisibility.js
3555
3580
 
3556
3581
 
3557
- #### excludeFiltersByParams(filterData, params)
3582
+ #### getFiltersByVisibility(filterData, scopes)
3558
3583
 
3559
- Excludes filters from the given Filters.
3560
- The validation to filter the stored filter is depending on:
3561
- - Column
3562
- - Qrvey ID
3563
- - Scope type
3564
- - Scope ID
3565
- - Panel ID
3566
- - Validator type
3567
- - Property type
3568
- - Enabled flags
3584
+ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
3569
3585
 
3570
3586
 
3571
3587
 
@@ -3574,8 +3590,8 @@ The validation to filter the stored filter is depending on:
3574
3590
 
3575
3591
  | Name | Type | Description | |
3576
3592
  | ---- | ---- | ----------- | -------- |
3577
- | filterData | | The Filter Data or the UI Filter Data | &nbsp; |
3578
- | params | | given parameters to validate the filter data | &nbsp; |
3593
+ | filterData | | a Filter Data or UI Filter Data | &nbsp; |
3594
+ | scopes | | a Scopes/Scope IDs array | &nbsp; |
3579
3595
 
3580
3596
 
3581
3597
 
@@ -3583,17 +3599,17 @@ The validation to filter the stored filter is depending on:
3583
3599
  ##### Returns
3584
3600
 
3585
3601
 
3586
- - a new Filter object structure
3602
+ - a new Filter Data
3587
3603
 
3588
3604
 
3589
3605
 
3590
3606
 
3591
- ### dist/filters/helpers/common/excludeFiltersByScopes.js
3607
+ ### dist/filters/helpers/common/getMergeFiltersSettings.js
3592
3608
 
3593
3609
 
3594
- #### excludeFiltersByScopes(filterData, scopes)
3610
+ #### getMergeFiltersSettings(settings)
3595
3611
 
3596
- Excludes and returns a filter data without filters by the given scopes
3612
+ Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
3597
3613
 
3598
3614
 
3599
3615
 
@@ -3602,8 +3618,7 @@ Excludes and returns a filter data without filters by the given scopes
3602
3618
 
3603
3619
  | Name | Type | Description | |
3604
3620
  | ---- | ---- | ----------- | -------- |
3605
- | filterData | | The Filter Data | &nbsp; |
3606
- | scopes | | collection of scopes to be as filtering parameters | &nbsp; |
3621
+ | settings | | an object to the MergeFilters settings | &nbsp; |
3607
3622
 
3608
3623
 
3609
3624
 
@@ -3611,17 +3626,17 @@ Excludes and returns a filter data without filters by the given scopes
3611
3626
  ##### Returns
3612
3627
 
3613
3628
 
3614
- - The new Filter Data without filters by the given scopes.
3629
+ - a new MergeFilters settings object.
3615
3630
 
3616
3631
 
3617
3632
 
3618
3633
 
3619
- ### dist/filters/helpers/common/getFilterColumnLabel.js
3634
+ ### dist/filters/helpers/common/getParamsToGetFilterSettings.js
3620
3635
 
3621
3636
 
3622
- #### getFilterColumnLabel(column)
3637
+ #### getParamsToGetFilterSettings(settings)
3623
3638
 
3624
- Get an string of the properties of the given filter column.
3639
+ Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
3625
3640
 
3626
3641
 
3627
3642
 
@@ -3630,7 +3645,7 @@ Get an string of the properties of the given filter column.
3630
3645
 
3631
3646
  | Name | Type | Description | |
3632
3647
  | ---- | ---- | ----------- | -------- |
3633
- | column | | The filter column | &nbsp; |
3648
+ | settings | | an object to the ParamsToGetFilter settings | &nbsp; |
3634
3649
 
3635
3650
 
3636
3651
 
@@ -3638,17 +3653,17 @@ Get an string of the properties of the given filter column.
3638
3653
  ##### Returns
3639
3654
 
3640
3655
 
3641
- - an string with the property, aggregate or calculation label.
3656
+ - a new ParamsToGetFilter settings object.
3642
3657
 
3643
3658
 
3644
3659
 
3645
3660
 
3646
- ### dist/filters/helpers/common/getFilterLabel.js
3661
+ ### dist/filters/helpers/common/haveFiltersByDataset.js
3647
3662
 
3648
3663
 
3649
- #### getFilterLabel(filter)
3664
+ #### haveFiltersByDataset(filterData, qrveyid)
3650
3665
 
3651
- Gets the Filter Label + Column label
3666
+ Validates if the filter data has filters by a dataset ID (Qrvey ID).
3652
3667
 
3653
3668
 
3654
3669
 
@@ -3657,7 +3672,8 @@ Gets the Filter Label + Column label
3657
3672
 
3658
3673
  | Name | Type | Description | |
3659
3674
  | ---- | ---- | ----------- | -------- |
3660
- | filter | | the UI filter | &nbsp; |
3675
+ | filterData | | the filter data or the UI filter data. | &nbsp; |
3676
+ | qrveyid | | The Qrvey ID | &nbsp; |
3661
3677
 
3662
3678
 
3663
3679
 
@@ -3665,28 +3681,17 @@ Gets the Filter Label + Column label
3665
3681
  ##### Returns
3666
3682
 
3667
3683
 
3668
- - a sring label
3684
+ - true: the filter data has filters by the Qrvey ID
3669
3685
 
3670
3686
 
3671
3687
 
3672
3688
 
3673
- ### dist/filters/helpers/common/getFilterid.js
3689
+ ### dist/filters/helpers/common/isBetweenValidator.js
3674
3690
 
3675
3691
 
3676
- #### getFilterid(filter)
3692
+ #### isBetweenValidator(validator)
3677
3693
 
3678
- Get the Filter ID by the filter structure
3679
- The order of the epression ID is:
3680
- - Scope Type
3681
- - scopeid
3682
- - qrveyid
3683
- - panelid
3684
- - columnid
3685
- - validator
3686
- - property
3687
- - Column Aggregate
3688
- - Column Calculation
3689
- - Optional Index
3694
+ Validates if the given validator is a Between type
3690
3695
 
3691
3696
 
3692
3697
 
@@ -3695,7 +3700,7 @@ The order of the epression ID is:
3695
3700
 
3696
3701
  | Name | Type | Description | |
3697
3702
  | ---- | ---- | ----------- | -------- |
3698
- | filter | | the filter structure | &nbsp; |
3703
+ | validator | | The validator | &nbsp; |
3699
3704
 
3700
3705
 
3701
3706
 
@@ -3703,17 +3708,17 @@ The order of the epression ID is:
3703
3708
  ##### Returns
3704
3709
 
3705
3710
 
3706
- - a text to identify the filter
3711
+ - true: it is a between validator; false: it is not a between validator
3707
3712
 
3708
3713
 
3709
3714
 
3710
3715
 
3711
- ### dist/filters/helpers/common/getFiltersByAggregateColumn.js
3716
+ ### dist/filters/helpers/common/isDateDistinctProperty.js
3712
3717
 
3713
3718
 
3714
- #### getFiltersByAggregateColumn(filterData)
3719
+ #### isDateDistinctProperty(column, property)
3715
3720
 
3716
- Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
3721
+ Determines if the filter column and property is a distinct group dates type
3717
3722
 
3718
3723
 
3719
3724
 
@@ -3722,7 +3727,8 @@ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggr
3722
3727
 
3723
3728
  | Name | Type | Description | |
3724
3729
  | ---- | ---- | ----------- | -------- |
3725
- | filterData | | The filter data object | &nbsp; |
3730
+ | column | | The filter column | &nbsp; |
3731
+ | property | | The filter property | &nbsp; |
3726
3732
 
3727
3733
 
3728
3734
 
@@ -3730,26 +3736,17 @@ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggr
3730
3736
  ##### Returns
3731
3737
 
3732
3738
 
3733
- - The new filter data object that were get the aggregate filters
3739
+ - True if the given property is included from distinct group dates type
3734
3740
 
3735
3741
 
3736
3742
 
3737
3743
 
3738
- ### dist/filters/helpers/common/getFiltersByParams.js
3744
+ ### dist/filters/helpers/common/isInValidator.js
3739
3745
 
3740
3746
 
3741
- #### getFiltersByParams(filterData, params)
3747
+ #### isInValidator(validator)
3742
3748
 
3743
- Gets filters from the given params.
3744
- The validation to filter the stored filter is depending on:
3745
- - Column
3746
- - Qrvey ID
3747
- - Scope type
3748
- - Scope ID
3749
- - Panel ID
3750
- - Validator type
3751
- - Property type
3752
- - Enabled flags
3749
+ Validates if the given validator is a In type
3753
3750
 
3754
3751
 
3755
3752
 
@@ -3758,8 +3755,7 @@ The validation to filter the stored filter is depending on:
3758
3755
 
3759
3756
  | Name | Type | Description | |
3760
3757
  | ---- | ---- | ----------- | -------- |
3761
- | filterData | | The Filter Data or the UI Filter Data | &nbsp; |
3762
- | params | | given parameters to validate the dataset | &nbsp; |
3758
+ | validator | | The validator | &nbsp; |
3763
3759
 
3764
3760
 
3765
3761
 
@@ -3767,17 +3763,17 @@ The validation to filter the stored filter is depending on:
3767
3763
  ##### Returns
3768
3764
 
3769
3765
 
3770
- - a new Filter object structure
3766
+ - true: it is a In validator; false: it is not a In validator
3771
3767
 
3772
3768
 
3773
3769
 
3774
3770
 
3775
- ### dist/filters/helpers/common/getFiltersByScopes.js
3771
+ ### dist/filters/helpers/common/isNullValidator.js
3776
3772
 
3777
3773
 
3778
- #### getFiltersByScopes(filterData, scopes)
3774
+ #### isNullValidator(validator)
3779
3775
 
3780
- Filters and gets a Filter Data by the given scopes
3776
+ Checks if the given validator is a Null type.
3781
3777
 
3782
3778
 
3783
3779
 
@@ -3786,8 +3782,7 @@ Filters and gets a Filter Data by the given scopes
3786
3782
 
3787
3783
  | Name | Type | Description | |
3788
3784
  | ---- | ---- | ----------- | -------- |
3789
- | filterData | | The Filter Data | &nbsp; |
3790
- | scopes | | collection of scopes types | &nbsp; |
3785
+ | validator | | The Filter Validator | &nbsp; |
3791
3786
 
3792
3787
 
3793
3788
 
@@ -3795,17 +3790,17 @@ Filters and gets a Filter Data by the given scopes
3795
3790
  ##### Returns
3796
3791
 
3797
3792
 
3798
- - The new Filter Data
3793
+ - True: It is a Null Validator; False: It is not a Null Validator.
3799
3794
 
3800
3795
 
3801
3796
 
3802
3797
 
3803
- ### dist/filters/helpers/common/getFiltersByScopesIds.js
3798
+ ### dist/filters/helpers/common/isRangeValidator.js
3804
3799
 
3805
3800
 
3806
- #### getFiltersByScopesIds(filterData, scopes)
3801
+ #### isRangeValidator(validator)
3807
3802
 
3808
- Gets filters from Filter Data by Scopes/Scope IDs.
3803
+ Validates if the given validator is a Range type. Range type means the value has min and max values to filter
3809
3804
 
3810
3805
 
3811
3806
 
@@ -3814,8 +3809,7 @@ Gets filters from Filter Data by Scopes/Scope IDs.
3814
3809
 
3815
3810
  | Name | Type | Description | |
3816
3811
  | ---- | ---- | ----------- | -------- |
3817
- | filterData | | The filter data | &nbsp; |
3818
- | scopes | | The collection of Scopes/Scope IDs | &nbsp; |
3812
+ | validator | | The filter validator | &nbsp; |
3819
3813
 
3820
3814
 
3821
3815
 
@@ -3823,17 +3817,17 @@ Gets filters from Filter Data by Scopes/Scope IDs.
3823
3817
  ##### Returns
3824
3818
 
3825
3819
 
3826
- - a new Filter Data
3820
+ - true: it is a range validator
3827
3821
 
3828
3822
 
3829
3823
 
3830
3824
 
3831
- ### dist/filters/helpers/common/getFiltersByVisibility.js
3825
+ ### dist/filters/helpers/common/mergeFilters.js
3832
3826
 
3833
3827
 
3834
- #### getFiltersByVisibility(filterData, scopes)
3828
+ #### mergeFilters(filterData1, filterData2, overwriteValues)
3835
3829
 
3836
- Get a new Filter Data by filtering scopes/scope IDs and enabled flags
3830
+ Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
3837
3831
 
3838
3832
 
3839
3833
 
@@ -3842,8 +3836,9 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
3842
3836
 
3843
3837
  | Name | Type | Description | |
3844
3838
  | ---- | ---- | ----------- | -------- |
3845
- | filterData | | a Filter Data or UI Filter Data | &nbsp; |
3846
- | scopes | | a Scopes/Scope IDs array | &nbsp; |
3839
+ | filterData1 | | The target filter data | &nbsp; |
3840
+ | filterData2 | | the filter data to be merged | &nbsp; |
3841
+ | overwriteValues | | Flag to overwrite or not the filter values | &nbsp; |
3847
3842
 
3848
3843
 
3849
3844
 
@@ -3851,17 +3846,13 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
3851
3846
  ##### Returns
3852
3847
 
3853
3848
 
3854
- - a new Filter Data
3855
-
3856
-
3857
-
3849
+ - a new filter data structure
3858
3850
 
3859
- ### dist/filters/helpers/common/getMergeFiltersSettings.js
3860
3851
 
3861
3852
 
3862
- #### getMergeFiltersSettings(settings)
3853
+ #### mergeScopes(scopes1, scopes2, overwriteValues)
3863
3854
 
3864
- Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
3855
+ Gets a new scope structure array by merging two scope structures
3865
3856
 
3866
3857
 
3867
3858
 
@@ -3870,7 +3861,9 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
3870
3861
 
3871
3862
  | Name | Type | Description | |
3872
3863
  | ---- | ---- | ----------- | -------- |
3873
- | settings | | an object to the MergeFilters settings | &nbsp; |
3864
+ | scopes1 | | the target scope structure | &nbsp; |
3865
+ | scopes2 | | the scope to be merged | &nbsp; |
3866
+ | overwriteValues | | Flag to overwrite or not the filter values | &nbsp; |
3874
3867
 
3875
3868
 
3876
3869
 
@@ -3878,17 +3871,13 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
3878
3871
  ##### Returns
3879
3872
 
3880
3873
 
3881
- - a new MergeFilters settings object.
3882
-
3883
-
3884
-
3874
+ - a new scope structure array
3885
3875
 
3886
- ### dist/filters/helpers/common/getParamsToGetFilterSettings.js
3887
3876
 
3888
3877
 
3889
- #### getParamsToGetFilterSettings(settings)
3878
+ #### mergeDatasets(datasets1, datasets2, overwriteValues)
3890
3879
 
3891
- Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
3880
+ Gets a new dataset structure array by merging two dataset structures
3892
3881
 
3893
3882
 
3894
3883
 
@@ -3897,7 +3886,9 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
3897
3886
 
3898
3887
  | Name | Type | Description | |
3899
3888
  | ---- | ---- | ----------- | -------- |
3900
- | settings | | an object to the ParamsToGetFilter settings | &nbsp; |
3889
+ | datasets1 | | the target dataset structure | &nbsp; |
3890
+ | datasets2 | | the dataset to be merged | &nbsp; |
3891
+ | overwriteValues | | Flag to overwrite or not the filter values | &nbsp; |
3901
3892
 
3902
3893
 
3903
3894
 
@@ -3905,17 +3896,13 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
3905
3896
  ##### Returns
3906
3897
 
3907
3898
 
3908
- - a new ParamsToGetFilter settings object.
3909
-
3910
-
3911
-
3899
+ - a new dataset structure array
3912
3900
 
3913
- ### dist/filters/helpers/common/haveFiltersByDataset.js
3914
3901
 
3915
3902
 
3916
- #### haveFiltersByDataset(filterData, qrveyid)
3903
+ #### mergeFilterss(filters1, filters2, overwriteValues)
3917
3904
 
3918
- Validates if the filter data has filters by a dataset ID (Qrvey ID).
3905
+ Gets a new filter structure array by merging two filter structures
3919
3906
 
3920
3907
 
3921
3908
 
@@ -3924,8 +3911,9 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
3924
3911
 
3925
3912
  | Name | Type | Description | |
3926
3913
  | ---- | ---- | ----------- | -------- |
3927
- | filterData | | the filter data or the UI filter data. | &nbsp; |
3928
- | qrveyid | | The Qrvey ID | &nbsp; |
3914
+ | filters1 | | the target filter structure | &nbsp; |
3915
+ | filters2 | | the filter to be merged | &nbsp; |
3916
+ | overwriteValues | | Flag to overwrite or not the filter values | &nbsp; |
3929
3917
 
3930
3918
 
3931
3919
 
@@ -3933,17 +3921,13 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
3933
3921
  ##### Returns
3934
3922
 
3935
3923
 
3936
- - true: the filter data has filters by the Qrvey ID
3937
-
3938
-
3939
-
3924
+ - a new filter structure array
3940
3925
 
3941
- ### dist/filters/helpers/common/isBetweenValidator.js
3942
3926
 
3943
3927
 
3944
- #### isBetweenValidator(validator)
3928
+ #### mergeValues(filter1, filter2, overwrite)
3945
3929
 
3946
- Validates if the given validator is a Between type
3930
+ Gets a new value structure array by merging two value structures
3947
3931
 
3948
3932
 
3949
3933
 
@@ -3952,7 +3936,9 @@ Validates if the given validator is a Between type
3952
3936
 
3953
3937
  | Name | Type | Description | |
3954
3938
  | ---- | ---- | ----------- | -------- |
3955
- | validator | | The validator | &nbsp; |
3939
+ | filter1 | | the target filter structure | &nbsp; |
3940
+ | filter2 | | the filter to be used to merge the values | &nbsp; |
3941
+ | overwrite | | Flag to overwrite or not the filter values | &nbsp; |
3956
3942
 
3957
3943
 
3958
3944
 
@@ -3960,17 +3946,17 @@ Validates if the given validator is a Between type
3960
3946
  ##### Returns
3961
3947
 
3962
3948
 
3963
- - true: it is a between validator; false: it is not a between validator
3949
+ - a new value structure array
3964
3950
 
3965
3951
 
3966
3952
 
3967
3953
 
3968
- ### dist/filters/helpers/common/isDateDistinctProperty.js
3954
+ ### dist/filters/helpers/common/isRegularValidator.js
3969
3955
 
3970
3956
 
3971
- #### isDateDistinctProperty(column, property)
3957
+ #### isRegularValidator(validator)
3972
3958
 
3973
- Determines if the filter column and property is a distinct group dates type
3959
+ Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
3974
3960
 
3975
3961
 
3976
3962
 
@@ -3979,8 +3965,7 @@ Determines if the filter column and property is a distinct group dates type
3979
3965
 
3980
3966
  | Name | Type | Description | |
3981
3967
  | ---- | ---- | ----------- | -------- |
3982
- | column | | The filter column | &nbsp; |
3983
- | property | | The filter property | &nbsp; |
3968
+ | validator | | The filter validator | &nbsp; |
3984
3969
 
3985
3970
 
3986
3971
 
@@ -3988,17 +3973,17 @@ Determines if the filter column and property is a distinct group dates type
3988
3973
  ##### Returns
3989
3974
 
3990
3975
 
3991
- - True if the given property is included from distinct group dates type
3976
+ - true: it is a range validator
3992
3977
 
3993
3978
 
3994
3979
 
3995
3980
 
3996
- ### dist/filters/helpers/common/isInValidator.js
3981
+ ### dist/filters/helpers/common/resolveDatasetConditions.js
3997
3982
 
3998
3983
 
3999
- #### isInValidator(validator)
3984
+ #### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
4000
3985
 
4001
- Validates if the given validator is a In type
3986
+ Resolves the conditions by given params
4002
3987
 
4003
3988
 
4004
3989
 
@@ -4007,7 +3992,10 @@ Validates if the given validator is a In type
4007
3992
 
4008
3993
  | Name | Type | Description | |
4009
3994
  | ---- | ---- | ----------- | -------- |
4010
- | validator | | The validator | &nbsp; |
3995
+ | filter | | The dataset structure | &nbsp; |
3996
+ | params | | given parameters to validate the dataset | &nbsp; |
3997
+ | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined | &nbsp; |
3998
+ | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. | &nbsp; |
4011
3999
 
4012
4000
 
4013
4001
 
@@ -4015,17 +4003,17 @@ Validates if the given validator is a In type
4015
4003
  ##### Returns
4016
4004
 
4017
4005
 
4018
- - true: it is a In validator; false: it is not a In validator
4006
+ - true: the condition is satisfied
4019
4007
 
4020
4008
 
4021
4009
 
4022
4010
 
4023
- ### dist/filters/helpers/common/isNullValidator.js
4011
+ ### dist/filters/helpers/common/resolveFilterConditions.js
4024
4012
 
4025
4013
 
4026
- #### isNullValidator(validator)
4014
+ #### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
4027
4015
 
4028
- Checks if the given validator is a Null type.
4016
+ Resolves the conditions by given params
4029
4017
 
4030
4018
 
4031
4019
 
@@ -4034,7 +4022,10 @@ Checks if the given validator is a Null type.
4034
4022
 
4035
4023
  | Name | Type | Description | |
4036
4024
  | ---- | ---- | ----------- | -------- |
4037
- | validator | | The Filter Validator | &nbsp; |
4025
+ | filter | | The filter | &nbsp; |
4026
+ | params | | given parameters to validate the filter | &nbsp; |
4027
+ | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined | &nbsp; |
4028
+ | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. | &nbsp; |
4038
4029
 
4039
4030
 
4040
4031
 
@@ -4042,17 +4033,17 @@ Checks if the given validator is a Null type.
4042
4033
  ##### Returns
4043
4034
 
4044
4035
 
4045
- - True: It is a Null Validator; False: It is not a Null Validator.
4036
+ - true: the condition is satisfied
4046
4037
 
4047
4038
 
4048
4039
 
4049
4040
 
4050
- ### dist/filters/helpers/common/isRangeValidator.js
4041
+ ### dist/filters/helpers/common/resolveScopeConditions.js
4051
4042
 
4052
4043
 
4053
- #### isRangeValidator(validator)
4044
+ #### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
4054
4045
 
4055
- Validates if the given validator is a Range type. Range type means the value has min and max values to filter
4046
+ Resolves the conditions by given params
4056
4047
 
4057
4048
 
4058
4049
 
@@ -4061,7 +4052,10 @@ Validates if the given validator is a Range type. Range type means the value has
4061
4052
 
4062
4053
  | Name | Type | Description | |
4063
4054
  | ---- | ---- | ----------- | -------- |
4064
- | validator | | The filter validator | &nbsp; |
4055
+ | filter | | The filter scope structure | &nbsp; |
4056
+ | params | | given parameters to validate the filter | &nbsp; |
4057
+ | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined | &nbsp; |
4058
+ | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. | &nbsp; |
4065
4059
 
4066
4060
 
4067
4061
 
@@ -4069,17 +4063,17 @@ Validates if the given validator is a Range type. Range type means the value has
4069
4063
  ##### Returns
4070
4064
 
4071
4065
 
4072
- - true: it is a range validator
4066
+ - true: the condition is satisfied
4073
4067
 
4074
4068
 
4075
4069
 
4076
4070
 
4077
- ### dist/filters/helpers/common/isRegularValidator.js
4071
+ ### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
4078
4072
 
4079
4073
 
4080
- #### isRegularValidator(validator)
4074
+ #### excludeUIFiltersByAggregate(uFilters)
4081
4075
 
4082
- Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
4076
+ Excludes Aggregate Filters in the Flattened UI Filters array
4083
4077
 
4084
4078
 
4085
4079
 
@@ -4088,7 +4082,7 @@ Validates if the given validator is a regular type. Regular type means the filte
4088
4082
 
4089
4083
  | Name | Type | Description | |
4090
4084
  | ---- | ---- | ----------- | -------- |
4091
- | validator | | The filter validator | &nbsp; |
4085
+ | uFilters | | Collection of Flat UI Filters | &nbsp; |
4092
4086
 
4093
4087
 
4094
4088
 
@@ -4096,17 +4090,17 @@ Validates if the given validator is a regular type. Regular type means the filte
4096
4090
  ##### Returns
4097
4091
 
4098
4092
 
4099
- - true: it is a range validator
4093
+ - a new Flat UI Filters that were excluded the aggregate filters
4100
4094
 
4101
4095
 
4102
4096
 
4103
4097
 
4104
- ### dist/filters/helpers/common/mergeFilters.js
4098
+ ### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
4105
4099
 
4106
4100
 
4107
- #### mergeFilters(filterData1, filterData2, overwriteValues)
4101
+ #### excludeUIFlatFiltersByScopes(uFilters, scopes)
4108
4102
 
4109
- Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
4103
+ Excludes and returns a UI Flat Filters without filters by the given scopes
4110
4104
 
4111
4105
 
4112
4106
 
@@ -4115,9 +4109,8 @@ Merge filter data structures in a new one. The first Filter Data passed in the a
4115
4109
 
4116
4110
  | Name | Type | Description | |
4117
4111
  | ---- | ---- | ----------- | -------- |
4118
- | filterData1 | | The target filter data | &nbsp; |
4119
- | filterData2 | | the filter data to be merged | &nbsp; |
4120
- | overwriteValues | | Flag to overwrite or not the filter values | &nbsp; |
4112
+ | uFilters | | The Flatten UI Filters | &nbsp; |
4113
+ | scopes | | collection of scopes types | &nbsp; |
4121
4114
 
4122
4115
 
4123
4116
 
@@ -4125,13 +4118,17 @@ Merge filter data structures in a new one. The first Filter Data passed in the a
4125
4118
  ##### Returns
4126
4119
 
4127
4120
 
4128
- - a new filter data structure
4121
+ - The new array of UI Flattened filters
4129
4122
 
4130
4123
 
4131
4124
 
4132
- #### mergeScopes(scopes1, scopes2, overwriteValues)
4133
4125
 
4134
- Gets a new scope structure array by merging two scope structures
4126
+ ### dist/filters/helpers/ui/getFilterPropertyLabel.js
4127
+
4128
+
4129
+ #### getFilterPropertyLabel(filter)
4130
+
4131
+ Gets the label of the filter property
4135
4132
 
4136
4133
 
4137
4134
 
@@ -4140,9 +4137,7 @@ Gets a new scope structure array by merging two scope structures
4140
4137
 
4141
4138
  | Name | Type | Description | |
4142
4139
  | ---- | ---- | ----------- | -------- |
4143
- | scopes1 | | the target scope structure | &nbsp; |
4144
- | scopes2 | | the scope to be merged | &nbsp; |
4145
- | overwriteValues | | Flag to overwrite or not the filter values | &nbsp; |
4140
+ | filter | | The UI Filter | &nbsp; |
4146
4141
 
4147
4142
 
4148
4143
 
@@ -4150,13 +4145,17 @@ Gets a new scope structure array by merging two scope structures
4150
4145
  ##### Returns
4151
4146
 
4152
4147
 
4153
- - a new scope structure array
4148
+ - a string of the filter property label
4154
4149
 
4155
4150
 
4156
4151
 
4157
- #### mergeDatasets(datasets1, datasets2, overwriteValues)
4158
4152
 
4159
- Gets a new dataset structure array by merging two dataset structures
4153
+ ### dist/filters/helpers/ui/getOutputFormatByColumn.js
4154
+
4155
+
4156
+ #### getOutputFormatByColumn(column, datasets)
4157
+
4158
+ Gets output format object from Datasets by the given column. Item of the datasets array must have outputformat item in order to be returned
4160
4159
 
4161
4160
 
4162
4161
 
@@ -4165,9 +4164,8 @@ Gets a new dataset structure array by merging two dataset structures
4165
4164
 
4166
4165
  | Name | Type | Description | |
4167
4166
  | ---- | ---- | ----------- | -------- |
4168
- | datasets1 | | the target dataset structure | &nbsp; |
4169
- | datasets2 | | the dataset to be merged | &nbsp; |
4170
- | overwriteValues | | Flag to overwrite or not the filter values | &nbsp; |
4167
+ | column | | The column | &nbsp; |
4168
+ | datasets | | array of datasets | &nbsp; |
4171
4169
 
4172
4170
 
4173
4171
 
@@ -4175,24 +4173,27 @@ Gets a new dataset structure array by merging two dataset structures
4175
4173
  ##### Returns
4176
4174
 
4177
4175
 
4178
- - a new dataset structure array
4176
+ - The output format object
4179
4177
 
4180
4178
 
4181
4179
 
4182
- #### mergeFilterss(filters1, filters2, overwriteValues)
4183
4180
 
4184
- Gets a new filter structure array by merging two filter structures
4181
+ ### dist/filters/helpers/ui/getUIFlatFilterByParams.js
4185
4182
 
4186
4183
 
4184
+ #### getUIFlatFilterByParams()
4187
4185
 
4186
+ Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
4187
+ The validation to filter the stored filter is depending on:
4188
+ - Column
4189
+ - Qrvey ID,
4190
+ - Scope type
4191
+ - Scope ID
4192
+ - Panel ID
4193
+ - Validator type
4194
+ - Property type
4188
4195
 
4189
- ##### Parameters
4190
4196
 
4191
- | Name | Type | Description | |
4192
- | ---- | ---- | ----------- | -------- |
4193
- | filters1 | | the target filter structure | &nbsp; |
4194
- | filters2 | | the filter to be merged | &nbsp; |
4195
- | overwriteValues | | Flag to overwrite or not the filter values | &nbsp; |
4196
4197
 
4197
4198
 
4198
4199
 
@@ -4200,24 +4201,28 @@ Gets a new filter structure array by merging two filter structures
4200
4201
  ##### Returns
4201
4202
 
4202
4203
 
4203
- - a new filter structure array
4204
+ - The index of the uFilter array or the Filter object s
4204
4205
 
4205
4206
 
4206
4207
 
4207
- #### mergeValues(filter1, filter2, overwrite)
4208
4208
 
4209
- Gets a new value structure array by merging two value structures
4209
+ ### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
4210
4210
 
4211
4211
 
4212
+ #### getUIFlatFiltersByParams()
4212
4213
 
4214
+ Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
4215
+ The validation to filter the stored filter is depending on:
4216
+ - Column
4217
+ - Qrvey ID,
4218
+ - Scope type
4219
+ - Scope ID
4220
+ - Panel ID
4221
+ - Validator type
4222
+ - Property type
4223
+ - Enabled flags
4213
4224
 
4214
- ##### Parameters
4215
4225
 
4216
- | Name | Type | Description | |
4217
- | ---- | ---- | ----------- | -------- |
4218
- | filter1 | | the target filter structure | &nbsp; |
4219
- | filter2 | | the filter to be used to merge the values | &nbsp; |
4220
- | overwrite | | Flag to overwrite or not the filter values | &nbsp; |
4221
4226
 
4222
4227
 
4223
4228
 
@@ -4225,17 +4230,17 @@ Gets a new value structure array by merging two value structures
4225
4230
  ##### Returns
4226
4231
 
4227
4232
 
4228
- - a new value structure array
4233
+ - The index of the uFilter array or the Filter object s
4229
4234
 
4230
4235
 
4231
4236
 
4232
4237
 
4233
- ### dist/filters/helpers/common/resolveDatasetConditions.js
4238
+ ### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
4234
4239
 
4235
4240
 
4236
- #### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
4241
+ #### getUIFlatFiltersByScopes(uFilters, scopes)
4237
4242
 
4238
- Resolves the conditions by given params
4243
+ Filters and gets a UI Flatten Filters by the given scopes
4239
4244
 
4240
4245
 
4241
4246
 
@@ -4244,10 +4249,8 @@ Resolves the conditions by given params
4244
4249
 
4245
4250
  | Name | Type | Description | |
4246
4251
  | ---- | ---- | ----------- | -------- |
4247
- | filter | | The dataset structure | &nbsp; |
4248
- | params | | given parameters to validate the dataset | &nbsp; |
4249
- | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined | &nbsp; |
4250
- | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. | &nbsp; |
4252
+ | uFilters | | The Flatten UI Filters | &nbsp; |
4253
+ | scopes | | collection of scopes types | &nbsp; |
4251
4254
 
4252
4255
 
4253
4256
 
@@ -4255,17 +4258,17 @@ Resolves the conditions by given params
4255
4258
  ##### Returns
4256
4259
 
4257
4260
 
4258
- - true: the condition is satisfied
4261
+ - The new array of UI Flattened filters
4259
4262
 
4260
4263
 
4261
4264
 
4262
4265
 
4263
- ### dist/filters/helpers/common/resolveFilterConditions.js
4266
+ ### dist/filters/helpers/ui/getUIValues.js
4264
4267
 
4265
4268
 
4266
- #### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
4269
+ #### getUIValues(filter, addEnableds, rankingGroupIndex)
4270
+
4267
4271
 
4268
- Resolves the conditions by given params
4269
4272
 
4270
4273
 
4271
4274
 
@@ -4274,10 +4277,9 @@ Resolves the conditions by given params
4274
4277
 
4275
4278
  | Name | Type | Description | |
4276
4279
  | ---- | ---- | ----------- | -------- |
4277
- | filter | | The filter | &nbsp; |
4278
- | params | | given parameters to validate the filter | &nbsp; |
4279
- | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined | &nbsp; |
4280
- | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. | &nbsp; |
4280
+ | filter | | | &nbsp; |
4281
+ | addEnableds | | | &nbsp; |
4282
+ | rankingGroupIndex | | | &nbsp; |
4281
4283
 
4282
4284
 
4283
4285
 
@@ -4285,17 +4287,17 @@ Resolves the conditions by given params
4285
4287
  ##### Returns
4286
4288
 
4287
4289
 
4288
- - true: the condition is satisfied
4290
+ -
4289
4291
 
4290
4292
 
4291
4293
 
4292
4294
 
4293
- ### dist/filters/helpers/common/resolveScopeConditions.js
4295
+ ### dist/filters/helpers/ui/resolveUIFlatFiltersByParams.js
4294
4296
 
4295
4297
 
4296
- #### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
4298
+ #### resolveUIFlatFilterByParams(filter, params)
4297
4299
 
4298
- Resolves the conditions by given params
4300
+ Resolves conditions between UI flattened filter and given parameters
4299
4301
 
4300
4302
 
4301
4303
 
@@ -4304,10 +4306,8 @@ Resolves the conditions by given params
4304
4306
 
4305
4307
  | Name | Type | Description | |
4306
4308
  | ---- | ---- | ----------- | -------- |
4307
- | filter | | The filter scope structure | &nbsp; |
4308
- | params | | given parameters to validate the filter | &nbsp; |
4309
- | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined | &nbsp; |
4310
- | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. | &nbsp; |
4309
+ | filter | | UI Flatten Filter | &nbsp; |
4310
+ | params | | Parameters to validate | &nbsp; |
4311
4311
 
4312
4312
 
4313
4313
 
@@ -4315,7 +4315,7 @@ Resolves the conditions by given params
4315
4315
  ##### Returns
4316
4316
 
4317
4317
 
4318
- - true: the condition is satisfied
4318
+ - true: the conditions are satisfied.
4319
4319
 
4320
4320
 
4321
4321