@qrvey/utils 1.2.4-17 → 1.2.4-20

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.
Files changed (27) hide show
  1. package/README.md +678 -678
  2. package/dist/cjs/globalization/interfaces/II18nServiceTranslateOption.d.ts +1 -1
  3. package/dist/cjs/globalization/interfaces/filters/II18nFilter.d.ts +0 -1
  4. package/dist/cjs/globalization/interfaces/filters/II18nFilterPanel.d.ts +2 -0
  5. package/dist/cjs/globalization/interfaces/filters/II18nFilterPanelScopeTitle.d.ts +10 -0
  6. package/dist/cjs/globalization/interfaces/filters/II18nFilterPanelScopeTitle.js +2 -0
  7. package/dist/cjs/globalization/interfaces/filters/index.d.ts +1 -0
  8. package/dist/cjs/globalization/interfaces/filters/index.js +1 -0
  9. package/dist/cjs/globalization/labels/filters/I18N_FILTER.js +0 -1
  10. package/dist/cjs/globalization/labels/filters/I18N_FILTER_PANEL.js +10 -0
  11. package/dist/globalization/interfaces/II18nServiceTranslateOption.d.ts +1 -1
  12. package/dist/globalization/interfaces/filters/II18nFilter.d.ts +0 -1
  13. package/dist/globalization/interfaces/filters/II18nFilterPanel.d.ts +2 -0
  14. package/dist/globalization/interfaces/filters/II18nFilterPanelScopeTitle.d.ts +10 -0
  15. package/dist/globalization/interfaces/filters/II18nFilterPanelScopeTitle.js +1 -0
  16. package/dist/globalization/interfaces/filters/index.d.ts +1 -0
  17. package/dist/globalization/interfaces/filters/index.js +1 -0
  18. package/dist/globalization/labels/filters/I18N_FILTER.js +0 -1
  19. package/dist/globalization/labels/filters/I18N_FILTER_PANEL.js +10 -0
  20. package/package.json +1 -1
  21. package/src/globalization/interfaces/II18nServiceTranslateOption.ts +1 -1
  22. package/src/globalization/interfaces/filters/II18nFilter.ts +0 -1
  23. package/src/globalization/interfaces/filters/II18nFilterPanel.ts +2 -0
  24. package/src/globalization/interfaces/filters/II18nFilterPanelScopeTitle.ts +10 -0
  25. package/src/globalization/interfaces/filters/index.ts +1 -0
  26. package/src/globalization/labels/filters/I18N_FILTER.ts +0 -1
  27. package/src/globalization/labels/filters/I18N_FILTER_PANEL.ts +10 -0
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-20*
2
2
 
3
3
  > Helper, Utils for all Qrvey Projects
4
4
 
@@ -220,12 +220,12 @@ Transforms String Date from a [Year] format to Date object.
220
220
 
221
221
 
222
222
 
223
- ### dist/dates/helpers/getDateByDateFormat.js
223
+ ### dist/dates/helpers/getDateFormatByProperty.js
224
224
 
225
225
 
226
- #### getDateByDateFormat(date, format, time)
226
+ #### getDateFormatByProperty(property)
227
227
 
228
- Gets a Date Object instance by a Date format
228
+ Gets the date format by the given property
229
229
 
230
230
 
231
231
 
@@ -234,9 +234,7 @@ Gets a Date Object instance by a Date format
234
234
 
235
235
  | Name | Type | Description | |
236
236
  | ---- | ---- | ----------- | -------- |
237
- | date | | String with a formatted date |   |
238
- | format | | The date format |   |
239
- | time | | flag to convert the formatted date to miliseconds |   |
237
+ | property | | The Column Property |   |
240
238
 
241
239
 
242
240
 
@@ -244,17 +242,17 @@ Gets a Date Object instance by a Date format
244
242
  ##### Returns
245
243
 
246
244
 
247
- - a Date object, milisecond time or the same value if date format does not match.
245
+ - The date format
248
246
 
249
247
 
250
248
 
251
249
 
252
- ### dist/dates/helpers/getDateFormatByProperty.js
250
+ ### dist/dates/helpers/getDateByDateFormat.js
253
251
 
254
252
 
255
- #### getDateFormatByProperty(property)
253
+ #### getDateByDateFormat(date, format, time)
256
254
 
257
- Gets the date format by the given property
255
+ Gets a Date Object instance by a Date format
258
256
 
259
257
 
260
258
 
@@ -263,7 +261,9 @@ Gets the date format by the given property
263
261
 
264
262
  | Name | Type | Description | |
265
263
  | ---- | ---- | ----------- | -------- |
266
- | property | | The Column Property |   |
264
+ | date | | String with a formatted date |   |
265
+ | format | | The date format |   |
266
+ | time | | flag to convert the formatted date to miliseconds |   |
267
267
 
268
268
 
269
269
 
@@ -271,7 +271,7 @@ Gets the date format by the given property
271
271
  ##### Returns
272
272
 
273
273
 
274
- - The date format
274
+ - a Date object, milisecond time or the same value if date format does not match.
275
275
 
276
276
 
277
277
 
@@ -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,15 +1669,12 @@ Gets the Scopes IDS for the Available Scope function by any config
1669
1669
 
1670
1670
 
1671
1671
 
1672
- ### dist/general/array/filterNestedTree.js
1672
+ ### dist/general/array/delete.js
1673
1673
 
1674
1674
 
1675
- #### filterNestedTree(arr, childArrKey, condition)
1675
+ #### ArrayDelete(array, index)
1676
1676
 
1677
- Filters a nested tree array by a custom condition on the last child node
1678
- - If the given arguments are not valid, the function returns the first argument.
1679
- - If the childArrKey is not matched in the object, the condition tries to resolve the filter anyway and returns an empty array.
1680
- - If the condition is not fulfilled, the function returns a filtered array, probably a empty array inside of the child array
1677
+ Inmutable Array Item deletion
1681
1678
 
1682
1679
 
1683
1680
 
@@ -1686,9 +1683,8 @@ Filters a nested tree array by a custom condition on the last child node
1686
1683
 
1687
1684
  | Name | Type | Description | |
1688
1685
  | ---- | ---- | ----------- | -------- |
1689
- | arr | | nested tree array |   |
1690
- | childArrKey | | property representing the children array on the nested tree |   |
1691
- | condition | | function callback that determines if the filter is applied on the last child node of the nested tree |   |
1686
+ | array | `Array` | a collection of items to delete |   |
1687
+ | index | `Number` | the position of the item to delete |   |
1692
1688
 
1693
1689
 
1694
1690
 
@@ -1696,17 +1692,20 @@ Filters a nested tree array by a custom condition on the last child node
1696
1692
  ##### Returns
1697
1693
 
1698
1694
 
1699
- - array filtered
1695
+ - a new Array or the given parameter when is empty or not an array
1700
1696
 
1701
1697
 
1702
1698
 
1703
1699
 
1704
- ### dist/general/array/getFirstIndexFromArray.js
1700
+ ### dist/general/array/filterNestedTree.js
1705
1701
 
1706
1702
 
1707
- #### getFirstIndexFromArray(array, callback)
1703
+ #### filterNestedTree(arr, childArrKey, condition)
1708
1704
 
1709
- Gets the first index from the array by a callback condition
1705
+ Filters a nested tree array by a custom condition on the last child node
1706
+ - If the given arguments are not valid, the function returns the first argument.
1707
+ - If the childArrKey is not matched in the object, the condition tries to resolve the filter anyway and returns an empty array.
1708
+ - If the condition is not fulfilled, the function returns a filtered array, probably a empty array inside of the child array
1710
1709
 
1711
1710
 
1712
1711
 
@@ -1715,8 +1714,9 @@ Gets the first index from the array by a callback condition
1715
1714
 
1716
1715
  | Name | Type | Description | |
1717
1716
  | ---- | ---- | ----------- | -------- |
1718
- | array | | |   |
1719
- | callback | | function callback |   |
1717
+ | arr | | nested tree array |   |
1718
+ | childArrKey | | property representing the children array on the nested tree |   |
1719
+ | condition | | function callback that determines if the filter is applied on the last child node of the nested tree |   |
1720
1720
 
1721
1721
 
1722
1722
 
@@ -1724,7 +1724,7 @@ Gets the first index from the array by a callback condition
1724
1724
  ##### Returns
1725
1725
 
1726
1726
 
1727
- - the first index of the array. -1 when the condition is not satisfied
1727
+ - array filtered
1728
1728
 
1729
1729
 
1730
1730
 
@@ -1756,12 +1756,12 @@ Flat deeply an array
1756
1756
 
1757
1757
 
1758
1758
 
1759
- ### dist/general/array/getLastIndexFromArray.js
1759
+ ### dist/general/array/getFirstIndexFromArray.js
1760
1760
 
1761
1761
 
1762
- #### getLastIndexFromArray(array, callback)
1762
+ #### getFirstIndexFromArray(array, callback)
1763
1763
 
1764
- Gets the last index from the array by a callback condition
1764
+ Gets the first index from the array by a callback condition
1765
1765
 
1766
1766
 
1767
1767
 
@@ -1779,17 +1779,17 @@ Gets the last index from the array by a callback condition
1779
1779
  ##### Returns
1780
1780
 
1781
1781
 
1782
- - the last index of the array. -1 when the condition is not satisfied
1782
+ - the first index of the array. -1 when the condition is not satisfied
1783
1783
 
1784
1784
 
1785
1785
 
1786
1786
 
1787
- ### dist/general/array/delete.js
1787
+ ### dist/general/array/getLastIndexFromArray.js
1788
1788
 
1789
1789
 
1790
- #### ArrayDelete(array, index)
1790
+ #### getLastIndexFromArray(array, callback)
1791
1791
 
1792
- Inmutable Array Item deletion
1792
+ Gets the last index from the array by a callback condition
1793
1793
 
1794
1794
 
1795
1795
 
@@ -1798,8 +1798,8 @@ Inmutable Array Item deletion
1798
1798
 
1799
1799
  | Name | Type | Description | |
1800
1800
  | ---- | ---- | ----------- | -------- |
1801
- | array | `Array` | a collection of items to delete |   |
1802
- | index | `Number` | the position of the item to delete |   |
1801
+ | array | | |   |
1802
+ | callback | | function callback |   |
1803
1803
 
1804
1804
 
1805
1805
 
@@ -1807,7 +1807,7 @@ Inmutable Array Item deletion
1807
1807
  ##### Returns
1808
1808
 
1809
1809
 
1810
- - a new Array or the given parameter when is empty or not an array
1810
+ - the last index of the array. -1 when the condition is not satisfied
1811
1811
 
1812
1812
 
1813
1813
 
@@ -1868,13 +1868,13 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
1868
1868
 
1869
1869
 
1870
1870
 
1871
- ### dist/general/object/cloneDeep.js
1871
+ ### dist/general/mix/compareDeep.js
1872
1872
 
1873
1873
 
1874
- #### cloneDeep(obj)
1874
+ #### compareDeep(object1, object2)
1875
1875
 
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
1876
+ Compares two objects to know if they are equals. Go across nested objects.
1877
+ Includes arrays in the comparison.
1878
1878
 
1879
1879
 
1880
1880
 
@@ -1883,7 +1883,8 @@ Not to use this function with inner objects and functions
1883
1883
 
1884
1884
  | Name | Type | Description | |
1885
1885
  | ---- | ---- | ----------- | -------- |
1886
- | obj | | The object |   |
1886
+ | object1 | | First Object to compare |   |
1887
+ | object2 | | Second Object to compare |   |
1887
1888
 
1888
1889
 
1889
1890
 
@@ -1891,21 +1892,17 @@ Not to use this function with inner objects and functions
1891
1892
  ##### Returns
1892
1893
 
1893
1894
 
1894
- - The new reference object or the given object if the parsing is incorrect or empty
1895
-
1895
+ - True: objects are equal. False: Objects are not equal. Undefined: invalid
1896
1896
 
1897
1897
 
1898
1898
 
1899
- ### dist/general/object/get.js
1900
1899
 
1900
+ ### dist/general/mix/getTag.js
1901
1901
 
1902
- #### _get(baseObject, path, defaultValue)
1903
1902
 
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.
1903
+ #### getTag(value)
1906
1904
 
1907
- Empty arrays and empty objects are returned but the defaultValue is not
1908
- Undefined and null values will return the defaultValue.
1905
+ Gets the `toStringTag` of `value`.
1909
1906
 
1910
1907
 
1911
1908
 
@@ -1914,59 +1911,25 @@ Undefined and null values will return the defaultValue.
1914
1911
 
1915
1912
  | Name | Type | Description | |
1916
1913
  | ---- | ---- | ----------- | -------- |
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. |   |
1920
-
1921
-
1922
-
1914
+ | value | | The value to query. |   |
1923
1915
 
1924
- ##### Examples
1925
1916
 
1926
- ```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
- ```
1946
1917
 
1947
1918
 
1948
1919
  ##### Returns
1949
1920
 
1950
1921
 
1951
- - the resolved value.
1922
+ - `string` Returns the `toStringTag`.
1952
1923
 
1953
1924
 
1954
1925
 
1955
1926
 
1956
- ### dist/general/object/getAttribute.js
1927
+ ### dist/general/mix/importScripts.js
1957
1928
 
1958
1929
 
1959
- #### getAttribute(obj, key)
1930
+ #### importScripts(scripts)
1960
1931
 
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
1932
+ Import a set of external Scripts given the URL in both serie and cascade way
1970
1933
 
1971
1934
 
1972
1935
 
@@ -1975,8 +1938,12 @@ Searchs for properties in different case styles such as: lower, upper, camel and
1975
1938
 
1976
1939
  | Name | Type | Description | |
1977
1940
  | ---- | ---- | ----------- | -------- |
1978
- | obj | `object` | object to look for |   |
1979
- | key | `string` | String attribute in snake_case style |   |
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; |
1980
1947
 
1981
1948
 
1982
1949
 
@@ -1984,24 +1951,41 @@ Searchs for properties in different case styles such as: lower, upper, camel and
1984
1951
  ##### Examples
1985
1952
 
1986
1953
  ```javascript
1987
- getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
1988
- ```
1954
+ // 1) Simple script (paralell loading)
1955
+ importScripts(['http://myscript.js', 'http://another.js']);
1989
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
+ ]);
1990
1962
 
1991
- ##### Returns
1963
+ // 3) import dependent scripts (cascade)
1964
+ importScripts([
1965
+ { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] }
1966
+ ]);
1992
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
+ ```
1993
1976
 
1994
- - `Void`
1995
1977
 
1978
+ ##### Returns
1996
1979
 
1997
1980
 
1981
+ - `Promise` Promise when all script have been loaded
1998
1982
 
1999
- ### dist/general/object/hasProperty.js
2000
1983
 
2001
1984
 
2002
- #### _hasProperty(obj, property)
1985
+ #### loadScript(url, type, noModule)
2003
1986
 
2004
- Use the hasOwnProperty in order to verify if the given property exists in the object.
1987
+ Creates the script element and appends to document.head
1988
+ return a Promise that is resolved when the script is loaded
2005
1989
 
2006
1990
 
2007
1991
 
@@ -2010,38 +1994,27 @@ Use the hasOwnProperty in order to verify if the given property exists in the ob
2010
1994
 
2011
1995
  | Name | Type | Description | |
2012
1996
  | ---- | ---- | ----------- | -------- |
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
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; |
2020
2000
 
2021
- ```javascript
2022
- const prop = 'prop2'
2023
- const obj1 = { prop1: 'hello', prop2: 'world'}
2024
- _hasProperty(ob1, prop1) // true
2025
2001
 
2026
- const obj2 = { prop1: 'hello world' }
2027
- _hasProperty(ob1, prop2) // false
2028
- ```
2029
2002
 
2030
2003
 
2031
2004
  ##### Returns
2032
2005
 
2033
2006
 
2034
- - True if the object has the given property; otherwise, false.
2007
+ - `Void`
2035
2008
 
2036
2009
 
2037
2010
 
2038
2011
 
2039
- ### dist/general/object/isObject.js
2012
+ ### dist/general/mix/isEmpty.js
2040
2013
 
2041
2014
 
2042
- #### isObject(obj)
2015
+ #### isEmpty(variable, includeFalsy)
2043
2016
 
2044
- Checks if the given argument is an object type
2017
+ Validates if the given argument is empty
2045
2018
 
2046
2019
 
2047
2020
 
@@ -2050,7 +2023,8 @@ Checks if the given argument is an object type
2050
2023
 
2051
2024
  | Name | Type | Description | |
2052
2025
  | ---- | ---- | ----------- | -------- |
2053
- | obj | | the variable to check | &nbsp; |
2026
+ | variable | | the given variable | &nbsp; |
2027
+ | includeFalsy | | flag to determine include the falsy variables into the validation | &nbsp; |
2054
2028
 
2055
2029
 
2056
2030
 
@@ -2058,123 +2032,19 @@ Checks if the given argument is an object type
2058
2032
  ##### Returns
2059
2033
 
2060
2034
 
2061
- - True: It is an object; False: It is not.
2035
+ - true: the given argument is empty; false: is not.
2062
2036
 
2063
2037
 
2064
2038
 
2065
2039
 
2066
- ### dist/general/object/mapValues.js
2040
+ ### dist/general/mix/isNaNV2.js
2067
2041
 
2068
2042
 
2069
- #### mapValues(baseObject, iteratee)
2043
+ #### isNaNV2(variable)
2070
2044
 
2071
- Invoke iteratee (function) for each object key-value pair
2072
- and return a mapped object
2073
-
2074
-
2075
-
2076
-
2077
- ##### Parameters
2078
-
2079
- | Name | Type | Description | |
2080
- | ---- | ---- | ----------- | -------- |
2081
- | baseObject | `Object` | Base object. | &nbsp; |
2082
- | iteratee | `Function` | The executed per iteration. | &nbsp; |
2083
-
2084
-
2085
-
2086
-
2087
- ##### Returns
2088
-
2089
-
2090
- - `Object` New mapped object.
2091
-
2092
-
2093
-
2094
-
2095
- ### dist/general/object/mergeDeep.js
2096
-
2097
-
2098
- #### mergeDeep(obj1, obj2, settings)
2099
-
2100
- Merges two objects into a new one.
2101
- The second given argument to the first given argument.
2102
-
2103
-
2104
-
2105
-
2106
- ##### Parameters
2107
-
2108
- | Name | Type | Description | |
2109
- | ---- | ---- | ----------- | -------- |
2110
- | obj1 | | The target object | &nbsp; |
2111
- | obj2 | | The object to be merged | &nbsp; |
2112
- | settings | | Object settings for this function | &nbsp; |
2113
-
2114
-
2115
-
2116
-
2117
- ##### Returns
2118
-
2119
-
2120
- - a new merged object
2121
-
2122
-
2123
-
2124
- #### isValid(obj1, obj2)
2125
-
2126
- Validates if the two arguments are objects
2127
-
2128
-
2129
-
2130
-
2131
- ##### Parameters
2132
-
2133
- | Name | Type | Description | |
2134
- | ---- | ---- | ----------- | -------- |
2135
- | obj1 | | The target object | &nbsp; |
2136
- | obj2 | | The object to be merged | &nbsp; |
2137
-
2138
-
2139
-
2140
-
2141
- ##### Returns
2142
-
2143
-
2144
- - true: they are valid; false: they are not
2145
-
2146
-
2147
-
2148
- #### getParamsToMergeDeep(settings)
2149
-
2150
- Validates and gets the settings with all set parameters.
2151
-
2152
-
2153
-
2154
-
2155
- ##### Parameters
2156
-
2157
- | Name | Type | Description | |
2158
- | ---- | ---- | ----------- | -------- |
2159
- | settings | | the settings object | &nbsp; |
2160
-
2161
-
2162
-
2163
-
2164
- ##### Returns
2165
-
2166
-
2167
- - a new settings object with all set parameters.
2168
-
2169
-
2170
-
2171
-
2172
- ### dist/general/object/objectCopy.js
2173
-
2174
-
2175
- #### objectCopy(entity, cache)
2176
-
2177
- Created a new reference of the given argument
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.
2178
2048
 
2179
2049
 
2180
2050
 
@@ -2183,8 +2053,7 @@ Created a new reference of the given argument
2183
2053
 
2184
2054
  | Name | Type | Description | |
2185
2055
  | ---- | ---- | ----------- | -------- |
2186
- | entity | | The variable to be copied | &nbsp; |
2187
- | cache | | | &nbsp; |
2056
+ | variable | | the variable to validate | &nbsp; |
2188
2057
 
2189
2058
 
2190
2059
 
@@ -2192,17 +2061,18 @@ Created a new reference of the given argument
2192
2061
  ##### Returns
2193
2062
 
2194
2063
 
2195
- - A new reference of the given argument
2064
+ - True if variable is a NaN or false otherwise
2196
2065
 
2197
2066
 
2198
2067
 
2199
2068
 
2200
- ### dist/general/object/omit.js
2069
+ ### dist/general/mix/isNull.js
2201
2070
 
2202
2071
 
2203
- #### omit(obj, props)
2072
+ #### isNull(arg)
2204
2073
 
2205
- return a new Object excluding attributes in _props_ list
2074
+ return if a given variable is either `null` or `undefined`
2075
+ useful to avoid falsify validating Number Zero (0)
2206
2076
 
2207
2077
 
2208
2078
 
@@ -2211,8 +2081,7 @@ return a new Object excluding attributes in _props_ list
2211
2081
 
2212
2082
  | Name | Type | Description | |
2213
2083
  | ---- | ---- | ----------- | -------- |
2214
- | obj | `Object` | base object | &nbsp; |
2215
- | props | `Array.<String>` | list of attribute to exclude | &nbsp; |
2084
+ | arg | `any` | | &nbsp; |
2216
2085
 
2217
2086
 
2218
2087
 
@@ -2220,17 +2089,19 @@ return a new Object excluding attributes in _props_ list
2220
2089
  ##### Returns
2221
2090
 
2222
2091
 
2223
- - `Object` clean object
2092
+ - `Boolean`
2224
2093
 
2225
2094
 
2226
2095
 
2227
2096
 
2228
- ### dist/general/object/pick.js
2097
+ ### dist/general/mix/randomId.js
2229
2098
 
2230
2099
 
2231
- #### pick(baseObject, keys)
2100
+ #### randomId(length, exclude)
2232
2101
 
2233
- return a new object just with attributes in _keys_ list
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.
2234
2105
 
2235
2106
 
2236
2107
 
@@ -2239,8 +2110,8 @@ return a new object just with attributes in _keys_ list
2239
2110
 
2240
2111
  | Name | Type | Description | |
2241
2112
  | ---- | ---- | ----------- | -------- |
2242
- | baseObject | `Object` | base object | &nbsp; |
2243
- | keys | `Array.<String>` | list of attributes to preserve | &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; |
2244
2115
 
2245
2116
 
2246
2117
 
@@ -2248,17 +2119,19 @@ return a new object just with attributes in _keys_ list
2248
2119
  ##### Returns
2249
2120
 
2250
2121
 
2251
- - `Object` new object just with desired attributes
2122
+ - `String` Random string
2252
2123
 
2253
2124
 
2254
2125
 
2255
2126
 
2256
- ### dist/general/object/serialize.js
2127
+ ### dist/general/mix/size.js
2257
2128
 
2258
2129
 
2259
- #### serialize(obj)
2130
+ #### size(obj)
2260
2131
 
2261
- serialize object to url param
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.
2262
2135
 
2263
2136
 
2264
2137
 
@@ -2267,7 +2140,7 @@ serialize object to url param
2267
2140
 
2268
2141
  | Name | Type | Description | |
2269
2142
  | ---- | ---- | ----------- | -------- |
2270
- | obj | | - Object to be serialized | &nbsp; |
2143
+ | obj | `Any` | Any object-type variable | &nbsp; |
2271
2144
 
2272
2145
 
2273
2146
 
@@ -2275,18 +2148,18 @@ serialize object to url param
2275
2148
  ##### Returns
2276
2149
 
2277
2150
 
2278
- - `Void`
2151
+ - `Number` the size of the given variable
2279
2152
 
2280
2153
 
2281
2154
 
2282
2155
 
2283
- ### dist/general/mix/compareDeep.js
2156
+ ### dist/general/object/cloneDeep.js
2284
2157
 
2285
2158
 
2286
- #### compareDeep(object1, object2)
2159
+ #### cloneDeep(obj)
2287
2160
 
2288
- Compares two objects to know if they are equals. Go across nested objects.
2289
- Includes arrays in the comparison.
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
2290
2163
 
2291
2164
 
2292
2165
 
@@ -2295,8 +2168,7 @@ Includes arrays in the comparison.
2295
2168
 
2296
2169
  | Name | Type | Description | |
2297
2170
  | ---- | ---- | ----------- | -------- |
2298
- | object1 | | First Object to compare | &nbsp; |
2299
- | object2 | | Second Object to compare | &nbsp; |
2171
+ | obj | | The object | &nbsp; |
2300
2172
 
2301
2173
 
2302
2174
 
@@ -2304,44 +2176,21 @@ Includes arrays in the comparison.
2304
2176
  ##### Returns
2305
2177
 
2306
2178
 
2307
- - True: objects are equal. False: Objects are not equal. Undefined: invalid
2308
-
2309
-
2310
-
2311
-
2312
- ### dist/general/mix/getTag.js
2313
-
2314
-
2315
- #### getTag(value)
2316
-
2317
- Gets the `toStringTag` of `value`.
2318
-
2319
-
2320
-
2321
-
2322
- ##### Parameters
2323
-
2324
- | Name | Type | Description | |
2325
- | ---- | ---- | ----------- | -------- |
2326
- | value | | The value to query. | &nbsp; |
2327
-
2328
-
2329
-
2330
-
2331
- ##### Returns
2332
-
2179
+ - The new reference object or the given object if the parsing is incorrect or empty
2333
2180
 
2334
- - `string` Returns the `toStringTag`.
2335
2181
 
2336
2182
 
2337
2183
 
2184
+ ### dist/general/object/get.js
2338
2185
 
2339
- ### dist/general/mix/importScripts.js
2340
2186
 
2187
+ #### _get(baseObject, path, defaultValue)
2341
2188
 
2342
- #### importScripts(scripts)
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.
2343
2191
 
2344
- Import a set of external Scripts given the URL in both serie and cascade way
2192
+ Empty arrays and empty objects are returned but the defaultValue is not
2193
+ Undefined and null values will return the defaultValue.
2345
2194
 
2346
2195
 
2347
2196
 
@@ -2350,12 +2199,9 @@ Import a set of external Scripts given the URL in both serie and cascade way
2350
2199
 
2351
2200
  | Name | Type | Description | |
2352
2201
  | ---- | ---- | ----------- | -------- |
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; |
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; |
2359
2205
 
2360
2206
 
2361
2207
 
@@ -2363,128 +2209,49 @@ Import a set of external Scripts given the URL in both serie and cascade way
2363
2209
  ##### Examples
2364
2210
 
2365
2211
  ```javascript
2366
- // 1) Simple script (paralell loading)
2367
- importScripts(['http://myscript.js', 'http://another.js']);
2368
-
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
- ]);
2374
-
2375
- // 3) import dependent scripts (cascade)
2376
- importScripts([
2377
- { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] }
2378
- ]);
2379
-
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
- ]);
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'])
2387
2230
  ```
2388
2231
 
2389
2232
 
2390
2233
  ##### Returns
2391
2234
 
2392
2235
 
2393
- - `Promise` Promise when all script have been loaded
2394
-
2395
-
2396
-
2397
- #### loadScript(url, type, noModule)
2398
-
2399
- Creates the script element and appends to document.head
2400
- return a Promise that is resolved when the script is loaded
2401
-
2402
-
2403
-
2404
-
2405
- ##### Parameters
2406
-
2407
- | Name | Type | Description | |
2408
- | ---- | ---- | ----------- | -------- |
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; |
2412
-
2413
-
2414
-
2415
-
2416
- ##### Returns
2417
-
2418
-
2419
- - `Void`
2420
-
2421
-
2422
-
2423
-
2424
- ### dist/general/mix/isEmpty.js
2425
-
2426
-
2427
- #### isEmpty(variable, includeFalsy)
2428
-
2429
- Validates if the given argument is empty
2430
-
2431
-
2432
-
2433
-
2434
- ##### Parameters
2435
-
2436
- | Name | Type | Description | |
2437
- | ---- | ---- | ----------- | -------- |
2438
- | variable | | the given variable | &nbsp; |
2439
- | includeFalsy | | flag to determine include the falsy variables into the validation | &nbsp; |
2440
-
2441
-
2442
-
2443
-
2444
- ##### Returns
2445
-
2446
-
2447
- - true: the given argument is empty; false: is not.
2448
-
2449
-
2450
-
2451
-
2452
- ### dist/general/mix/isNaNV2.js
2453
-
2454
-
2455
- #### isNaNV2(variable)
2456
-
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.
2460
-
2461
-
2462
-
2463
-
2464
- ##### Parameters
2465
-
2466
- | Name | Type | Description | |
2467
- | ---- | ---- | ----------- | -------- |
2468
- | variable | | the variable to validate | &nbsp; |
2469
-
2470
-
2471
-
2472
-
2473
- ##### Returns
2474
-
2475
-
2476
- - True if variable is a NaN or false otherwise
2236
+ - the resolved value.
2477
2237
 
2478
2238
 
2479
2239
 
2480
2240
 
2481
- ### dist/general/mix/isNull.js
2241
+ ### dist/general/object/getAttribute.js
2482
2242
 
2483
2243
 
2484
- #### isNull(arg)
2244
+ #### getAttribute(obj, key)
2485
2245
 
2486
- return if a given variable is either `null` or `undefined`
2487
- useful to avoid falsify validating Number Zero (0)
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
2488
2255
 
2489
2256
 
2490
2257
 
@@ -2493,27 +2260,33 @@ useful to avoid falsify validating Number Zero (0)
2493
2260
 
2494
2261
  | Name | Type | Description | |
2495
2262
  | ---- | ---- | ----------- | -------- |
2496
- | arg | `any` | | &nbsp; |
2263
+ | obj | `object` | object to look for | &nbsp; |
2264
+ | key | `string` | String attribute in snake_case style | &nbsp; |
2265
+
2266
+
2497
2267
 
2498
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
+ ```
2499
2274
 
2500
2275
 
2501
2276
  ##### Returns
2502
2277
 
2503
2278
 
2504
- - `Boolean`
2279
+ - `Void`
2505
2280
 
2506
2281
 
2507
2282
 
2508
2283
 
2509
- ### dist/general/mix/randomId.js
2284
+ ### dist/general/object/hasProperty.js
2510
2285
 
2511
2286
 
2512
- #### randomId(length, exclude)
2287
+ #### _hasProperty(obj, property)
2513
2288
 
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.
2289
+ Use the hasOwnProperty in order to verify if the given property exists in the object.
2517
2290
 
2518
2291
 
2519
2292
 
@@ -2522,28 +2295,38 @@ Creates a random string
2522
2295
 
2523
2296
  | Name | Type | Description | |
2524
2297
  | ---- | ---- | ----------- | -------- |
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; |
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
2527
2305
 
2306
+ ```javascript
2307
+ const prop = 'prop2'
2308
+ const obj1 = { prop1: 'hello', prop2: 'world'}
2309
+ _hasProperty(ob1, prop1) // true
2528
2310
 
2311
+ const obj2 = { prop1: 'hello world' }
2312
+ _hasProperty(ob1, prop2) // false
2313
+ ```
2529
2314
 
2530
2315
 
2531
2316
  ##### Returns
2532
2317
 
2533
2318
 
2534
- - `String` Random string
2319
+ - True if the object has the given property; otherwise, false.
2535
2320
 
2536
2321
 
2537
2322
 
2538
2323
 
2539
- ### dist/general/mix/size.js
2324
+ ### dist/general/object/isObject.js
2540
2325
 
2541
2326
 
2542
- #### size(obj)
2327
+ #### isObject(obj)
2543
2328
 
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.
2329
+ Checks if the given argument is an object type
2547
2330
 
2548
2331
 
2549
2332
 
@@ -2552,7 +2335,7 @@ Gets the length of the given array.
2552
2335
 
2553
2336
  | Name | Type | Description | |
2554
2337
  | ---- | ---- | ----------- | -------- |
2555
- | obj | `Any` | Any object-type variable | &nbsp; |
2338
+ | obj | | the variable to check | &nbsp; |
2556
2339
 
2557
2340
 
2558
2341
 
@@ -2560,17 +2343,18 @@ Gets the length of the given array.
2560
2343
  ##### Returns
2561
2344
 
2562
2345
 
2563
- - `Number` the size of the given variable
2346
+ - True: It is an object; False: It is not.
2564
2347
 
2565
2348
 
2566
2349
 
2567
2350
 
2568
- ### dist/general/string/capitalize.js
2351
+ ### dist/general/object/mapValues.js
2569
2352
 
2570
2353
 
2571
- #### capitalize(text)
2354
+ #### mapValues(baseObject, iteratee)
2572
2355
 
2573
- Upper case the first letter of a given text
2356
+ Invoke iteratee (function) for each object key-value pair
2357
+ and return a mapped object
2574
2358
 
2575
2359
 
2576
2360
 
@@ -2579,7 +2363,8 @@ Upper case the first letter of a given text
2579
2363
 
2580
2364
  | Name | Type | Description | |
2581
2365
  | ---- | ---- | ----------- | -------- |
2582
- | text | `String` | | &nbsp; |
2366
+ | baseObject | `Object` | Base object. | &nbsp; |
2367
+ | iteratee | `Function` | The executed per iteration. | &nbsp; |
2583
2368
 
2584
2369
 
2585
2370
 
@@ -2587,17 +2372,18 @@ Upper case the first letter of a given text
2587
2372
  ##### Returns
2588
2373
 
2589
2374
 
2590
- - `String` a capitalized text
2375
+ - `Object` New mapped object.
2591
2376
 
2592
2377
 
2593
2378
 
2594
2379
 
2595
- ### dist/qrvey/helpers/getColumnsLabel.js
2380
+ ### dist/general/object/mergeDeep.js
2596
2381
 
2597
2382
 
2598
- #### getColumnLabels(column)
2383
+ #### mergeDeep(obj1, obj2, settings)
2599
2384
 
2600
- Get an string of the properties of the given column.
2385
+ Merges two objects into a new one.
2386
+ The second given argument to the first given argument.
2601
2387
 
2602
2388
 
2603
2389
 
@@ -2606,7 +2392,9 @@ Get an string of the properties of the given column.
2606
2392
 
2607
2393
  | Name | Type | Description | |
2608
2394
  | ---- | ---- | ----------- | -------- |
2609
- | column | | The column | &nbsp; |
2395
+ | obj1 | | The target object | &nbsp; |
2396
+ | obj2 | | The object to be merged | &nbsp; |
2397
+ | settings | | Object settings for this function | &nbsp; |
2610
2398
 
2611
2399
 
2612
2400
 
@@ -2614,17 +2402,13 @@ Get an string of the properties of the given column.
2614
2402
  ##### Returns
2615
2403
 
2616
2404
 
2617
- - an string with the property, aggregate or calculation label.
2618
-
2619
-
2620
-
2405
+ - a new merged object
2621
2406
 
2622
- ### dist/services/api/getAllDatasets.api.js
2623
2407
 
2624
2408
 
2625
- #### getAllDatasets(qrveyids)
2409
+ #### isValid(obj1, obj2)
2626
2410
 
2627
- Get a dataset list from a collection of Qrvey IDs
2411
+ Validates if the two arguments are objects
2628
2412
 
2629
2413
 
2630
2414
 
@@ -2633,7 +2417,8 @@ Get a dataset list from a collection of Qrvey IDs
2633
2417
 
2634
2418
  | Name | Type | Description | |
2635
2419
  | ---- | ---- | ----------- | -------- |
2636
- | qrveyids | | Collection of Qrvey IDs | &nbsp; |
2420
+ | obj1 | | The target object | &nbsp; |
2421
+ | obj2 | | The object to be merged | &nbsp; |
2637
2422
 
2638
2423
 
2639
2424
 
@@ -2641,17 +2426,13 @@ Get a dataset list from a collection of Qrvey IDs
2641
2426
  ##### Returns
2642
2427
 
2643
2428
 
2644
- - a promise
2645
-
2646
-
2647
-
2429
+ - true: they are valid; false: they are not
2648
2430
 
2649
- ### dist/services/api/getAllQrveys.api.js
2650
2431
 
2651
2432
 
2652
- #### getAllQrveys(config, params)
2433
+ #### getParamsToMergeDeep(settings)
2653
2434
 
2654
- POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
2435
+ Validates and gets the settings with all set parameters.
2655
2436
 
2656
2437
 
2657
2438
 
@@ -2660,8 +2441,7 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
2660
2441
 
2661
2442
  | Name | Type | Description | |
2662
2443
  | ---- | ---- | ----------- | -------- |
2663
- | config | | Configuration | &nbsp; |
2664
- | params | | Object for getting precise data | &nbsp; |
2444
+ | settings | | the settings object | &nbsp; |
2665
2445
 
2666
2446
 
2667
2447
 
@@ -2669,17 +2449,17 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
2669
2449
  ##### Returns
2670
2450
 
2671
2451
 
2672
- - `Void`
2452
+ - a new settings object with all set parameters.
2673
2453
 
2674
2454
 
2675
2455
 
2676
2456
 
2677
- ### dist/services/api/getDatasetColumns.api.js
2457
+ ### dist/general/object/objectCopy.js
2678
2458
 
2679
2459
 
2680
- #### getDatasetColumns(qrveyid)
2460
+ #### objectCopy(entity, cache)
2681
2461
 
2682
- Get a dataset by Qrvey ID
2462
+ Created a new reference of the given argument
2683
2463
 
2684
2464
 
2685
2465
 
@@ -2688,7 +2468,8 @@ Get a dataset by Qrvey ID
2688
2468
 
2689
2469
  | Name | Type | Description | |
2690
2470
  | ---- | ---- | ----------- | -------- |
2691
- | qrveyid | | The Qrvey ID | &nbsp; |
2471
+ | entity | | The variable to be copied | &nbsp; |
2472
+ | cache | | | &nbsp; |
2692
2473
 
2693
2474
 
2694
2475
 
@@ -2696,50 +2477,45 @@ Get a dataset by Qrvey ID
2696
2477
  ##### Returns
2697
2478
 
2698
2479
 
2699
- - a promise
2700
-
2480
+ - A new reference of the given argument
2701
2481
 
2702
2482
 
2703
2483
 
2704
- ### dist/stencil/decorators/Config.js
2705
2484
 
2485
+ ### dist/general/object/omit.js
2706
2486
 
2707
- #### Config()
2708
2487
 
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
2488
+ #### omit(obj, props)
2712
2489
 
2490
+ return a new Object excluding attributes in _props_ list
2713
2491
 
2714
2492
 
2715
2493
 
2716
2494
 
2495
+ ##### Parameters
2717
2496
 
2718
- ##### Examples
2497
+ | Name | Type | Description | |
2498
+ | ---- | ---- | ----------- | -------- |
2499
+ | obj | `Object` | base object | &nbsp; |
2500
+ | props | `Array.<String>` | list of attribute to exclude | &nbsp; |
2719
2501
 
2720
- ```javascript
2721
- \ @Config() @Prop() settings;
2722
2502
 
2723
- someMethod() {
2724
- this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
2725
- }
2726
- ```
2727
2503
 
2728
2504
 
2729
2505
  ##### Returns
2730
2506
 
2731
2507
 
2732
- - `Void`
2508
+ - `Object` clean object
2733
2509
 
2734
2510
 
2735
2511
 
2736
2512
 
2737
- ### dist/typescript/decorators/Debounce.js
2513
+ ### dist/general/object/pick.js
2738
2514
 
2739
2515
 
2740
- #### Debounce(time)
2516
+ #### pick(baseObject, keys)
2741
2517
 
2742
- (Method Decorator) Debounce Class Method
2518
+ return a new object just with attributes in _keys_ list
2743
2519
 
2744
2520
 
2745
2521
 
@@ -2748,7 +2524,8 @@ someMethod() {
2748
2524
 
2749
2525
  | Name | Type | Description | |
2750
2526
  | ---- | ---- | ----------- | -------- |
2751
- | time | | (optional) deafult 500 | &nbsp; |
2527
+ | baseObject | `Object` | base object | &nbsp; |
2528
+ | keys | `Array.<String>` | list of attributes to preserve | &nbsp; |
2752
2529
 
2753
2530
 
2754
2531
 
@@ -2756,17 +2533,17 @@ someMethod() {
2756
2533
  ##### Returns
2757
2534
 
2758
2535
 
2759
- - `Void`
2536
+ - `Object` new object just with desired attributes
2760
2537
 
2761
2538
 
2762
2539
 
2763
2540
 
2764
- ### dist/typescript/decorators/Throttled.js
2541
+ ### dist/general/object/serialize.js
2765
2542
 
2766
2543
 
2767
- #### Throttled(time)
2544
+ #### serialize(obj)
2768
2545
 
2769
- (Method Decorator) Throttled Class Method
2546
+ serialize object to url param
2770
2547
 
2771
2548
 
2772
2549
 
@@ -2775,7 +2552,7 @@ someMethod() {
2775
2552
 
2776
2553
  | Name | Type | Description | |
2777
2554
  | ---- | ---- | ----------- | -------- |
2778
- | time | | (optional) deafult 500 | &nbsp; |
2555
+ | obj | | - Object to be serialized | &nbsp; |
2779
2556
 
2780
2557
 
2781
2558
 
@@ -2788,36 +2565,12 @@ someMethod() {
2788
2565
 
2789
2566
 
2790
2567
 
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
2568
+ ### dist/general/string/capitalize.js
2812
2569
 
2813
2570
 
2814
- #### getConfig(cfg)
2571
+ #### capitalize(text)
2815
2572
 
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
2573
+ Upper case the first letter of a given text
2821
2574
 
2822
2575
 
2823
2576
 
@@ -2826,7 +2579,7 @@ try to find this string as a variable on Windows object
2826
2579
 
2827
2580
  | Name | Type | Description | |
2828
2581
  | ---- | ---- | ----------- | -------- |
2829
- | cfg | | | &nbsp; |
2582
+ | text | `String` | | &nbsp; |
2830
2583
 
2831
2584
 
2832
2585
 
@@ -2834,17 +2587,17 @@ try to find this string as a variable on Windows object
2834
2587
  ##### Returns
2835
2588
 
2836
2589
 
2837
- - `Void`
2590
+ - `String` a capitalized text
2838
2591
 
2839
2592
 
2840
2593
 
2841
2594
 
2842
- ### dist/dates/relative/helpers/formatStatement.js
2595
+ ### dist/qrvey/helpers/getColumnsLabel.js
2843
2596
 
2844
2597
 
2845
- #### formatStatement(statement)
2598
+ #### getColumnLabels(column)
2846
2599
 
2847
- Build a proper relative date statement type
2600
+ Get an string of the properties of the given column.
2848
2601
 
2849
2602
 
2850
2603
 
@@ -2853,7 +2606,7 @@ Build a proper relative date statement type
2853
2606
 
2854
2607
  | Name | Type | Description | |
2855
2608
  | ---- | ---- | ----------- | -------- |
2856
- | statement | `RelativeStatement` | | &nbsp; |
2609
+ | column | | The column | &nbsp; |
2857
2610
 
2858
2611
 
2859
2612
 
@@ -2861,17 +2614,17 @@ Build a proper relative date statement type
2861
2614
  ##### Returns
2862
2615
 
2863
2616
 
2864
- - `RelativeStatement`
2617
+ - an string with the property, aggregate or calculation label.
2865
2618
 
2866
2619
 
2867
2620
 
2868
2621
 
2869
- ### dist/dates/relative/helpers/getStatementCase.js
2622
+ ### dist/services/api/getAllDatasets.api.js
2870
2623
 
2871
2624
 
2872
- #### getStatementCase(includeCurrent, isCalendarDate)
2625
+ #### getAllDatasets(qrveyids)
2873
2626
 
2874
- Returns a number/constant that identifies a relative date case
2627
+ Get a dataset list from a collection of Qrvey IDs
2875
2628
 
2876
2629
 
2877
2630
 
@@ -2880,8 +2633,7 @@ Returns a number/constant that identifies a relative date case
2880
2633
 
2881
2634
  | Name | Type | Description | |
2882
2635
  | ---- | ---- | ----------- | -------- |
2883
- | includeCurrent | `boolean` | | &nbsp; |
2884
- | isCalendarDate | `boolean` | | &nbsp; |
2636
+ | qrveyids | | Collection of Qrvey IDs | &nbsp; |
2885
2637
 
2886
2638
 
2887
2639
 
@@ -2889,17 +2641,17 @@ Returns a number/constant that identifies a relative date case
2889
2641
  ##### Returns
2890
2642
 
2891
2643
 
2892
- - `number`
2644
+ - a promise
2893
2645
 
2894
2646
 
2895
2647
 
2896
2648
 
2897
- ### dist/dates/relative/helpers/parseDate.js
2649
+ ### dist/services/api/getAllQrveys.api.js
2898
2650
 
2899
2651
 
2900
- #### parseDate(date)
2652
+ #### getAllQrveys(config, params)
2901
2653
 
2902
- Parses a string date and returns a dayjs date
2654
+ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
2903
2655
 
2904
2656
 
2905
2657
 
@@ -2908,7 +2660,8 @@ Parses a string date and returns a dayjs date
2908
2660
 
2909
2661
  | Name | Type | Description | |
2910
2662
  | ---- | ---- | ----------- | -------- |
2911
- | date | `string` `Dayjs` `Date` | | &nbsp; |
2663
+ | config | | Configuration | &nbsp; |
2664
+ | params | | Object for getting precise data | &nbsp; |
2912
2665
 
2913
2666
 
2914
2667
 
@@ -2916,18 +2669,17 @@ Parses a string date and returns a dayjs date
2916
2669
  ##### Returns
2917
2670
 
2918
2671
 
2919
- - `Dayjs` A dayjs date
2672
+ - `Void`
2920
2673
 
2921
2674
 
2922
2675
 
2923
2676
 
2924
- ### dist/filters/helpers/backend/buildExpression.js
2677
+ ### dist/services/api/getDatasetColumns.api.js
2925
2678
 
2926
2679
 
2927
- #### buildExpression(filter)
2680
+ #### getDatasetColumns(qrveyid)
2928
2681
 
2929
- Builds filter expression by the filter data.
2930
- - If the resulting value array is empty the enabled property will be false.
2682
+ Get a dataset by Qrvey ID
2931
2683
 
2932
2684
 
2933
2685
 
@@ -2936,7 +2688,7 @@ Builds filter expression by the filter data.
2936
2688
 
2937
2689
  | Name | Type | Description | |
2938
2690
  | ---- | ---- | ----------- | -------- |
2939
- | filter | | The filter to transform | &nbsp; |
2691
+ | qrveyid | | The Qrvey ID | &nbsp; |
2940
2692
 
2941
2693
 
2942
2694
 
@@ -2944,54 +2696,52 @@ Builds filter expression by the filter data.
2944
2696
  ##### Returns
2945
2697
 
2946
2698
 
2947
- - a filter expression
2948
-
2949
-
2950
-
2699
+ - a promise
2951
2700
 
2952
- ### dist/filters/helpers/backend/buildUserFilters.js
2953
2701
 
2954
2702
 
2955
- #### buildUserFilters(userFilters)
2956
2703
 
2957
- Transform user Filters array into Filter Logic structure
2704
+ ### dist/stencil/decorators/Config.js
2958
2705
 
2959
2706
 
2707
+ #### Config()
2960
2708
 
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
2961
2712
 
2962
- ##### Parameters
2963
2713
 
2964
- | Name | Type | Description | |
2965
- | ---- | ---- | ----------- | -------- |
2966
- | userFilters | | The filters that the user defined. | &nbsp; |
2967
2714
 
2968
2715
 
2969
2716
 
2970
2717
 
2971
- ##### Returns
2718
+ ##### Examples
2972
2719
 
2720
+ ```javascript
2721
+ \ @Config() @Prop() settings;
2973
2722
 
2974
- - The filter logic for the given user filters. if No a given object is recieved, it will return an empty array.
2723
+ someMethod() {
2724
+ this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
2725
+ }
2726
+ ```
2975
2727
 
2976
2728
 
2729
+ ##### Returns
2977
2730
 
2978
2731
 
2979
- ### dist/filters/helpers/backend/getAggFiltersBySummaryIndex.js
2732
+ - `Void`
2980
2733
 
2981
2734
 
2982
- #### getAggFiltersBySummaryIndex(aggFilters, summaryIndex)
2983
2735
 
2984
2736
 
2737
+ ### dist/stencil/util/createRef.js
2985
2738
 
2986
2739
 
2740
+ #### createRef()
2987
2741
 
2742
+ lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
2988
2743
 
2989
- ##### Parameters
2990
2744
 
2991
- | Name | Type | Description | |
2992
- | ---- | ---- | ----------- | -------- |
2993
- | aggFilters | | | &nbsp; |
2994
- | summaryIndex | | | &nbsp; |
2995
2745
 
2996
2746
 
2997
2747
 
@@ -2999,17 +2749,21 @@ Transform user Filters array into Filter Logic structure
2999
2749
  ##### Returns
3000
2750
 
3001
2751
 
3002
- -
2752
+ - function - Function to use in ref prop in html elements
3003
2753
 
3004
2754
 
3005
2755
 
3006
2756
 
3007
- ### dist/filters/helpers/backend/getBackendGroupValue.js
2757
+ ### dist/stencil/util/getConfig.js
3008
2758
 
3009
2759
 
3010
- #### getBackendGroupValue(filter)
2760
+ #### getConfig(cfg)
3011
2761
 
3012
- Gets a group value for the backend logic structure
2762
+ verify the Config object type and try to return a parsed Object
2763
+ - In case _cfg_ is a string, first try to make a JSON parse in other case
2764
+ try to find this string as a variable on Windows object
2765
+ - If _cfg_ is a fuction, tis is invoked and parsed
2766
+ - Finally, if is an object, _cfg_ is inmediatly returned
3013
2767
 
3014
2768
 
3015
2769
 
@@ -3018,7 +2772,7 @@ Gets a group value for the backend logic structure
3018
2772
 
3019
2773
  | Name | Type | Description | |
3020
2774
  | ---- | ---- | ----------- | -------- |
3021
- | filter | | The filter | &nbsp; |
2775
+ | cfg | | | &nbsp; |
3022
2776
 
3023
2777
 
3024
2778
 
@@ -3026,17 +2780,17 @@ Gets a group value for the backend logic structure
3026
2780
  ##### Returns
3027
2781
 
3028
2782
 
3029
- - a property
2783
+ - `Void`
3030
2784
 
3031
2785
 
3032
2786
 
3033
2787
 
3034
- ### dist/filters/helpers/backend/getBackendProperty.js
2788
+ ### dist/typescript/decorators/Debounce.js
3035
2789
 
3036
2790
 
3037
- #### getBackendProperty(filter)
2791
+ #### Debounce(time)
3038
2792
 
3039
- Gets a property for the logic structure
2793
+ (Method Decorator) Debounce Class Method
3040
2794
 
3041
2795
 
3042
2796
 
@@ -3045,7 +2799,7 @@ Gets a property for the logic structure
3045
2799
 
3046
2800
  | Name | Type | Description | |
3047
2801
  | ---- | ---- | ----------- | -------- |
3048
- | filter | | The filter | &nbsp; |
2802
+ | time | | (optional) deafult 500 | &nbsp; |
3049
2803
 
3050
2804
 
3051
2805
 
@@ -3053,17 +2807,17 @@ Gets a property for the logic structure
3053
2807
  ##### Returns
3054
2808
 
3055
2809
 
3056
- - a property
2810
+ - `Void`
3057
2811
 
3058
2812
 
3059
2813
 
3060
2814
 
3061
- ### dist/filters/helpers/backend/getBackendValidator.js
2815
+ ### dist/typescript/decorators/Throttled.js
3062
2816
 
3063
2817
 
3064
- #### getBackendValidator(validator)
2818
+ #### Throttled(time)
3065
2819
 
3066
- Gets the Validator that is used in requests
2820
+ (Method Decorator) Throttled Class Method
3067
2821
 
3068
2822
 
3069
2823
 
@@ -3072,7 +2826,7 @@ Gets the Validator that is used in requests
3072
2826
 
3073
2827
  | Name | Type | Description | |
3074
2828
  | ---- | ---- | ----------- | -------- |
3075
- | validator | | Filter Validator used in UI | &nbsp; |
2829
+ | time | | (optional) deafult 500 | &nbsp; |
3076
2830
 
3077
2831
 
3078
2832
 
@@ -3080,17 +2834,17 @@ Gets the Validator that is used in requests
3080
2834
  ##### Returns
3081
2835
 
3082
2836
 
3083
- - Filter Validator used in Backend
2837
+ - `Void`
3084
2838
 
3085
2839
 
3086
2840
 
3087
2841
 
3088
- ### dist/filters/helpers/backend/getBackendValues.js
2842
+ ### dist/dates/relative/helpers/formatStatement.js
3089
2843
 
3090
2844
 
3091
- #### getBackendValues(filter)
2845
+ #### formatStatement(statement)
3092
2846
 
3093
- Gets the expresion values in the logic format
2847
+ Build a proper relative date statement type
3094
2848
 
3095
2849
 
3096
2850
 
@@ -3099,7 +2853,7 @@ Gets the expresion values in the logic format
3099
2853
 
3100
2854
  | Name | Type | Description | |
3101
2855
  | ---- | ---- | ----------- | -------- |
3102
- | filter | | The filter structure | &nbsp; |
2856
+ | statement | `RelativeStatement` | | &nbsp; |
3103
2857
 
3104
2858
 
3105
2859
 
@@ -3107,13 +2861,17 @@ Gets the expresion values in the logic format
3107
2861
  ##### Returns
3108
2862
 
3109
2863
 
3110
- - A collection of backend expression value
2864
+ - `RelativeStatement`
3111
2865
 
3112
2866
 
3113
2867
 
3114
- #### getResultValues(values, filter)
3115
2868
 
3116
- Gets the expression values. Depending on the column type
2869
+ ### dist/dates/relative/helpers/getStatementCase.js
2870
+
2871
+
2872
+ #### getStatementCase(includeCurrent, isCalendarDate)
2873
+
2874
+ Returns a number/constant that identifies a relative date case
3117
2875
 
3118
2876
 
3119
2877
 
@@ -3122,8 +2880,8 @@ Gets the expression values. Depending on the column type
3122
2880
 
3123
2881
  | Name | Type | Description | |
3124
2882
  | ---- | ---- | ----------- | -------- |
3125
- | values | | a collection of filter values | &nbsp; |
3126
- | filter | | The filter structure | &nbsp; |
2883
+ | includeCurrent | `boolean` | | &nbsp; |
2884
+ | isCalendarDate | `boolean` | | &nbsp; |
3127
2885
 
3128
2886
 
3129
2887
 
@@ -3131,13 +2889,17 @@ Gets the expression values. Depending on the column type
3131
2889
  ##### Returns
3132
2890
 
3133
2891
 
3134
- -
2892
+ - `number`
3135
2893
 
3136
2894
 
3137
2895
 
3138
- #### getRankingValues(values, rankingGroupIndex)
3139
2896
 
3140
- Gets the Ranking values.
2897
+ ### dist/dates/relative/helpers/parseDate.js
2898
+
2899
+
2900
+ #### parseDate(date)
2901
+
2902
+ Parses a string date and returns a dayjs date
3141
2903
 
3142
2904
 
3143
2905
 
@@ -3146,8 +2908,7 @@ Gets the Ranking values.
3146
2908
 
3147
2909
  | Name | Type | Description | |
3148
2910
  | ---- | ---- | ----------- | -------- |
3149
- | values | | a collection of filter values in the ranking structure | &nbsp; |
3150
- | rankingGroupIndex | | determine the value by this index to build and return it | &nbsp; |
2911
+ | date | `string` `Dayjs` `Date` | | &nbsp; |
3151
2912
 
3152
2913
 
3153
2914
 
@@ -3155,17 +2916,18 @@ Gets the Ranking values.
3155
2916
  ##### Returns
3156
2917
 
3157
2918
 
3158
- - Expression values for ranking
2919
+ - `Dayjs` A dayjs date
3159
2920
 
3160
2921
 
3161
2922
 
3162
2923
 
3163
- ### dist/filters/helpers/backend/getLogicByScopes.js
2924
+ ### dist/filters/helpers/backend/buildExpression.js
3164
2925
 
3165
2926
 
3166
- #### getLogicByScopes(logics, scopes)
2927
+ #### buildExpression(filter)
3167
2928
 
3168
- Gets the filters from logic data by Scopes/Scope IDs.
2929
+ Builds filter expression by the filter data.
2930
+ - If the resulting value array is empty the enabled property will be false.
3169
2931
 
3170
2932
 
3171
2933
 
@@ -3174,8 +2936,7 @@ Gets the filters from logic data by Scopes/Scope IDs.
3174
2936
 
3175
2937
  | Name | Type | Description | |
3176
2938
  | ---- | ---- | ----------- | -------- |
3177
- | logics | | The logic array | &nbsp; |
3178
- | scopes | | The collection of Scopes/Scope IDs | &nbsp; |
2939
+ | filter | | The filter to transform | &nbsp; |
3179
2940
 
3180
2941
 
3181
2942
 
@@ -3183,17 +2944,17 @@ Gets the filters from logic data by Scopes/Scope IDs.
3183
2944
  ##### Returns
3184
2945
 
3185
2946
 
3186
- - a new Logic array
2947
+ - a filter expression
3187
2948
 
3188
2949
 
3189
2950
 
3190
2951
 
3191
- ### dist/filters/helpers/backend/getLogicByScopesHierarchy.js
2952
+ ### dist/filters/helpers/backend/buildUserFilters.js
3192
2953
 
3193
2954
 
3194
- #### getLogicByScopesHierarchy(filterData, scopes, currentScope)
2955
+ #### buildUserFilters(userFilters)
3195
2956
 
3196
- Gets filters from the logic by the scopes hierarchy.
2957
+ Transform user Filters array into Filter Logic structure
3197
2958
 
3198
2959
 
3199
2960
 
@@ -3202,9 +2963,7 @@ Gets filters from the logic by the scopes hierarchy.
3202
2963
 
3203
2964
  | Name | Type | Description | |
3204
2965
  | ---- | ---- | ----------- | -------- |
3205
- | filterData | | | &nbsp; |
3206
- | scopes | | | &nbsp; |
3207
- | currentScope | | | &nbsp; |
2966
+ | userFilters | | The filters that the user defined. | &nbsp; |
3208
2967
 
3209
2968
 
3210
2969
 
@@ -3212,17 +2971,17 @@ Gets filters from the logic by the scopes hierarchy.
3212
2971
  ##### Returns
3213
2972
 
3214
2973
 
3215
- - a new array of Logic
2974
+ - The filter logic for the given user filters. if No a given object is recieved, it will return an empty array.
3216
2975
 
3217
2976
 
3218
2977
 
3219
2978
 
3220
- ### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
2979
+ ### dist/filters/helpers/backend/getAggFiltersBySummaryIndex.js
3221
2980
 
3222
2981
 
3223
- #### getFilterBuilderGeneralConfig(config)
2982
+ #### getAggFiltersBySummaryIndex(aggFilters, summaryIndex)
2983
+
3224
2984
 
3225
- Returns a filter builder config object by a any given config
3226
2985
 
3227
2986
 
3228
2987
 
@@ -3231,7 +2990,8 @@ Returns a filter builder config object by a any given config
3231
2990
 
3232
2991
  | Name | Type | Description | |
3233
2992
  | ---- | ---- | ----------- | -------- |
3234
- | config | | any config object | &nbsp; |
2993
+ | aggFilters | | | &nbsp; |
2994
+ | summaryIndex | | | &nbsp; |
3235
2995
 
3236
2996
 
3237
2997
 
@@ -3239,17 +2999,17 @@ Returns a filter builder config object by a any given config
3239
2999
  ##### Returns
3240
3000
 
3241
3001
 
3242
- - The filter builder config object
3002
+ -
3243
3003
 
3244
3004
 
3245
3005
 
3246
3006
 
3247
- ### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
3007
+ ### dist/filters/helpers/backend/getBackendProperty.js
3248
3008
 
3249
3009
 
3250
- #### excludeUIFiltersByAggregate(uFilters)
3010
+ #### getBackendProperty(filter)
3251
3011
 
3252
- Excludes Aggregate Filters in the Flattened UI Filters array
3012
+ Gets a property for the logic structure
3253
3013
 
3254
3014
 
3255
3015
 
@@ -3258,7 +3018,7 @@ Excludes Aggregate Filters in the Flattened UI Filters array
3258
3018
 
3259
3019
  | Name | Type | Description | |
3260
3020
  | ---- | ---- | ----------- | -------- |
3261
- | uFilters | | Collection of Flat UI Filters | &nbsp; |
3021
+ | filter | | The filter | &nbsp; |
3262
3022
 
3263
3023
 
3264
3024
 
@@ -3266,17 +3026,17 @@ Excludes Aggregate Filters in the Flattened UI Filters array
3266
3026
  ##### Returns
3267
3027
 
3268
3028
 
3269
- - a new Flat UI Filters that were excluded the aggregate filters
3029
+ - a property
3270
3030
 
3271
3031
 
3272
3032
 
3273
3033
 
3274
- ### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
3034
+ ### dist/filters/helpers/backend/getBackendGroupValue.js
3275
3035
 
3276
3036
 
3277
- #### excludeUIFlatFiltersByScopes(uFilters, scopes)
3037
+ #### getBackendGroupValue(filter)
3278
3038
 
3279
- Excludes and returns a UI Flat Filters without filters by the given scopes
3039
+ Gets a group value for the backend logic structure
3280
3040
 
3281
3041
 
3282
3042
 
@@ -3285,8 +3045,7 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
3285
3045
 
3286
3046
  | Name | Type | Description | |
3287
3047
  | ---- | ---- | ----------- | -------- |
3288
- | uFilters | | The Flatten UI Filters | &nbsp; |
3289
- | scopes | | collection of scopes types | &nbsp; |
3048
+ | filter | | The filter | &nbsp; |
3290
3049
 
3291
3050
 
3292
3051
 
@@ -3294,17 +3053,17 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
3294
3053
  ##### Returns
3295
3054
 
3296
3055
 
3297
- - The new array of UI Flattened filters
3056
+ - a property
3298
3057
 
3299
3058
 
3300
3059
 
3301
3060
 
3302
- ### dist/filters/helpers/ui/getFilterPropertyLabel.js
3061
+ ### dist/filters/helpers/backend/getBackendValidator.js
3303
3062
 
3304
3063
 
3305
- #### getFilterPropertyLabel(filter)
3064
+ #### getBackendValidator(validator)
3306
3065
 
3307
- Gets the label of the filter property
3066
+ Gets the Validator that is used in requests
3308
3067
 
3309
3068
 
3310
3069
 
@@ -3313,7 +3072,7 @@ Gets the label of the filter property
3313
3072
 
3314
3073
  | Name | Type | Description | |
3315
3074
  | ---- | ---- | ----------- | -------- |
3316
- | filter | | The UI Filter | &nbsp; |
3075
+ | validator | | Filter Validator used in UI | &nbsp; |
3317
3076
 
3318
3077
 
3319
3078
 
@@ -3321,17 +3080,17 @@ Gets the label of the filter property
3321
3080
  ##### Returns
3322
3081
 
3323
3082
 
3324
- - a string of the filter property label
3083
+ - Filter Validator used in Backend
3325
3084
 
3326
3085
 
3327
3086
 
3328
3087
 
3329
- ### dist/filters/helpers/ui/getOutputFormatByColumn.js
3088
+ ### dist/filters/helpers/backend/getBackendValues.js
3330
3089
 
3331
3090
 
3332
- #### getOutputFormatByColumn(column, datasets)
3091
+ #### getBackendValues(filter)
3333
3092
 
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
3093
+ Gets the expresion values in the logic format
3335
3094
 
3336
3095
 
3337
3096
 
@@ -3340,8 +3099,7 @@ Gets output format object from Datasets by the given column. Item of the dataset
3340
3099
 
3341
3100
  | Name | Type | Description | |
3342
3101
  | ---- | ---- | ----------- | -------- |
3343
- | column | | The column | &nbsp; |
3344
- | datasets | | array of datasets | &nbsp; |
3102
+ | filter | | The filter structure | &nbsp; |
3345
3103
 
3346
3104
 
3347
3105
 
@@ -3349,27 +3107,23 @@ Gets output format object from Datasets by the given column. Item of the dataset
3349
3107
  ##### Returns
3350
3108
 
3351
3109
 
3352
- - The output format object
3110
+ - A collection of backend expression value
3353
3111
 
3354
3112
 
3355
3113
 
3114
+ #### getResultValues(values, filter)
3356
3115
 
3357
- ### dist/filters/helpers/ui/getUIFlatFilterByParams.js
3116
+ Gets the expression values. Depending on the column type
3358
3117
 
3359
3118
 
3360
- #### getUIFlatFilterByParams()
3361
3119
 
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
3371
3120
 
3121
+ ##### Parameters
3372
3122
 
3123
+ | Name | Type | Description | |
3124
+ | ---- | ---- | ----------- | -------- |
3125
+ | values | | a collection of filter values | &nbsp; |
3126
+ | filter | | The filter structure | &nbsp; |
3373
3127
 
3374
3128
 
3375
3129
 
@@ -3377,28 +3131,23 @@ The validation to filter the stored filter is depending on:
3377
3131
  ##### Returns
3378
3132
 
3379
3133
 
3380
- - The index of the uFilter array or the Filter object s
3134
+ -
3381
3135
 
3382
3136
 
3383
3137
 
3138
+ #### getRankingValues(values, rankingGroupIndex)
3384
3139
 
3385
- ### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
3140
+ Gets the Ranking values.
3386
3141
 
3387
3142
 
3388
- #### getUIFlatFiltersByParams()
3389
3143
 
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
3400
3144
 
3145
+ ##### Parameters
3401
3146
 
3147
+ | Name | Type | Description | |
3148
+ | ---- | ---- | ----------- | -------- |
3149
+ | values | | a collection of filter values in the ranking structure | &nbsp; |
3150
+ | rankingGroupIndex | | determine the value by this index to build and return it | &nbsp; |
3402
3151
 
3403
3152
 
3404
3153
 
@@ -3406,17 +3155,17 @@ The validation to filter the stored filter is depending on:
3406
3155
  ##### Returns
3407
3156
 
3408
3157
 
3409
- - The index of the uFilter array or the Filter object s
3158
+ - Expression values for ranking
3410
3159
 
3411
3160
 
3412
3161
 
3413
3162
 
3414
- ### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
3163
+ ### dist/filters/helpers/backend/getLogicByScopes.js
3415
3164
 
3416
3165
 
3417
- #### getUIFlatFiltersByScopes(uFilters, scopes)
3166
+ #### getLogicByScopes(logics, scopes)
3418
3167
 
3419
- Filters and gets a UI Flatten Filters by the given scopes
3168
+ Gets the filters from logic data by Scopes/Scope IDs.
3420
3169
 
3421
3170
 
3422
3171
 
@@ -3425,8 +3174,8 @@ Filters and gets a UI Flatten Filters by the given scopes
3425
3174
 
3426
3175
  | Name | Type | Description | |
3427
3176
  | ---- | ---- | ----------- | -------- |
3428
- | uFilters | | The Flatten UI Filters | &nbsp; |
3429
- | scopes | | collection of scopes types | &nbsp; |
3177
+ | logics | | The logic array | &nbsp; |
3178
+ | scopes | | The collection of Scopes/Scope IDs | &nbsp; |
3430
3179
 
3431
3180
 
3432
3181
 
@@ -3434,17 +3183,17 @@ Filters and gets a UI Flatten Filters by the given scopes
3434
3183
  ##### Returns
3435
3184
 
3436
3185
 
3437
- - The new array of UI Flattened filters
3438
-
3186
+ - a new Logic array
3439
3187
 
3440
3188
 
3441
3189
 
3442
- ### dist/filters/helpers/ui/getUIValues.js
3443
3190
 
3191
+ ### dist/filters/helpers/backend/getLogicByScopesHierarchy.js
3444
3192
 
3445
- #### getUIValues(filter, addEnableds, rankingGroupIndex)
3446
3193
 
3194
+ #### getLogicByScopesHierarchy(filterData, scopes, currentScope)
3447
3195
 
3196
+ Gets filters from the logic by the scopes hierarchy.
3448
3197
 
3449
3198
 
3450
3199
 
@@ -3453,9 +3202,9 @@ Filters and gets a UI Flatten Filters by the given scopes
3453
3202
 
3454
3203
  | Name | Type | Description | |
3455
3204
  | ---- | ---- | ----------- | -------- |
3456
- | filter | | | &nbsp; |
3457
- | addEnableds | | | &nbsp; |
3458
- | rankingGroupIndex | | | &nbsp; |
3205
+ | filterData | | | &nbsp; |
3206
+ | scopes | | | &nbsp; |
3207
+ | currentScope | | | &nbsp; |
3459
3208
 
3460
3209
 
3461
3210
 
@@ -3463,17 +3212,17 @@ Filters and gets a UI Flatten Filters by the given scopes
3463
3212
  ##### Returns
3464
3213
 
3465
3214
 
3466
- -
3215
+ - a new array of Logic
3467
3216
 
3468
3217
 
3469
3218
 
3470
3219
 
3471
- ### dist/filters/helpers/ui/resolveUIFlatFiltersByParams.js
3220
+ ### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
3472
3221
 
3473
3222
 
3474
- #### resolveUIFlatFilterByParams(filter, params)
3223
+ #### getFilterBuilderGeneralConfig(config)
3475
3224
 
3476
- Resolves conditions between UI flattened filter and given parameters
3225
+ Returns a filter builder config object by a any given config
3477
3226
 
3478
3227
 
3479
3228
 
@@ -3481,9 +3230,8 @@ Resolves conditions between UI flattened filter and given parameters
3481
3230
  ##### Parameters
3482
3231
 
3483
3232
  | Name | Type | Description | |
3484
- | ---- | ---- | ----------- | -------- |
3485
- | filter | | UI Flatten Filter | &nbsp; |
3486
- | params | | Parameters to validate | &nbsp; |
3233
+ | ---- | ---- | ----------- | -------- |
3234
+ | config | | any config object | &nbsp; |
3487
3235
 
3488
3236
 
3489
3237
 
@@ -3491,7 +3239,7 @@ Resolves conditions between UI flattened filter and given parameters
3491
3239
  ##### Returns
3492
3240
 
3493
3241
 
3494
- - true: the conditions are satisfied.
3242
+ - The filter builder config object
3495
3243
 
3496
3244
 
3497
3245
 
@@ -4320,4 +4068,256 @@ Resolves the conditions by given params
4320
4068
 
4321
4069
 
4322
4070
 
4071
+ ### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
4072
+
4073
+
4074
+ #### excludeUIFiltersByAggregate(uFilters)
4075
+
4076
+ Excludes Aggregate Filters in the Flattened UI Filters array
4077
+
4078
+
4079
+
4080
+
4081
+ ##### Parameters
4082
+
4083
+ | Name | Type | Description | |
4084
+ | ---- | ---- | ----------- | -------- |
4085
+ | uFilters | | Collection of Flat UI Filters | &nbsp; |
4086
+
4087
+
4088
+
4089
+
4090
+ ##### Returns
4091
+
4092
+
4093
+ - a new Flat UI Filters that were excluded the aggregate filters
4094
+
4095
+
4096
+
4097
+
4098
+ ### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
4099
+
4100
+
4101
+ #### excludeUIFlatFiltersByScopes(uFilters, scopes)
4102
+
4103
+ Excludes and returns a UI Flat Filters without filters by the given scopes
4104
+
4105
+
4106
+
4107
+
4108
+ ##### Parameters
4109
+
4110
+ | Name | Type | Description | |
4111
+ | ---- | ---- | ----------- | -------- |
4112
+ | uFilters | | The Flatten UI Filters | &nbsp; |
4113
+ | scopes | | collection of scopes types | &nbsp; |
4114
+
4115
+
4116
+
4117
+
4118
+ ##### Returns
4119
+
4120
+
4121
+ - The new array of UI Flattened filters
4122
+
4123
+
4124
+
4125
+
4126
+ ### dist/filters/helpers/ui/getFilterPropertyLabel.js
4127
+
4128
+
4129
+ #### getFilterPropertyLabel(filter)
4130
+
4131
+ Gets the label of the filter property
4132
+
4133
+
4134
+
4135
+
4136
+ ##### Parameters
4137
+
4138
+ | Name | Type | Description | |
4139
+ | ---- | ---- | ----------- | -------- |
4140
+ | filter | | The UI Filter | &nbsp; |
4141
+
4142
+
4143
+
4144
+
4145
+ ##### Returns
4146
+
4147
+
4148
+ - a string of the filter property label
4149
+
4150
+
4151
+
4152
+
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
4159
+
4160
+
4161
+
4162
+
4163
+ ##### Parameters
4164
+
4165
+ | Name | Type | Description | |
4166
+ | ---- | ---- | ----------- | -------- |
4167
+ | column | | The column | &nbsp; |
4168
+ | datasets | | array of datasets | &nbsp; |
4169
+
4170
+
4171
+
4172
+
4173
+ ##### Returns
4174
+
4175
+
4176
+ - The output format object
4177
+
4178
+
4179
+
4180
+
4181
+ ### dist/filters/helpers/ui/getUIFlatFilterByParams.js
4182
+
4183
+
4184
+ #### getUIFlatFilterByParams()
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
4195
+
4196
+
4197
+
4198
+
4199
+
4200
+
4201
+ ##### Returns
4202
+
4203
+
4204
+ - The index of the uFilter array or the Filter object s
4205
+
4206
+
4207
+
4208
+
4209
+ ### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
4210
+
4211
+
4212
+ #### getUIFlatFiltersByParams()
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
4224
+
4225
+
4226
+
4227
+
4228
+
4229
+
4230
+ ##### Returns
4231
+
4232
+
4233
+ - The index of the uFilter array or the Filter object s
4234
+
4235
+
4236
+
4237
+
4238
+ ### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
4239
+
4240
+
4241
+ #### getUIFlatFiltersByScopes(uFilters, scopes)
4242
+
4243
+ Filters and gets a UI Flatten Filters by the given scopes
4244
+
4245
+
4246
+
4247
+
4248
+ ##### Parameters
4249
+
4250
+ | Name | Type | Description | |
4251
+ | ---- | ---- | ----------- | -------- |
4252
+ | uFilters | | The Flatten UI Filters | &nbsp; |
4253
+ | scopes | | collection of scopes types | &nbsp; |
4254
+
4255
+
4256
+
4257
+
4258
+ ##### Returns
4259
+
4260
+
4261
+ - The new array of UI Flattened filters
4262
+
4263
+
4264
+
4265
+
4266
+ ### dist/filters/helpers/ui/getUIValues.js
4267
+
4268
+
4269
+ #### getUIValues(filter, addEnableds, rankingGroupIndex)
4270
+
4271
+
4272
+
4273
+
4274
+
4275
+
4276
+ ##### Parameters
4277
+
4278
+ | Name | Type | Description | |
4279
+ | ---- | ---- | ----------- | -------- |
4280
+ | filter | | | &nbsp; |
4281
+ | addEnableds | | | &nbsp; |
4282
+ | rankingGroupIndex | | | &nbsp; |
4283
+
4284
+
4285
+
4286
+
4287
+ ##### Returns
4288
+
4289
+
4290
+ -
4291
+
4292
+
4293
+
4294
+
4295
+ ### dist/filters/helpers/ui/resolveUIFlatFiltersByParams.js
4296
+
4297
+
4298
+ #### resolveUIFlatFilterByParams(filter, params)
4299
+
4300
+ Resolves conditions between UI flattened filter and given parameters
4301
+
4302
+
4303
+
4304
+
4305
+ ##### Parameters
4306
+
4307
+ | Name | Type | Description | |
4308
+ | ---- | ---- | ----------- | -------- |
4309
+ | filter | | UI Flatten Filter | &nbsp; |
4310
+ | params | | Parameters to validate | &nbsp; |
4311
+
4312
+
4313
+
4314
+
4315
+ ##### Returns
4316
+
4317
+
4318
+ - true: the conditions are satisfied.
4319
+
4320
+
4321
+
4322
+
4323
4323
  *Documentation generated with [doxdox](https://github.com/neogeek/doxdox).*