@qrvey/utils 1.2.9-4 → 1.2.9-8

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 (129) hide show
  1. package/README.md +561 -561
  2. package/dist/cjs/dates/relative/constants/RELATIVE_UNIT_INFO.d.ts +5 -0
  3. package/dist/cjs/dates/relative/constants/RELATIVE_UNIT_INFO.js +11 -0
  4. package/dist/cjs/dates/relative/constants/RELATIVE_UNIT_INFO_LIST.d.ts +5 -0
  5. package/dist/cjs/dates/relative/constants/RELATIVE_UNIT_INFO_LIST.js +14 -0
  6. package/dist/cjs/dates/relative/constants/index.d.ts +2 -0
  7. package/dist/cjs/dates/relative/constants/index.js +2 -0
  8. package/dist/cjs/dates/relative/interfaces/IRelativeUnit.d.ts +2 -0
  9. package/dist/cjs/{globalization/interfaces/chart_builder/II18nChartBuilderChartLabes.js → dates/relative/interfaces/IRelativeUnit.js} +0 -0
  10. package/dist/cjs/dates/relative/interfaces/IRelativeUnitInfo.d.ts +5 -0
  11. package/dist/cjs/dates/relative/interfaces/IRelativeUnitInfo.js +2 -0
  12. package/dist/cjs/dates/relative/interfaces/index.d.ts +2 -0
  13. package/dist/cjs/dates/relative/interfaces/index.js +2 -0
  14. package/dist/cjs/globalization/helpers/getI18nDateGroupLabel.js +2 -0
  15. package/dist/cjs/globalization/helpers/getReverseI18nGroupLabel.js +2 -0
  16. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilder.d.ts +2 -2
  17. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderAxisStyle.d.ts +19 -18
  18. package/dist/cjs/globalization/interfaces/chart_builder/{II18nChartBuilderChartLabes.d.ts → II18nChartBuilderChartLabels.d.ts} +1 -1
  19. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderChartLabels.js +2 -0
  20. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderColorSettings.d.ts +5 -4
  21. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComparisionOptions.d.ts +15 -11
  22. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderDataPanel.d.ts +16 -15
  23. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderDimensions.d.ts +12 -11
  24. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderGeneralOptions.d.ts +16 -12
  25. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderSorting.d.ts +3 -1
  26. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderStyleOptions.d.ts +19 -16
  27. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderTableCalculation.d.ts +1 -1
  28. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderTooltipSettings.d.ts +1 -1
  29. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderTrendChart.d.ts +15 -3
  30. package/dist/cjs/globalization/interfaces/chart_builder/index.d.ts +1 -1
  31. package/dist/cjs/globalization/interfaces/chart_builder/index.js +1 -1
  32. package/dist/cjs/globalization/interfaces/common/II18nCommon.d.ts +2 -0
  33. package/dist/cjs/globalization/interfaces/common/II18nUnits.d.ts +7 -0
  34. package/dist/cjs/globalization/interfaces/common/II18nUnits.js +2 -0
  35. package/dist/cjs/globalization/interfaces/common/index.d.ts +2 -0
  36. package/dist/cjs/globalization/interfaces/common/index.js +2 -0
  37. package/dist/cjs/globalization/interfaces/filters/II18nRelativeContainer.d.ts +4 -2
  38. package/dist/cjs/globalization/interfaces/panel/II18nPanelSummaryViews.d.ts +11 -9
  39. package/dist/cjs/globalization/labels/chart_builder/I18N_CHART_BUILDER_COMPARISION_OPTIONS.js +15 -11
  40. package/dist/cjs/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL.d.ts +1 -1
  41. package/dist/cjs/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL.js +50 -36
  42. package/dist/cjs/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL_OPTIONS.js +21 -15
  43. package/dist/cjs/globalization/labels/chart_builder/I18N_CHART_BUILDER_STYLE_OPTIONS.js +43 -38
  44. package/dist/cjs/globalization/labels/chart_builder/I18N_CHART_BUILDER_TIME_PERIOD.js +1 -1
  45. package/dist/cjs/globalization/labels/common/I18N_COMMON.js +8 -0
  46. package/dist/cjs/globalization/labels/filters/I18N_RELATIVE_CONTAINER.js +4 -2
  47. package/dist/cjs/globalization/labels/panel/I18N_PANEL.js +12 -10
  48. package/dist/dates/relative/constants/RELATIVE_UNIT_INFO.d.ts +5 -0
  49. package/dist/dates/relative/constants/RELATIVE_UNIT_INFO.js +8 -0
  50. package/dist/dates/relative/constants/RELATIVE_UNIT_INFO_LIST.d.ts +5 -0
  51. package/dist/dates/relative/constants/RELATIVE_UNIT_INFO_LIST.js +11 -0
  52. package/dist/dates/relative/constants/index.d.ts +2 -0
  53. package/dist/dates/relative/constants/index.js +2 -0
  54. package/dist/dates/relative/interfaces/IRelativeUnit.d.ts +2 -0
  55. package/dist/{globalization/interfaces/chart_builder/II18nChartBuilderChartLabes.js → dates/relative/interfaces/IRelativeUnit.js} +0 -0
  56. package/dist/dates/relative/interfaces/IRelativeUnitInfo.d.ts +5 -0
  57. package/dist/dates/relative/interfaces/IRelativeUnitInfo.js +1 -0
  58. package/dist/dates/relative/interfaces/index.d.ts +2 -0
  59. package/dist/dates/relative/interfaces/index.js +2 -0
  60. package/dist/globalization/helpers/getI18nDateGroupLabel.js +2 -0
  61. package/dist/globalization/helpers/getReverseI18nGroupLabel.js +2 -0
  62. package/dist/globalization/interfaces/chart_builder/II18nChartBuilder.d.ts +2 -2
  63. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderAxisStyle.d.ts +19 -18
  64. package/dist/globalization/interfaces/chart_builder/{II18nChartBuilderChartLabes.d.ts → II18nChartBuilderChartLabels.d.ts} +1 -1
  65. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderChartLabels.js +1 -0
  66. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderColorSettings.d.ts +5 -4
  67. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComparisionOptions.d.ts +15 -11
  68. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderDataPanel.d.ts +16 -15
  69. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderDimensions.d.ts +12 -11
  70. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderGeneralOptions.d.ts +16 -12
  71. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderSorting.d.ts +3 -1
  72. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderStyleOptions.d.ts +19 -16
  73. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderTableCalculation.d.ts +1 -1
  74. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderTooltipSettings.d.ts +1 -1
  75. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderTrendChart.d.ts +15 -3
  76. package/dist/globalization/interfaces/chart_builder/index.d.ts +1 -1
  77. package/dist/globalization/interfaces/chart_builder/index.js +1 -1
  78. package/dist/globalization/interfaces/common/II18nCommon.d.ts +2 -0
  79. package/dist/globalization/interfaces/common/II18nUnits.d.ts +7 -0
  80. package/dist/globalization/interfaces/common/II18nUnits.js +1 -0
  81. package/dist/globalization/interfaces/common/index.d.ts +2 -0
  82. package/dist/globalization/interfaces/common/index.js +2 -0
  83. package/dist/globalization/interfaces/filters/II18nRelativeContainer.d.ts +4 -2
  84. package/dist/globalization/interfaces/panel/II18nPanelSummaryViews.d.ts +11 -9
  85. package/dist/globalization/labels/chart_builder/I18N_CHART_BUILDER_COMPARISION_OPTIONS.js +15 -11
  86. package/dist/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL.d.ts +1 -1
  87. package/dist/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL.js +50 -36
  88. package/dist/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL_OPTIONS.js +21 -15
  89. package/dist/globalization/labels/chart_builder/I18N_CHART_BUILDER_STYLE_OPTIONS.js +43 -38
  90. package/dist/globalization/labels/chart_builder/I18N_CHART_BUILDER_TIME_PERIOD.js +1 -1
  91. package/dist/globalization/labels/common/I18N_COMMON.js +8 -0
  92. package/dist/globalization/labels/filters/I18N_RELATIVE_CONTAINER.js +4 -2
  93. package/dist/globalization/labels/panel/I18N_PANEL.js +12 -10
  94. package/package.json +1 -1
  95. package/src/dates/relative/constants/RELATIVE_UNIT_INFO.ts +11 -0
  96. package/src/dates/relative/constants/RELATIVE_UNIT_INFO_LIST.ts +13 -0
  97. package/src/dates/relative/constants/index.ts +2 -0
  98. package/src/dates/relative/interfaces/IRelativeUnit.ts +3 -0
  99. package/src/dates/relative/interfaces/IRelativeUnitInfo.ts +7 -0
  100. package/src/dates/relative/interfaces/index.ts +2 -0
  101. package/src/globalization/helpers/getI18nDateGroupLabel.ts +2 -0
  102. package/src/globalization/helpers/getReverseI18nGroupLabel.ts +2 -0
  103. package/src/globalization/interfaces/chart_builder/II18nChartBuilder.ts +2 -2
  104. package/src/globalization/interfaces/chart_builder/II18nChartBuilderAxisStyle.ts +19 -18
  105. package/src/globalization/interfaces/chart_builder/{II18nChartBuilderChartLabes.ts → II18nChartBuilderChartLabels.ts} +1 -1
  106. package/src/globalization/interfaces/chart_builder/II18nChartBuilderColorSettings.ts +5 -4
  107. package/src/globalization/interfaces/chart_builder/II18nChartBuilderComparisionOptions.ts +15 -11
  108. package/src/globalization/interfaces/chart_builder/II18nChartBuilderDataPanel.ts +16 -15
  109. package/src/globalization/interfaces/chart_builder/II18nChartBuilderDimensions.ts +12 -11
  110. package/src/globalization/interfaces/chart_builder/II18nChartBuilderGeneralOptions.ts +16 -12
  111. package/src/globalization/interfaces/chart_builder/II18nChartBuilderSorting.ts +3 -1
  112. package/src/globalization/interfaces/chart_builder/II18nChartBuilderStyleOptions.ts +19 -16
  113. package/src/globalization/interfaces/chart_builder/II18nChartBuilderTableCalculation.ts +1 -1
  114. package/src/globalization/interfaces/chart_builder/II18nChartBuilderTooltipSettings.ts +1 -1
  115. package/src/globalization/interfaces/chart_builder/II18nChartBuilderTrendChart.ts +15 -3
  116. package/src/globalization/interfaces/chart_builder/index.ts +1 -1
  117. package/src/globalization/interfaces/common/II18nCommon.ts +2 -0
  118. package/src/globalization/interfaces/common/II18nUnits.ts +7 -0
  119. package/src/globalization/interfaces/common/index.ts +3 -0
  120. package/src/globalization/interfaces/filters/II18nRelativeContainer.ts +4 -2
  121. package/src/globalization/interfaces/panel/II18nPanelSummaryViews.ts +11 -9
  122. package/src/globalization/labels/chart_builder/I18N_CHART_BUILDER_COMPARISION_OPTIONS.ts +15 -11
  123. package/src/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL.ts +51 -38
  124. package/src/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL_OPTIONS.ts +21 -16
  125. package/src/globalization/labels/chart_builder/I18N_CHART_BUILDER_STYLE_OPTIONS.ts +43 -38
  126. package/src/globalization/labels/chart_builder/I18N_CHART_BUILDER_TIME_PERIOD.ts +1 -1
  127. package/src/globalization/labels/common/I18N_COMMON.ts +8 -0
  128. package/src/globalization/labels/filters/I18N_RELATIVE_CONTAINER.ts +4 -2
  129. package/src/globalization/labels/panel/I18N_PANEL.ts +12 -10
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-4*
1
+ # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-8*
2
2
 
3
3
  > Helper, Utils for all Qrvey Projects
4
4
 
@@ -136,12 +136,12 @@ Transforms String Date from a [Month Year] format to Date object.
136
136
 
137
137
 
138
138
 
139
- ### dist/dates/adapters/weekYearToDate.js
139
+ ### dist/dates/adapters/quarterYearToDate.js
140
140
 
141
141
 
142
- #### weekYearToDate(date, time)
142
+ #### quarterYearToDate(quarterYearDate, time)
143
143
 
144
- Transforms String Date from a [Week Year] format to Date object.
144
+ Transforms String Date from a [Quarter Year] format to Date object.
145
145
 
146
146
 
147
147
 
@@ -150,7 +150,7 @@ Transforms String Date from a [Week Year] format to Date object.
150
150
 
151
151
  | Name | Type | Description | |
152
152
  | ---- | ---- | ----------- | -------- |
153
- | date | | String of [Week Year] date |   |
153
+ | quarterYearDate | | String of [Quarter Year] date |   |
154
154
  | time | | Flag to parse the object date to milliseconds. |   |
155
155
 
156
156
 
@@ -164,12 +164,12 @@ Transforms String Date from a [Week Year] format to Date object.
164
164
 
165
165
 
166
166
 
167
- ### dist/dates/adapters/quarterYearToDate.js
167
+ ### dist/dates/adapters/weekYearToDate.js
168
168
 
169
169
 
170
- #### quarterYearToDate(quarterYearDate, time)
170
+ #### weekYearToDate(date, time)
171
171
 
172
- Transforms String Date from a [Quarter Year] format to Date object.
172
+ Transforms String Date from a [Week Year] format to Date object.
173
173
 
174
174
 
175
175
 
@@ -178,7 +178,7 @@ Transforms String Date from a [Quarter Year] format to Date object.
178
178
 
179
179
  | Name | Type | Description | |
180
180
  | ---- | ---- | ----------- | -------- |
181
- | quarterYearDate | | String of [Quarter Year] date |   |
181
+ | date | | String of [Week Year] date |   |
182
182
  | time | | Flag to parse the object date to milliseconds. |   |
183
183
 
184
184
 
@@ -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,18 +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
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.
2073
2048
 
2074
2049
 
2075
2050
 
@@ -2078,8 +2053,7 @@ and return a mapped object
2078
2053
 
2079
2054
  | Name | Type | Description | |
2080
2055
  | ---- | ---- | ----------- | -------- |
2081
- | baseObject | `Object` | Base object. | &nbsp; |
2082
- | iteratee | `Function` | The executed per iteration. | &nbsp; |
2056
+ | variable | | the variable to validate | &nbsp; |
2083
2057
 
2084
2058
 
2085
2059
 
@@ -2087,18 +2061,18 @@ and return a mapped object
2087
2061
  ##### Returns
2088
2062
 
2089
2063
 
2090
- - `Object` New mapped object.
2064
+ - True if variable is a NaN or false otherwise
2091
2065
 
2092
2066
 
2093
2067
 
2094
2068
 
2095
- ### dist/general/object/mergeDeep.js
2069
+ ### dist/general/mix/isNull.js
2096
2070
 
2097
2071
 
2098
- #### mergeDeep(obj1, obj2, settings)
2072
+ #### isNull(arg)
2099
2073
 
2100
- Merges two objects into a new one.
2101
- The second given argument to the first given argument.
2074
+ return if a given variable is either `null` or `undefined`
2075
+ useful to avoid falsify validating Number Zero (0)
2102
2076
 
2103
2077
 
2104
2078
 
@@ -2107,9 +2081,7 @@ The second given argument to the first given argument.
2107
2081
 
2108
2082
  | Name | Type | Description | |
2109
2083
  | ---- | ---- | ----------- | -------- |
2110
- | obj1 | | The target object | &nbsp; |
2111
- | obj2 | | The object to be merged | &nbsp; |
2112
- | settings | | Object settings for this function | &nbsp; |
2084
+ | arg | `any` | | &nbsp; |
2113
2085
 
2114
2086
 
2115
2087
 
@@ -2117,37 +2089,19 @@ The second given argument to the first given argument.
2117
2089
  ##### Returns
2118
2090
 
2119
2091
 
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
-
2092
+ - `Boolean`
2140
2093
 
2141
- ##### Returns
2142
2094
 
2143
2095
 
2144
- - true: they are valid; false: they are not
2145
2096
 
2097
+ ### dist/general/mix/randomId.js
2146
2098
 
2147
2099
 
2148
- #### getParamsToMergeDeep(settings)
2100
+ #### randomId(length, exclude)
2149
2101
 
2150
- Validates and gets the settings with all set parameters.
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.
2151
2105
 
2152
2106
 
2153
2107
 
@@ -2156,7 +2110,8 @@ Validates and gets the settings with all set parameters.
2156
2110
 
2157
2111
  | Name | Type | Description | |
2158
2112
  | ---- | ---- | ----------- | -------- |
2159
- | settings | | the settings object | &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; |
2160
2115
 
2161
2116
 
2162
2117
 
@@ -2164,17 +2119,19 @@ Validates and gets the settings with all set parameters.
2164
2119
  ##### Returns
2165
2120
 
2166
2121
 
2167
- - a new settings object with all set parameters.
2122
+ - `String` Random string
2168
2123
 
2169
2124
 
2170
2125
 
2171
2126
 
2172
- ### dist/general/object/objectCopy.js
2127
+ ### dist/general/mix/size.js
2173
2128
 
2174
2129
 
2175
- #### objectCopy(entity, cache)
2130
+ #### size(obj)
2176
2131
 
2177
- Created a new reference of the given argument
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.
2178
2135
 
2179
2136
 
2180
2137
 
@@ -2183,8 +2140,7 @@ Created a new reference of the given argument
2183
2140
 
2184
2141
  | Name | Type | Description | |
2185
2142
  | ---- | ---- | ----------- | -------- |
2186
- | entity | | The variable to be copied | &nbsp; |
2187
- | cache | | | &nbsp; |
2143
+ | obj | `Any` | Any object-type variable | &nbsp; |
2188
2144
 
2189
2145
 
2190
2146
 
@@ -2192,17 +2148,18 @@ Created a new reference of the given argument
2192
2148
  ##### Returns
2193
2149
 
2194
2150
 
2195
- - A new reference of the given argument
2151
+ - `Number` the size of the given variable
2196
2152
 
2197
2153
 
2198
2154
 
2199
2155
 
2200
- ### dist/general/object/omit.js
2156
+ ### dist/general/object/cloneDeep.js
2201
2157
 
2202
2158
 
2203
- #### omit(obj, props)
2159
+ #### cloneDeep(obj)
2204
2160
 
2205
- return a new Object excluding attributes in _props_ list
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
2206
2163
 
2207
2164
 
2208
2165
 
@@ -2211,8 +2168,7 @@ return a new Object excluding attributes in _props_ list
2211
2168
 
2212
2169
  | Name | Type | Description | |
2213
2170
  | ---- | ---- | ----------- | -------- |
2214
- | obj | `Object` | base object | &nbsp; |
2215
- | props | `Array.<String>` | list of attribute to exclude | &nbsp; |
2171
+ | obj | | The object | &nbsp; |
2216
2172
 
2217
2173
 
2218
2174
 
@@ -2220,17 +2176,21 @@ return a new Object excluding attributes in _props_ list
2220
2176
  ##### Returns
2221
2177
 
2222
2178
 
2223
- - `Object` clean object
2179
+ - The new reference object or the given object if the parsing is incorrect or empty
2224
2180
 
2225
2181
 
2226
2182
 
2227
2183
 
2228
- ### dist/general/object/pick.js
2184
+ ### dist/general/object/get.js
2229
2185
 
2230
2186
 
2231
- #### pick(baseObject, keys)
2187
+ #### _get(baseObject, path, defaultValue)
2232
2188
 
2233
- return a new object just with attributes in _keys_ list
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.
2234
2194
 
2235
2195
 
2236
2196
 
@@ -2239,26 +2199,59 @@ return a new object just with attributes in _keys_ list
2239
2199
 
2240
2200
  | Name | Type | Description | |
2241
2201
  | ---- | ---- | ----------- | -------- |
2242
- | baseObject | `Object` | base object | &nbsp; |
2243
- | keys | `Array.<String>` | list of attributes to preserve | &nbsp; |
2244
-
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; |
2245
2205
 
2246
2206
 
2247
2207
 
2248
- ##### Returns
2249
2208
 
2209
+ ##### Examples
2250
2210
 
2251
- - `Object` new object just with desired attributes
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
+ ```
2252
2231
 
2253
2232
 
2233
+ ##### Returns
2254
2234
 
2255
2235
 
2256
- ### dist/general/object/serialize.js
2236
+ - the resolved value.
2257
2237
 
2258
2238
 
2259
- #### serialize(obj)
2260
2239
 
2261
- serialize object to url param
2240
+
2241
+ ### dist/general/object/getAttribute.js
2242
+
2243
+
2244
+ #### getAttribute(obj, key)
2245
+
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
2262
2255
 
2263
2256
 
2264
2257
 
@@ -2267,11 +2260,19 @@ serialize object to url param
2267
2260
 
2268
2261
  | Name | Type | Description | |
2269
2262
  | ---- | ---- | ----------- | -------- |
2270
- | obj | | - Object to be serialized | &nbsp; |
2263
+ | obj | `object` | object to look for | &nbsp; |
2264
+ | key | `string` | String attribute in snake_case style | &nbsp; |
2271
2265
 
2272
2266
 
2273
2267
 
2274
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
+ ```
2274
+
2275
+
2275
2276
  ##### Returns
2276
2277
 
2277
2278
 
@@ -2280,13 +2281,12 @@ serialize object to url param
2280
2281
 
2281
2282
 
2282
2283
 
2283
- ### dist/general/mix/compareDeep.js
2284
+ ### dist/general/object/hasProperty.js
2284
2285
 
2285
2286
 
2286
- #### compareDeep(object1, object2)
2287
+ #### _hasProperty(obj, property)
2287
2288
 
2288
- Compares two objects to know if they are equals. Go across nested objects.
2289
- Includes arrays in the comparison.
2289
+ Use the hasOwnProperty in order to verify if the given property exists in the object.
2290
2290
 
2291
2291
 
2292
2292
 
@@ -2295,26 +2295,38 @@ Includes arrays in the comparison.
2295
2295
 
2296
2296
  | Name | Type | Description | |
2297
2297
  | ---- | ---- | ----------- | -------- |
2298
- | object1 | | First Object to compare | &nbsp; |
2299
- | object2 | | Second Object to compare | &nbsp; |
2298
+ | obj | `object` | an object | &nbsp; |
2299
+ | property | `string` | String to verify if exists in the object as property | &nbsp; |
2300
+
2301
+
2300
2302
 
2301
2303
 
2304
+ ##### Examples
2305
+
2306
+ ```javascript
2307
+ const prop = 'prop2'
2308
+ const obj1 = { prop1: 'hello', prop2: 'world'}
2309
+ _hasProperty(ob1, prop1) // true
2310
+
2311
+ const obj2 = { prop1: 'hello world' }
2312
+ _hasProperty(ob1, prop2) // false
2313
+ ```
2302
2314
 
2303
2315
 
2304
2316
  ##### Returns
2305
2317
 
2306
2318
 
2307
- - True: objects are equal. False: Objects are not equal. Undefined: invalid
2319
+ - True if the object has the given property; otherwise, false.
2308
2320
 
2309
2321
 
2310
2322
 
2311
2323
 
2312
- ### dist/general/mix/getTag.js
2324
+ ### dist/general/object/isObject.js
2313
2325
 
2314
2326
 
2315
- #### getTag(value)
2327
+ #### isObject(obj)
2316
2328
 
2317
- Gets the `toStringTag` of `value`.
2329
+ Checks if the given argument is an object type
2318
2330
 
2319
2331
 
2320
2332
 
@@ -2323,7 +2335,7 @@ Gets the `toStringTag` of `value`.
2323
2335
 
2324
2336
  | Name | Type | Description | |
2325
2337
  | ---- | ---- | ----------- | -------- |
2326
- | value | | The value to query. | &nbsp; |
2338
+ | obj | | the variable to check | &nbsp; |
2327
2339
 
2328
2340
 
2329
2341
 
@@ -2331,17 +2343,18 @@ Gets the `toStringTag` of `value`.
2331
2343
  ##### Returns
2332
2344
 
2333
2345
 
2334
- - `string` Returns the `toStringTag`.
2346
+ - True: It is an object; False: It is not.
2335
2347
 
2336
2348
 
2337
2349
 
2338
2350
 
2339
- ### dist/general/mix/importScripts.js
2351
+ ### dist/general/object/mapValues.js
2340
2352
 
2341
2353
 
2342
- #### importScripts(scripts)
2354
+ #### mapValues(baseObject, iteratee)
2343
2355
 
2344
- Import a set of external Scripts given the URL in both serie and cascade way
2356
+ Invoke iteratee (function) for each object key-value pair
2357
+ and return a mapped object
2345
2358
 
2346
2359
 
2347
2360
 
@@ -2350,54 +2363,52 @@ Import a set of external Scripts given the URL in both serie and cascade way
2350
2363
 
2351
2364
  | Name | Type | Description | |
2352
2365
  | ---- | ---- | ----------- | -------- |
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; |
2366
+ | baseObject | `Object` | Base object. | &nbsp; |
2367
+ | iteratee | `Function` | The executed per iteration. | &nbsp; |
2359
2368
 
2360
2369
 
2361
2370
 
2362
2371
 
2363
- ##### Examples
2372
+ ##### Returns
2364
2373
 
2365
- ```javascript
2366
- // 1) Simple script (paralell loading)
2367
- importScripts(['http://myscript.js', 'http://another.js']);
2368
2374
 
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
- ]);
2375
+ - `Object` New mapped object.
2376
+
2377
+
2378
+
2379
+
2380
+ ### dist/general/object/mergeDeep.js
2381
+
2382
+
2383
+ #### mergeDeep(obj1, obj2, settings)
2384
+
2385
+ Merges two objects into a new one.
2386
+ The second given argument to the first given argument.
2387
+
2388
+
2389
+
2390
+
2391
+ ##### Parameters
2392
+
2393
+ | Name | Type | Description | |
2394
+ | ---- | ---- | ----------- | -------- |
2395
+ | obj1 | | The target object | &nbsp; |
2396
+ | obj2 | | The object to be merged | &nbsp; |
2397
+ | settings | | Object settings for this function | &nbsp; |
2374
2398
 
2375
- // 3) import dependent scripts (cascade)
2376
- importScripts([
2377
- { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] }
2378
- ]);
2379
2399
 
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
2400
 
2389
2401
 
2390
2402
  ##### Returns
2391
2403
 
2392
2404
 
2393
- - `Promise` Promise when all script have been loaded
2405
+ - a new merged object
2394
2406
 
2395
2407
 
2396
2408
 
2397
- #### loadScript(url, type, noModule)
2409
+ #### isValid(obj1, obj2)
2398
2410
 
2399
- Creates the script element and appends to document.head
2400
- return a Promise that is resolved when the script is loaded
2411
+ Validates if the two arguments are objects
2401
2412
 
2402
2413
 
2403
2414
 
@@ -2406,9 +2417,8 @@ return a Promise that is resolved when the script is loaded
2406
2417
 
2407
2418
  | Name | Type | Description | |
2408
2419
  | ---- | ---- | ----------- | -------- |
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; |
2420
+ | obj1 | | The target object | &nbsp; |
2421
+ | obj2 | | The object to be merged | &nbsp; |
2412
2422
 
2413
2423
 
2414
2424
 
@@ -2416,17 +2426,13 @@ return a Promise that is resolved when the script is loaded
2416
2426
  ##### Returns
2417
2427
 
2418
2428
 
2419
- - `Void`
2420
-
2421
-
2422
-
2429
+ - true: they are valid; false: they are not
2423
2430
 
2424
- ### dist/general/mix/isEmpty.js
2425
2431
 
2426
2432
 
2427
- #### isEmpty(variable, includeFalsy)
2433
+ #### getParamsToMergeDeep(settings)
2428
2434
 
2429
- Validates if the given argument is empty
2435
+ Validates and gets the settings with all set parameters.
2430
2436
 
2431
2437
 
2432
2438
 
@@ -2435,8 +2441,7 @@ Validates if the given argument is empty
2435
2441
 
2436
2442
  | Name | Type | Description | |
2437
2443
  | ---- | ---- | ----------- | -------- |
2438
- | variable | | the given variable | &nbsp; |
2439
- | includeFalsy | | flag to determine include the falsy variables into the validation | &nbsp; |
2444
+ | settings | | the settings object | &nbsp; |
2440
2445
 
2441
2446
 
2442
2447
 
@@ -2444,19 +2449,17 @@ Validates if the given argument is empty
2444
2449
  ##### Returns
2445
2450
 
2446
2451
 
2447
- - true: the given argument is empty; false: is not.
2452
+ - a new settings object with all set parameters.
2448
2453
 
2449
2454
 
2450
2455
 
2451
2456
 
2452
- ### dist/general/mix/isNaNV2.js
2457
+ ### dist/general/object/objectCopy.js
2453
2458
 
2454
2459
 
2455
- #### isNaNV2(variable)
2460
+ #### objectCopy(entity, cache)
2456
2461
 
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.
2462
+ Created a new reference of the given argument
2460
2463
 
2461
2464
 
2462
2465
 
@@ -2465,7 +2468,8 @@ Validates if variable is null, undefined, or an empty string, also, the function
2465
2468
 
2466
2469
  | Name | Type | Description | |
2467
2470
  | ---- | ---- | ----------- | -------- |
2468
- | variable | | the variable to validate | &nbsp; |
2471
+ | entity | | The variable to be copied | &nbsp; |
2472
+ | cache | | | &nbsp; |
2469
2473
 
2470
2474
 
2471
2475
 
@@ -2473,18 +2477,17 @@ Validates if variable is null, undefined, or an empty string, also, the function
2473
2477
  ##### Returns
2474
2478
 
2475
2479
 
2476
- - True if variable is a NaN or false otherwise
2480
+ - A new reference of the given argument
2477
2481
 
2478
2482
 
2479
2483
 
2480
2484
 
2481
- ### dist/general/mix/isNull.js
2485
+ ### dist/general/object/omit.js
2482
2486
 
2483
2487
 
2484
- #### isNull(arg)
2488
+ #### omit(obj, props)
2485
2489
 
2486
- return if a given variable is either `null` or `undefined`
2487
- useful to avoid falsify validating Number Zero (0)
2490
+ return a new Object excluding attributes in _props_ list
2488
2491
 
2489
2492
 
2490
2493
 
@@ -2493,7 +2496,8 @@ useful to avoid falsify validating Number Zero (0)
2493
2496
 
2494
2497
  | Name | Type | Description | |
2495
2498
  | ---- | ---- | ----------- | -------- |
2496
- | arg | `any` | | &nbsp; |
2499
+ | obj | `Object` | base object | &nbsp; |
2500
+ | props | `Array.<String>` | list of attribute to exclude | &nbsp; |
2497
2501
 
2498
2502
 
2499
2503
 
@@ -2501,19 +2505,17 @@ useful to avoid falsify validating Number Zero (0)
2501
2505
  ##### Returns
2502
2506
 
2503
2507
 
2504
- - `Boolean`
2508
+ - `Object` clean object
2505
2509
 
2506
2510
 
2507
2511
 
2508
2512
 
2509
- ### dist/general/mix/size.js
2513
+ ### dist/general/object/pick.js
2510
2514
 
2511
2515
 
2512
- #### size(obj)
2516
+ #### pick(baseObject, keys)
2513
2517
 
2514
- Gets the length of the given array.
2515
- - Useful for Object, Array and string type.
2516
- - For `null` or `undefined` or else argument the returned value will be 0.
2518
+ return a new object just with attributes in _keys_ list
2517
2519
 
2518
2520
 
2519
2521
 
@@ -2522,7 +2524,8 @@ Gets the length of the given array.
2522
2524
 
2523
2525
  | Name | Type | Description | |
2524
2526
  | ---- | ---- | ----------- | -------- |
2525
- | obj | `Any` | Any object-type variable | &nbsp; |
2527
+ | baseObject | `Object` | base object | &nbsp; |
2528
+ | keys | `Array.<String>` | list of attributes to preserve | &nbsp; |
2526
2529
 
2527
2530
 
2528
2531
 
@@ -2530,19 +2533,17 @@ Gets the length of the given array.
2530
2533
  ##### Returns
2531
2534
 
2532
2535
 
2533
- - `Number` the size of the given variable
2536
+ - `Object` new object just with desired attributes
2534
2537
 
2535
2538
 
2536
2539
 
2537
2540
 
2538
- ### dist/general/mix/randomId.js
2541
+ ### dist/general/object/serialize.js
2539
2542
 
2540
2543
 
2541
- #### randomId(length, exclude)
2544
+ #### serialize(obj)
2542
2545
 
2543
- Creates a random string
2544
- - If the first given argument is different than a length number, the variable is replaced by a default number
2545
- - If the optional second given argument is passed the random string is permutated.
2546
+ serialize object to url param
2546
2547
 
2547
2548
 
2548
2549
 
@@ -2551,8 +2552,7 @@ Creates a random string
2551
2552
 
2552
2553
  | Name | Type | Description | |
2553
2554
  | ---- | ---- | ----------- | -------- |
2554
- | length | `Number` | size of the generated string. Default 8 | &nbsp; |
2555
- | exclude | `Array` | collection of strings that is going to be excluded of the random string. | &nbsp; |
2555
+ | obj | | - Object to be serialized | &nbsp; |
2556
2556
 
2557
2557
 
2558
2558
 
@@ -2560,7 +2560,7 @@ Creates a random string
2560
2560
  ##### Returns
2561
2561
 
2562
2562
 
2563
- - `String` Random string
2563
+ - `Void`
2564
2564
 
2565
2565
 
2566
2566
 
@@ -2592,6 +2592,33 @@ Upper case the first letter of a given text
2592
2592
 
2593
2593
 
2594
2594
 
2595
+ ### dist/qrvey/helpers/getColumnsLabel.js
2596
+
2597
+
2598
+ #### getColumnLabels(column)
2599
+
2600
+ Get an string of the properties of the given column.
2601
+
2602
+
2603
+
2604
+
2605
+ ##### Parameters
2606
+
2607
+ | Name | Type | Description | |
2608
+ | ---- | ---- | ----------- | -------- |
2609
+ | column | | The column | &nbsp; |
2610
+
2611
+
2612
+
2613
+
2614
+ ##### Returns
2615
+
2616
+
2617
+ - an string with the property, aggregate or calculation label.
2618
+
2619
+
2620
+
2621
+
2595
2622
  ### dist/services/api/getAllDatasets.api.js
2596
2623
 
2597
2624
 
@@ -2707,41 +2734,10 @@ someMethod() {
2707
2734
 
2708
2735
 
2709
2736
 
2710
- ### dist/stencil/util/getConfig.js
2737
+ ### dist/stencil/util/createRef.js
2711
2738
 
2712
2739
 
2713
- #### getConfig(cfg)
2714
-
2715
- verify the Config object type and try to return a parsed Object
2716
- - In case _cfg_ is a string, first try to make a JSON parse in other case
2717
- try to find this string as a variable on Windows object
2718
- - If _cfg_ is a fuction, tis is invoked and parsed
2719
- - Finally, if is an object, _cfg_ is inmediatly returned
2720
-
2721
-
2722
-
2723
-
2724
- ##### Parameters
2725
-
2726
- | Name | Type | Description | |
2727
- | ---- | ---- | ----------- | -------- |
2728
- | cfg | | | &nbsp; |
2729
-
2730
-
2731
-
2732
-
2733
- ##### Returns
2734
-
2735
-
2736
- - `Void`
2737
-
2738
-
2739
-
2740
-
2741
- ### dist/stencil/util/createRef.js
2742
-
2743
-
2744
- #### createRef()
2740
+ #### createRef()
2745
2741
 
2746
2742
  lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
2747
2743
 
@@ -2758,12 +2754,16 @@ lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom
2758
2754
 
2759
2755
 
2760
2756
 
2761
- ### dist/qrvey/helpers/getColumnsLabel.js
2757
+ ### dist/stencil/util/getConfig.js
2762
2758
 
2763
2759
 
2764
- #### getColumnLabels(column)
2760
+ #### getConfig(cfg)
2765
2761
 
2766
- Get an string of the properties of the given column.
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
2767
2767
 
2768
2768
 
2769
2769
 
@@ -2772,7 +2772,7 @@ Get an string of the properties of the given column.
2772
2772
 
2773
2773
  | Name | Type | Description | |
2774
2774
  | ---- | ---- | ----------- | -------- |
2775
- | column | | The column | &nbsp; |
2775
+ | cfg | | | &nbsp; |
2776
2776
 
2777
2777
 
2778
2778
 
@@ -2780,7 +2780,7 @@ Get an string of the properties of the given column.
2780
2780
  ##### Returns
2781
2781
 
2782
2782
 
2783
- - an string with the property, aggregate or calculation label.
2783
+ - `Void`
2784
2784
 
2785
2785
 
2786
2786
 
@@ -3244,12 +3244,12 @@ Returns a filter builder config object by a any given config
3244
3244
 
3245
3245
 
3246
3246
 
3247
- ### dist/filters/helpers/common/areFiltersEquals.js
3247
+ ### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
3248
3248
 
3249
3249
 
3250
- #### areFiltersEquals(filter1, filter2)
3250
+ #### excludeUIFiltersByAggregate(uFilters)
3251
3251
 
3252
- Validates if both filters are the same
3252
+ Excludes Aggregate Filters in the Flattened UI Filters array
3253
3253
 
3254
3254
 
3255
3255
 
@@ -3258,8 +3258,7 @@ Validates if both filters are the same
3258
3258
 
3259
3259
  | Name | Type | Description | |
3260
3260
  | ---- | ---- | ----------- | -------- |
3261
- | filter1 | | filter 1 | &nbsp; |
3262
- | filter2 | | filter 2 | &nbsp; |
3261
+ | uFilters | | Collection of Flat UI Filters | &nbsp; |
3263
3262
 
3264
3263
 
3265
3264
 
@@ -3267,17 +3266,17 @@ Validates if both filters are the same
3267
3266
  ##### Returns
3268
3267
 
3269
3268
 
3270
- - true: the filters are equal; false: the filters are NOT equal
3269
+ - a new Flat UI Filters that were excluded the aggregate filters
3271
3270
 
3272
3271
 
3273
3272
 
3274
3273
 
3275
- ### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
3274
+ ### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
3276
3275
 
3277
3276
 
3278
- #### excludeFiltersByAggregateColumn(filterData)
3277
+ #### excludeUIFlatFiltersByScopes(uFilters, scopes)
3279
3278
 
3280
- Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
3279
+ Excludes and returns a UI Flat Filters without filters by the given scopes
3281
3280
 
3282
3281
 
3283
3282
 
@@ -3286,7 +3285,8 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
3286
3285
 
3287
3286
  | Name | Type | Description | |
3288
3287
  | ---- | ---- | ----------- | -------- |
3289
- | filterData | | The filter data object | &nbsp; |
3288
+ | uFilters | | The Flatten UI Filters | &nbsp; |
3289
+ | scopes | | collection of scopes types | &nbsp; |
3290
3290
 
3291
3291
 
3292
3292
 
@@ -3294,26 +3294,17 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
3294
3294
  ##### Returns
3295
3295
 
3296
3296
 
3297
- - The new filter data object that were excluded the aggregate filters
3297
+ - The new array of UI Flattened filters
3298
3298
 
3299
3299
 
3300
3300
 
3301
3301
 
3302
- ### dist/filters/helpers/common/excludeFiltersByParams.js
3302
+ ### dist/filters/helpers/ui/getFilterPropertyLabel.js
3303
3303
 
3304
3304
 
3305
- #### excludeFiltersByParams(filterData, params)
3305
+ #### getFilterPropertyLabel(filter)
3306
3306
 
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
3307
+ Gets the label of the filter property
3317
3308
 
3318
3309
 
3319
3310
 
@@ -3322,8 +3313,7 @@ The validation to filter the stored filter is depending on:
3322
3313
 
3323
3314
  | Name | Type | Description | |
3324
3315
  | ---- | ---- | ----------- | -------- |
3325
- | filterData | | The Filter Data or the UI Filter Data | &nbsp; |
3326
- | params | | given parameters to validate the filter data | &nbsp; |
3316
+ | filter | | The UI Filter | &nbsp; |
3327
3317
 
3328
3318
 
3329
3319
 
@@ -3331,17 +3321,17 @@ The validation to filter the stored filter is depending on:
3331
3321
  ##### Returns
3332
3322
 
3333
3323
 
3334
- - a new Filter object structure
3324
+ - a string of the filter property label
3335
3325
 
3336
3326
 
3337
3327
 
3338
3328
 
3339
- ### dist/filters/helpers/common/excludeFiltersByScopes.js
3329
+ ### dist/filters/helpers/ui/getOutputFormatByColumn.js
3340
3330
 
3341
3331
 
3342
- #### excludeFiltersByScopes(filterData, scopes)
3332
+ #### getOutputFormatByColumn(column, datasets)
3343
3333
 
3344
- Excludes and returns a filter data without filters by the given scopes
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
3345
3335
 
3346
3336
 
3347
3337
 
@@ -3350,8 +3340,8 @@ Excludes and returns a filter data without filters by the given scopes
3350
3340
 
3351
3341
  | Name | Type | Description | |
3352
3342
  | ---- | ---- | ----------- | -------- |
3353
- | filterData | | The Filter Data | &nbsp; |
3354
- | scopes | | collection of scopes to be as filtering parameters | &nbsp; |
3343
+ | column | | The column | &nbsp; |
3344
+ | datasets | | array of datasets | &nbsp; |
3355
3345
 
3356
3346
 
3357
3347
 
@@ -3359,26 +3349,27 @@ Excludes and returns a filter data without filters by the given scopes
3359
3349
  ##### Returns
3360
3350
 
3361
3351
 
3362
- - The new Filter Data without filters by the given scopes.
3363
-
3364
-
3365
-
3352
+ - The output format object
3366
3353
 
3367
- ### dist/filters/helpers/common/getFilterColumnLabel.js
3368
3354
 
3369
3355
 
3370
- #### getFilterColumnLabel(column)
3371
3356
 
3372
- Get an string of the properties of the given filter column.
3357
+ ### dist/filters/helpers/ui/getUIFlatFilterByParams.js
3373
3358
 
3374
3359
 
3360
+ #### getUIFlatFilterByParams()
3375
3361
 
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
3376
3371
 
3377
- ##### Parameters
3378
3372
 
3379
- | Name | Type | Description | |
3380
- | ---- | ---- | ----------- | -------- |
3381
- | column | | The filter column | &nbsp; |
3382
3373
 
3383
3374
 
3384
3375
 
@@ -3386,26 +3377,28 @@ Get an string of the properties of the given filter column.
3386
3377
  ##### Returns
3387
3378
 
3388
3379
 
3389
- - an string with the property, aggregate or calculation label.
3390
-
3391
-
3392
-
3380
+ - The index of the uFilter array or the Filter object s
3393
3381
 
3394
- ### dist/filters/helpers/common/getFilterLabel.js
3395
3382
 
3396
3383
 
3397
- #### getFilterLabel(filter)
3398
3384
 
3399
- Gets the Filter Label + Column label
3385
+ ### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
3400
3386
 
3401
3387
 
3388
+ #### getUIFlatFiltersByParams()
3402
3389
 
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
3403
3400
 
3404
- ##### Parameters
3405
3401
 
3406
- | Name | Type | Description | |
3407
- | ---- | ---- | ----------- | -------- |
3408
- | filter | | the UI filter | &nbsp; |
3409
3402
 
3410
3403
 
3411
3404
 
@@ -3413,28 +3406,17 @@ Gets the Filter Label + Column label
3413
3406
  ##### Returns
3414
3407
 
3415
3408
 
3416
- - a sring label
3409
+ - The index of the uFilter array or the Filter object s
3417
3410
 
3418
3411
 
3419
3412
 
3420
3413
 
3421
- ### dist/filters/helpers/common/getFilterid.js
3414
+ ### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
3422
3415
 
3423
3416
 
3424
- #### getFilterid(filter)
3417
+ #### getUIFlatFiltersByScopes(uFilters, scopes)
3425
3418
 
3426
- Get the Filter ID by the filter structure
3427
- The order of the epression ID is:
3428
- - Scope Type
3429
- - scopeid
3430
- - qrveyid
3431
- - panelid
3432
- - columnid
3433
- - validator
3434
- - property
3435
- - Column Aggregate
3436
- - Column Calculation
3437
- - Optional Index
3419
+ Filters and gets a UI Flatten Filters by the given scopes
3438
3420
 
3439
3421
 
3440
3422
 
@@ -3443,7 +3425,8 @@ The order of the epression ID is:
3443
3425
 
3444
3426
  | Name | Type | Description | |
3445
3427
  | ---- | ---- | ----------- | -------- |
3446
- | filter | | the filter structure | &nbsp; |
3428
+ | uFilters | | The Flatten UI Filters | &nbsp; |
3429
+ | scopes | | collection of scopes types | &nbsp; |
3447
3430
 
3448
3431
 
3449
3432
 
@@ -3451,17 +3434,17 @@ The order of the epression ID is:
3451
3434
  ##### Returns
3452
3435
 
3453
3436
 
3454
- - a text to identify the filter
3437
+ - The new array of UI Flattened filters
3455
3438
 
3456
3439
 
3457
3440
 
3458
3441
 
3459
- ### dist/filters/helpers/common/getFiltersByAggregateColumn.js
3442
+ ### dist/filters/helpers/ui/getUIValues.js
3460
3443
 
3461
3444
 
3462
- #### getFiltersByAggregateColumn(filterData)
3445
+ #### getUIValues(filter, addEnableds, rankingGroupIndex)
3446
+
3463
3447
 
3464
- Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
3465
3448
 
3466
3449
 
3467
3450
 
@@ -3470,7 +3453,9 @@ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggr
3470
3453
 
3471
3454
  | Name | Type | Description | |
3472
3455
  | ---- | ---- | ----------- | -------- |
3473
- | filterData | | The filter data object | &nbsp; |
3456
+ | filter | | | &nbsp; |
3457
+ | addEnableds | | | &nbsp; |
3458
+ | rankingGroupIndex | | | &nbsp; |
3474
3459
 
3475
3460
 
3476
3461
 
@@ -3478,26 +3463,17 @@ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggr
3478
3463
  ##### Returns
3479
3464
 
3480
3465
 
3481
- - The new filter data object that were get the aggregate filters
3466
+ -
3482
3467
 
3483
3468
 
3484
3469
 
3485
3470
 
3486
- ### dist/filters/helpers/common/getFiltersByParams.js
3471
+ ### dist/filters/helpers/ui/resolveUIFlatFiltersByParams.js
3487
3472
 
3488
3473
 
3489
- #### getFiltersByParams(filterData, params)
3474
+ #### resolveUIFlatFilterByParams(filter, params)
3490
3475
 
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
3476
+ Resolves conditions between UI flattened filter and given parameters
3501
3477
 
3502
3478
 
3503
3479
 
@@ -3506,8 +3482,8 @@ The validation to filter the stored filter is depending on:
3506
3482
 
3507
3483
  | Name | Type | Description | |
3508
3484
  | ---- | ---- | ----------- | -------- |
3509
- | filterData | | The Filter Data or the UI Filter Data | &nbsp; |
3510
- | params | | given parameters to validate the dataset | &nbsp; |
3485
+ | filter | | UI Flatten Filter | &nbsp; |
3486
+ | params | | Parameters to validate | &nbsp; |
3511
3487
 
3512
3488
 
3513
3489
 
@@ -3515,17 +3491,17 @@ The validation to filter the stored filter is depending on:
3515
3491
  ##### Returns
3516
3492
 
3517
3493
 
3518
- - a new Filter object structure
3494
+ - true: the conditions are satisfied.
3519
3495
 
3520
3496
 
3521
3497
 
3522
3498
 
3523
- ### dist/filters/helpers/common/getFiltersByScopes.js
3499
+ ### dist/filters/helpers/common/areFiltersEquals.js
3524
3500
 
3525
3501
 
3526
- #### getFiltersByScopes(filterData, scopes)
3502
+ #### areFiltersEquals(filter1, filter2)
3527
3503
 
3528
- Filters and gets a Filter Data by the given scopes
3504
+ Validates if both filters are the same
3529
3505
 
3530
3506
 
3531
3507
 
@@ -3534,8 +3510,8 @@ Filters and gets a Filter Data by the given scopes
3534
3510
 
3535
3511
  | Name | Type | Description | |
3536
3512
  | ---- | ---- | ----------- | -------- |
3537
- | filterData | | The Filter Data | &nbsp; |
3538
- | scopes | | collection of scopes types | &nbsp; |
3513
+ | filter1 | | filter 1 | &nbsp; |
3514
+ | filter2 | | filter 2 | &nbsp; |
3539
3515
 
3540
3516
 
3541
3517
 
@@ -3543,17 +3519,17 @@ Filters and gets a Filter Data by the given scopes
3543
3519
  ##### Returns
3544
3520
 
3545
3521
 
3546
- - The new Filter Data
3522
+ - true: the filters are equal; false: the filters are NOT equal
3547
3523
 
3548
3524
 
3549
3525
 
3550
3526
 
3551
- ### dist/filters/helpers/common/getFiltersByScopesIds.js
3527
+ ### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
3552
3528
 
3553
3529
 
3554
- #### getFiltersByScopesIds(filterData, scopes)
3530
+ #### excludeFiltersByAggregateColumn(filterData)
3555
3531
 
3556
- Gets filters from Filter Data by Scopes/Scope IDs.
3532
+ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
3557
3533
 
3558
3534
 
3559
3535
 
@@ -3562,8 +3538,7 @@ Gets filters from Filter Data by Scopes/Scope IDs.
3562
3538
 
3563
3539
  | Name | Type | Description | |
3564
3540
  | ---- | ---- | ----------- | -------- |
3565
- | filterData | | The filter data | &nbsp; |
3566
- | scopes | | The collection of Scopes/Scope IDs | &nbsp; |
3541
+ | filterData | | The filter data object | &nbsp; |
3567
3542
 
3568
3543
 
3569
3544
 
@@ -3571,17 +3546,26 @@ Gets filters from Filter Data by Scopes/Scope IDs.
3571
3546
  ##### Returns
3572
3547
 
3573
3548
 
3574
- - a new Filter Data
3549
+ - The new filter data object that were excluded the aggregate filters
3575
3550
 
3576
3551
 
3577
3552
 
3578
3553
 
3579
- ### dist/filters/helpers/common/getFiltersByVisibility.js
3554
+ ### dist/filters/helpers/common/excludeFiltersByParams.js
3580
3555
 
3581
3556
 
3582
- #### getFiltersByVisibility(filterData, scopes)
3557
+ #### excludeFiltersByParams(filterData, params)
3583
3558
 
3584
- Get a new Filter Data by filtering scopes/scope IDs and enabled flags
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
3585
3569
 
3586
3570
 
3587
3571
 
@@ -3590,8 +3574,8 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
3590
3574
 
3591
3575
  | Name | Type | Description | |
3592
3576
  | ---- | ---- | ----------- | -------- |
3593
- | filterData | | a Filter Data or UI Filter Data | &nbsp; |
3594
- | scopes | | a Scopes/Scope IDs array | &nbsp; |
3577
+ | filterData | | The Filter Data or the UI Filter Data | &nbsp; |
3578
+ | params | | given parameters to validate the filter data | &nbsp; |
3595
3579
 
3596
3580
 
3597
3581
 
@@ -3599,17 +3583,17 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
3599
3583
  ##### Returns
3600
3584
 
3601
3585
 
3602
- - a new Filter Data
3586
+ - a new Filter object structure
3603
3587
 
3604
3588
 
3605
3589
 
3606
3590
 
3607
- ### dist/filters/helpers/common/getMergeFiltersSettings.js
3591
+ ### dist/filters/helpers/common/excludeFiltersByScopes.js
3608
3592
 
3609
3593
 
3610
- #### getMergeFiltersSettings(settings)
3594
+ #### excludeFiltersByScopes(filterData, scopes)
3611
3595
 
3612
- Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
3596
+ Excludes and returns a filter data without filters by the given scopes
3613
3597
 
3614
3598
 
3615
3599
 
@@ -3618,7 +3602,8 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
3618
3602
 
3619
3603
  | Name | Type | Description | |
3620
3604
  | ---- | ---- | ----------- | -------- |
3621
- | settings | | an object to the MergeFilters settings | &nbsp; |
3605
+ | filterData | | The Filter Data | &nbsp; |
3606
+ | scopes | | collection of scopes to be as filtering parameters | &nbsp; |
3622
3607
 
3623
3608
 
3624
3609
 
@@ -3626,17 +3611,17 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
3626
3611
  ##### Returns
3627
3612
 
3628
3613
 
3629
- - a new MergeFilters settings object.
3614
+ - The new Filter Data without filters by the given scopes.
3630
3615
 
3631
3616
 
3632
3617
 
3633
3618
 
3634
- ### dist/filters/helpers/common/getParamsToGetFilterSettings.js
3619
+ ### dist/filters/helpers/common/getFilterLabel.js
3635
3620
 
3636
3621
 
3637
- #### getParamsToGetFilterSettings(settings)
3622
+ #### getFilterLabel(filter)
3638
3623
 
3639
- Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
3624
+ Gets the Filter Label + Column label
3640
3625
 
3641
3626
 
3642
3627
 
@@ -3645,7 +3630,7 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
3645
3630
 
3646
3631
  | Name | Type | Description | |
3647
3632
  | ---- | ---- | ----------- | -------- |
3648
- | settings | | an object to the ParamsToGetFilter settings | &nbsp; |
3633
+ | filter | | the UI filter | &nbsp; |
3649
3634
 
3650
3635
 
3651
3636
 
@@ -3653,17 +3638,17 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
3653
3638
  ##### Returns
3654
3639
 
3655
3640
 
3656
- - a new ParamsToGetFilter settings object.
3641
+ - a sring label
3657
3642
 
3658
3643
 
3659
3644
 
3660
3645
 
3661
- ### dist/filters/helpers/common/haveFiltersByDataset.js
3646
+ ### dist/filters/helpers/common/getFilterColumnLabel.js
3662
3647
 
3663
3648
 
3664
- #### haveFiltersByDataset(filterData, qrveyid)
3649
+ #### getFilterColumnLabel(column)
3665
3650
 
3666
- Validates if the filter data has filters by a dataset ID (Qrvey ID).
3651
+ Get an string of the properties of the given filter column.
3667
3652
 
3668
3653
 
3669
3654
 
@@ -3672,8 +3657,7 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
3672
3657
 
3673
3658
  | Name | Type | Description | |
3674
3659
  | ---- | ---- | ----------- | -------- |
3675
- | filterData | | the filter data or the UI filter data. | &nbsp; |
3676
- | qrveyid | | The Qrvey ID | &nbsp; |
3660
+ | column | | The filter column | &nbsp; |
3677
3661
 
3678
3662
 
3679
3663
 
@@ -3681,17 +3665,28 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
3681
3665
  ##### Returns
3682
3666
 
3683
3667
 
3684
- - true: the filter data has filters by the Qrvey ID
3668
+ - an string with the property, aggregate or calculation label.
3685
3669
 
3686
3670
 
3687
3671
 
3688
3672
 
3689
- ### dist/filters/helpers/common/isBetweenValidator.js
3673
+ ### dist/filters/helpers/common/getFilterid.js
3690
3674
 
3691
3675
 
3692
- #### isBetweenValidator(validator)
3676
+ #### getFilterid(filter)
3693
3677
 
3694
- Validates if the given validator is a Between type
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
3695
3690
 
3696
3691
 
3697
3692
 
@@ -3700,7 +3695,7 @@ Validates if the given validator is a Between type
3700
3695
 
3701
3696
  | Name | Type | Description | |
3702
3697
  | ---- | ---- | ----------- | -------- |
3703
- | validator | | The validator | &nbsp; |
3698
+ | filter | | the filter structure | &nbsp; |
3704
3699
 
3705
3700
 
3706
3701
 
@@ -3708,17 +3703,17 @@ Validates if the given validator is a Between type
3708
3703
  ##### Returns
3709
3704
 
3710
3705
 
3711
- - true: it is a between validator; false: it is not a between validator
3706
+ - a text to identify the filter
3712
3707
 
3713
3708
 
3714
3709
 
3715
3710
 
3716
- ### dist/filters/helpers/common/isDateDistinctProperty.js
3711
+ ### dist/filters/helpers/common/getFiltersByAggregateColumn.js
3717
3712
 
3718
3713
 
3719
- #### isDateDistinctProperty(column, property)
3714
+ #### getFiltersByAggregateColumn(filterData)
3720
3715
 
3721
- Determines if the filter column and property is a distinct group dates type
3716
+ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
3722
3717
 
3723
3718
 
3724
3719
 
@@ -3727,8 +3722,7 @@ Determines if the filter column and property is a distinct group dates type
3727
3722
 
3728
3723
  | Name | Type | Description | |
3729
3724
  | ---- | ---- | ----------- | -------- |
3730
- | column | | The filter column | &nbsp; |
3731
- | property | | The filter property | &nbsp; |
3725
+ | filterData | | The filter data object | &nbsp; |
3732
3726
 
3733
3727
 
3734
3728
 
@@ -3736,17 +3730,26 @@ Determines if the filter column and property is a distinct group dates type
3736
3730
  ##### Returns
3737
3731
 
3738
3732
 
3739
- - True if the given property is included from distinct group dates type
3733
+ - The new filter data object that were get the aggregate filters
3740
3734
 
3741
3735
 
3742
3736
 
3743
3737
 
3744
- ### dist/filters/helpers/common/isInValidator.js
3738
+ ### dist/filters/helpers/common/getFiltersByParams.js
3745
3739
 
3746
3740
 
3747
- #### isInValidator(validator)
3741
+ #### getFiltersByParams(filterData, params)
3748
3742
 
3749
- Validates if the given validator is a In type
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
3750
3753
 
3751
3754
 
3752
3755
 
@@ -3755,7 +3758,8 @@ Validates if the given validator is a In type
3755
3758
 
3756
3759
  | Name | Type | Description | |
3757
3760
  | ---- | ---- | ----------- | -------- |
3758
- | validator | | The validator | &nbsp; |
3761
+ | filterData | | The Filter Data or the UI Filter Data | &nbsp; |
3762
+ | params | | given parameters to validate the dataset | &nbsp; |
3759
3763
 
3760
3764
 
3761
3765
 
@@ -3763,17 +3767,17 @@ Validates if the given validator is a In type
3763
3767
  ##### Returns
3764
3768
 
3765
3769
 
3766
- - true: it is a In validator; false: it is not a In validator
3770
+ - a new Filter object structure
3767
3771
 
3768
3772
 
3769
3773
 
3770
3774
 
3771
- ### dist/filters/helpers/common/isNullValidator.js
3775
+ ### dist/filters/helpers/common/getFiltersByScopes.js
3772
3776
 
3773
3777
 
3774
- #### isNullValidator(validator)
3778
+ #### getFiltersByScopes(filterData, scopes)
3775
3779
 
3776
- Checks if the given validator is a Null type.
3780
+ Filters and gets a Filter Data by the given scopes
3777
3781
 
3778
3782
 
3779
3783
 
@@ -3782,7 +3786,8 @@ Checks if the given validator is a Null type.
3782
3786
 
3783
3787
  | Name | Type | Description | |
3784
3788
  | ---- | ---- | ----------- | -------- |
3785
- | validator | | The Filter Validator | &nbsp; |
3789
+ | filterData | | The Filter Data | &nbsp; |
3790
+ | scopes | | collection of scopes types | &nbsp; |
3786
3791
 
3787
3792
 
3788
3793
 
@@ -3790,17 +3795,17 @@ Checks if the given validator is a Null type.
3790
3795
  ##### Returns
3791
3796
 
3792
3797
 
3793
- - True: It is a Null Validator; False: It is not a Null Validator.
3798
+ - The new Filter Data
3794
3799
 
3795
3800
 
3796
3801
 
3797
3802
 
3798
- ### dist/filters/helpers/common/isRangeValidator.js
3803
+ ### dist/filters/helpers/common/getFiltersByScopesIds.js
3799
3804
 
3800
3805
 
3801
- #### isRangeValidator(validator)
3806
+ #### getFiltersByScopesIds(filterData, scopes)
3802
3807
 
3803
- Validates if the given validator is a Range type. Range type means the value has min and max values to filter
3808
+ Gets filters from Filter Data by Scopes/Scope IDs.
3804
3809
 
3805
3810
 
3806
3811
 
@@ -3809,7 +3814,8 @@ Validates if the given validator is a Range type. Range type means the value has
3809
3814
 
3810
3815
  | Name | Type | Description | |
3811
3816
  | ---- | ---- | ----------- | -------- |
3812
- | validator | | The filter validator | &nbsp; |
3817
+ | filterData | | The filter data | &nbsp; |
3818
+ | scopes | | The collection of Scopes/Scope IDs | &nbsp; |
3813
3819
 
3814
3820
 
3815
3821
 
@@ -3817,17 +3823,17 @@ Validates if the given validator is a Range type. Range type means the value has
3817
3823
  ##### Returns
3818
3824
 
3819
3825
 
3820
- - true: it is a range validator
3826
+ - a new Filter Data
3821
3827
 
3822
3828
 
3823
3829
 
3824
3830
 
3825
- ### dist/filters/helpers/common/isRegularValidator.js
3831
+ ### dist/filters/helpers/common/getFiltersByVisibility.js
3826
3832
 
3827
3833
 
3828
- #### isRegularValidator(validator)
3834
+ #### getFiltersByVisibility(filterData, scopes)
3829
3835
 
3830
- Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
3836
+ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
3831
3837
 
3832
3838
 
3833
3839
 
@@ -3836,7 +3842,8 @@ Validates if the given validator is a regular type. Regular type means the filte
3836
3842
 
3837
3843
  | Name | Type | Description | |
3838
3844
  | ---- | ---- | ----------- | -------- |
3839
- | validator | | The filter validator | &nbsp; |
3845
+ | filterData | | a Filter Data or UI Filter Data | &nbsp; |
3846
+ | scopes | | a Scopes/Scope IDs array | &nbsp; |
3840
3847
 
3841
3848
 
3842
3849
 
@@ -3844,17 +3851,17 @@ Validates if the given validator is a regular type. Regular type means the filte
3844
3851
  ##### Returns
3845
3852
 
3846
3853
 
3847
- - true: it is a range validator
3854
+ - a new Filter Data
3848
3855
 
3849
3856
 
3850
3857
 
3851
3858
 
3852
- ### dist/filters/helpers/common/mergeFilters.js
3859
+ ### dist/filters/helpers/common/getMergeFiltersSettings.js
3853
3860
 
3854
3861
 
3855
- #### mergeFilters(filterData1, filterData2, overwriteValues)
3862
+ #### getMergeFiltersSettings(settings)
3856
3863
 
3857
- Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
3864
+ Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
3858
3865
 
3859
3866
 
3860
3867
 
@@ -3863,9 +3870,7 @@ Merge filter data structures in a new one. The first Filter Data passed in the a
3863
3870
 
3864
3871
  | Name | Type | Description | |
3865
3872
  | ---- | ---- | ----------- | -------- |
3866
- | filterData1 | | The target filter data | &nbsp; |
3867
- | filterData2 | | the filter data to be merged | &nbsp; |
3868
- | overwriteValues | | Flag to overwrite or not the filter values | &nbsp; |
3873
+ | settings | | an object to the MergeFilters settings | &nbsp; |
3869
3874
 
3870
3875
 
3871
3876
 
@@ -3873,13 +3878,17 @@ Merge filter data structures in a new one. The first Filter Data passed in the a
3873
3878
  ##### Returns
3874
3879
 
3875
3880
 
3876
- - a new filter data structure
3881
+ - a new MergeFilters settings object.
3877
3882
 
3878
3883
 
3879
3884
 
3880
- #### mergeScopes(scopes1, scopes2, overwriteValues)
3881
3885
 
3882
- Gets a new scope structure array by merging two scope structures
3886
+ ### dist/filters/helpers/common/getParamsToGetFilterSettings.js
3887
+
3888
+
3889
+ #### getParamsToGetFilterSettings(settings)
3890
+
3891
+ Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
3883
3892
 
3884
3893
 
3885
3894
 
@@ -3888,9 +3897,7 @@ Gets a new scope structure array by merging two scope structures
3888
3897
 
3889
3898
  | Name | Type | Description | |
3890
3899
  | ---- | ---- | ----------- | -------- |
3891
- | scopes1 | | the target scope structure | &nbsp; |
3892
- | scopes2 | | the scope to be merged | &nbsp; |
3893
- | overwriteValues | | Flag to overwrite or not the filter values | &nbsp; |
3900
+ | settings | | an object to the ParamsToGetFilter settings | &nbsp; |
3894
3901
 
3895
3902
 
3896
3903
 
@@ -3898,13 +3905,17 @@ Gets a new scope structure array by merging two scope structures
3898
3905
  ##### Returns
3899
3906
 
3900
3907
 
3901
- - a new scope structure array
3908
+ - a new ParamsToGetFilter settings object.
3902
3909
 
3903
3910
 
3904
3911
 
3905
- #### mergeDatasets(datasets1, datasets2, overwriteValues)
3906
3912
 
3907
- Gets a new dataset structure array by merging two dataset structures
3913
+ ### dist/filters/helpers/common/haveFiltersByDataset.js
3914
+
3915
+
3916
+ #### haveFiltersByDataset(filterData, qrveyid)
3917
+
3918
+ Validates if the filter data has filters by a dataset ID (Qrvey ID).
3908
3919
 
3909
3920
 
3910
3921
 
@@ -3913,9 +3924,8 @@ Gets a new dataset structure array by merging two dataset structures
3913
3924
 
3914
3925
  | Name | Type | Description | |
3915
3926
  | ---- | ---- | ----------- | -------- |
3916
- | datasets1 | | the target dataset structure | &nbsp; |
3917
- | datasets2 | | the dataset to be merged | &nbsp; |
3918
- | overwriteValues | | Flag to overwrite or not the filter values | &nbsp; |
3927
+ | filterData | | the filter data or the UI filter data. | &nbsp; |
3928
+ | qrveyid | | The Qrvey ID | &nbsp; |
3919
3929
 
3920
3930
 
3921
3931
 
@@ -3923,13 +3933,17 @@ Gets a new dataset structure array by merging two dataset structures
3923
3933
  ##### Returns
3924
3934
 
3925
3935
 
3926
- - a new dataset structure array
3936
+ - true: the filter data has filters by the Qrvey ID
3927
3937
 
3928
3938
 
3929
3939
 
3930
- #### mergeFilterss(filters1, filters2, overwriteValues)
3931
3940
 
3932
- Gets a new filter structure array by merging two filter structures
3941
+ ### dist/filters/helpers/common/isBetweenValidator.js
3942
+
3943
+
3944
+ #### isBetweenValidator(validator)
3945
+
3946
+ Validates if the given validator is a Between type
3933
3947
 
3934
3948
 
3935
3949
 
@@ -3938,9 +3952,7 @@ Gets a new filter structure array by merging two filter structures
3938
3952
 
3939
3953
  | Name | Type | Description | |
3940
3954
  | ---- | ---- | ----------- | -------- |
3941
- | filters1 | | the target filter structure | &nbsp; |
3942
- | filters2 | | the filter to be merged | &nbsp; |
3943
- | overwriteValues | | Flag to overwrite or not the filter values | &nbsp; |
3955
+ | validator | | The validator | &nbsp; |
3944
3956
 
3945
3957
 
3946
3958
 
@@ -3948,13 +3960,17 @@ Gets a new filter structure array by merging two filter structures
3948
3960
  ##### Returns
3949
3961
 
3950
3962
 
3951
- - a new filter structure array
3963
+ - true: it is a between validator; false: it is not a between validator
3952
3964
 
3953
3965
 
3954
3966
 
3955
- #### mergeValues(filter1, filter2, overwrite)
3956
3967
 
3957
- Gets a new value structure array by merging two value structures
3968
+ ### dist/filters/helpers/common/isDateDistinctProperty.js
3969
+
3970
+
3971
+ #### isDateDistinctProperty(column, property)
3972
+
3973
+ Determines if the filter column and property is a distinct group dates type
3958
3974
 
3959
3975
 
3960
3976
 
@@ -3963,9 +3979,8 @@ Gets a new value structure array by merging two value structures
3963
3979
 
3964
3980
  | Name | Type | Description | |
3965
3981
  | ---- | ---- | ----------- | -------- |
3966
- | filter1 | | the target filter structure | &nbsp; |
3967
- | filter2 | | the filter to be used to merge the values | &nbsp; |
3968
- | overwrite | | Flag to overwrite or not the filter values | &nbsp; |
3982
+ | column | | The filter column | &nbsp; |
3983
+ | property | | The filter property | &nbsp; |
3969
3984
 
3970
3985
 
3971
3986
 
@@ -3973,17 +3988,17 @@ Gets a new value structure array by merging two value structures
3973
3988
  ##### Returns
3974
3989
 
3975
3990
 
3976
- - a new value structure array
3991
+ - True if the given property is included from distinct group dates type
3977
3992
 
3978
3993
 
3979
3994
 
3980
3995
 
3981
- ### dist/filters/helpers/common/resolveDatasetConditions.js
3996
+ ### dist/filters/helpers/common/isInValidator.js
3982
3997
 
3983
3998
 
3984
- #### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
3999
+ #### isInValidator(validator)
3985
4000
 
3986
- Resolves the conditions by given params
4001
+ Validates if the given validator is a In type
3987
4002
 
3988
4003
 
3989
4004
 
@@ -3992,10 +4007,7 @@ Resolves the conditions by given params
3992
4007
 
3993
4008
  | Name | Type | Description | |
3994
4009
  | ---- | ---- | ----------- | -------- |
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; |
4010
+ | validator | | The validator | &nbsp; |
3999
4011
 
4000
4012
 
4001
4013
 
@@ -4003,17 +4015,17 @@ Resolves the conditions by given params
4003
4015
  ##### Returns
4004
4016
 
4005
4017
 
4006
- - true: the condition is satisfied
4018
+ - true: it is a In validator; false: it is not a In validator
4007
4019
 
4008
4020
 
4009
4021
 
4010
4022
 
4011
- ### dist/filters/helpers/common/resolveFilterConditions.js
4023
+ ### dist/filters/helpers/common/isNullValidator.js
4012
4024
 
4013
4025
 
4014
- #### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
4026
+ #### isNullValidator(validator)
4015
4027
 
4016
- Resolves the conditions by given params
4028
+ Checks if the given validator is a Null type.
4017
4029
 
4018
4030
 
4019
4031
 
@@ -4022,10 +4034,7 @@ Resolves the conditions by given params
4022
4034
 
4023
4035
  | Name | Type | Description | |
4024
4036
  | ---- | ---- | ----------- | -------- |
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; |
4037
+ | validator | | The Filter Validator | &nbsp; |
4029
4038
 
4030
4039
 
4031
4040
 
@@ -4033,17 +4042,17 @@ Resolves the conditions by given params
4033
4042
  ##### Returns
4034
4043
 
4035
4044
 
4036
- - true: the condition is satisfied
4045
+ - True: It is a Null Validator; False: It is not a Null Validator.
4037
4046
 
4038
4047
 
4039
4048
 
4040
4049
 
4041
- ### dist/filters/helpers/common/resolveScopeConditions.js
4050
+ ### dist/filters/helpers/common/isRegularValidator.js
4042
4051
 
4043
4052
 
4044
- #### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
4053
+ #### isRegularValidator(validator)
4045
4054
 
4046
- Resolves the conditions by given params
4055
+ Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
4047
4056
 
4048
4057
 
4049
4058
 
@@ -4052,10 +4061,7 @@ Resolves the conditions by given params
4052
4061
 
4053
4062
  | Name | Type | Description | |
4054
4063
  | ---- | ---- | ----------- | -------- |
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; |
4064
+ | validator | | The filter validator | &nbsp; |
4059
4065
 
4060
4066
 
4061
4067
 
@@ -4063,17 +4069,17 @@ Resolves the conditions by given params
4063
4069
  ##### Returns
4064
4070
 
4065
4071
 
4066
- - true: the condition is satisfied
4072
+ - true: it is a range validator
4067
4073
 
4068
4074
 
4069
4075
 
4070
4076
 
4071
- ### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
4077
+ ### dist/filters/helpers/common/isRangeValidator.js
4072
4078
 
4073
4079
 
4074
- #### excludeUIFiltersByAggregate(uFilters)
4080
+ #### isRangeValidator(validator)
4075
4081
 
4076
- Excludes Aggregate Filters in the Flattened UI Filters array
4082
+ Validates if the given validator is a Range type. Range type means the value has min and max values to filter
4077
4083
 
4078
4084
 
4079
4085
 
@@ -4082,7 +4088,7 @@ Excludes Aggregate Filters in the Flattened UI Filters array
4082
4088
 
4083
4089
  | Name | Type | Description | |
4084
4090
  | ---- | ---- | ----------- | -------- |
4085
- | uFilters | | Collection of Flat UI Filters | &nbsp; |
4091
+ | validator | | The filter validator | &nbsp; |
4086
4092
 
4087
4093
 
4088
4094
 
@@ -4090,17 +4096,17 @@ Excludes Aggregate Filters in the Flattened UI Filters array
4090
4096
  ##### Returns
4091
4097
 
4092
4098
 
4093
- - a new Flat UI Filters that were excluded the aggregate filters
4099
+ - true: it is a range validator
4094
4100
 
4095
4101
 
4096
4102
 
4097
4103
 
4098
- ### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
4104
+ ### dist/filters/helpers/common/mergeFilters.js
4099
4105
 
4100
4106
 
4101
- #### excludeUIFlatFiltersByScopes(uFilters, scopes)
4107
+ #### mergeFilters(filterData1, filterData2, overwriteValues)
4102
4108
 
4103
- Excludes and returns a UI Flat Filters without filters by the given scopes
4109
+ Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
4104
4110
 
4105
4111
 
4106
4112
 
@@ -4109,8 +4115,9 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
4109
4115
 
4110
4116
  | Name | Type | Description | |
4111
4117
  | ---- | ---- | ----------- | -------- |
4112
- | uFilters | | The Flatten UI Filters | &nbsp; |
4113
- | scopes | | collection of scopes types | &nbsp; |
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; |
4114
4121
 
4115
4122
 
4116
4123
 
@@ -4118,17 +4125,13 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
4118
4125
  ##### Returns
4119
4126
 
4120
4127
 
4121
- - The new array of UI Flattened filters
4122
-
4123
-
4128
+ - a new filter data structure
4124
4129
 
4125
4130
 
4126
- ### dist/filters/helpers/ui/getFilterPropertyLabel.js
4127
4131
 
4132
+ #### mergeScopes(scopes1, scopes2, overwriteValues)
4128
4133
 
4129
- #### getFilterPropertyLabel(filter)
4130
-
4131
- Gets the label of the filter property
4134
+ Gets a new scope structure array by merging two scope structures
4132
4135
 
4133
4136
 
4134
4137
 
@@ -4137,7 +4140,9 @@ Gets the label of the filter property
4137
4140
 
4138
4141
  | Name | Type | Description | |
4139
4142
  | ---- | ---- | ----------- | -------- |
4140
- | filter | | The UI Filter | &nbsp; |
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; |
4141
4146
 
4142
4147
 
4143
4148
 
@@ -4145,17 +4150,13 @@ Gets the label of the filter property
4145
4150
  ##### Returns
4146
4151
 
4147
4152
 
4148
- - a string of the filter property label
4149
-
4150
-
4151
-
4153
+ - a new scope structure array
4152
4154
 
4153
- ### dist/filters/helpers/ui/getOutputFormatByColumn.js
4154
4155
 
4155
4156
 
4156
- #### getOutputFormatByColumn(column, datasets)
4157
+ #### mergeDatasets(datasets1, datasets2, overwriteValues)
4157
4158
 
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
+ Gets a new dataset structure array by merging two dataset structures
4159
4160
 
4160
4161
 
4161
4162
 
@@ -4164,8 +4165,9 @@ Gets output format object from Datasets by the given column. Item of the dataset
4164
4165
 
4165
4166
  | Name | Type | Description | |
4166
4167
  | ---- | ---- | ----------- | -------- |
4167
- | column | | The column | &nbsp; |
4168
- | datasets | | array of datasets | &nbsp; |
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; |
4169
4171
 
4170
4172
 
4171
4173
 
@@ -4173,27 +4175,24 @@ Gets output format object from Datasets by the given column. Item of the dataset
4173
4175
  ##### Returns
4174
4176
 
4175
4177
 
4176
- - The output format object
4178
+ - a new dataset structure array
4177
4179
 
4178
4180
 
4179
4181
 
4182
+ #### mergeFilterss(filters1, filters2, overwriteValues)
4180
4183
 
4181
- ### dist/filters/helpers/ui/getUIFlatFilterByParams.js
4184
+ Gets a new filter structure array by merging two filter structures
4182
4185
 
4183
4186
 
4184
- #### getUIFlatFilterByParams()
4185
4187
 
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
4188
 
4189
+ ##### Parameters
4196
4190
 
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; |
4197
4196
 
4198
4197
 
4199
4198
 
@@ -4201,28 +4200,24 @@ The validation to filter the stored filter is depending on:
4201
4200
  ##### Returns
4202
4201
 
4203
4202
 
4204
- - The index of the uFilter array or the Filter object s
4203
+ - a new filter structure array
4205
4204
 
4206
4205
 
4207
4206
 
4207
+ #### mergeValues(filter1, filter2, overwrite)
4208
4208
 
4209
- ### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
4209
+ Gets a new value structure array by merging two value structures
4210
4210
 
4211
4211
 
4212
- #### getUIFlatFiltersByParams()
4213
4212
 
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
4213
 
4214
+ ##### Parameters
4225
4215
 
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; |
4226
4221
 
4227
4222
 
4228
4223
 
@@ -4230,17 +4225,17 @@ The validation to filter the stored filter is depending on:
4230
4225
  ##### Returns
4231
4226
 
4232
4227
 
4233
- - The index of the uFilter array or the Filter object s
4228
+ - a new value structure array
4234
4229
 
4235
4230
 
4236
4231
 
4237
4232
 
4238
- ### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
4233
+ ### dist/filters/helpers/common/resolveDatasetConditions.js
4239
4234
 
4240
4235
 
4241
- #### getUIFlatFiltersByScopes(uFilters, scopes)
4236
+ #### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
4242
4237
 
4243
- Filters and gets a UI Flatten Filters by the given scopes
4238
+ Resolves the conditions by given params
4244
4239
 
4245
4240
 
4246
4241
 
@@ -4249,8 +4244,10 @@ Filters and gets a UI Flatten Filters by the given scopes
4249
4244
 
4250
4245
  | Name | Type | Description | |
4251
4246
  | ---- | ---- | ----------- | -------- |
4252
- | uFilters | | The Flatten UI Filters | &nbsp; |
4253
- | scopes | | collection of scopes types | &nbsp; |
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; |
4254
4251
 
4255
4252
 
4256
4253
 
@@ -4258,17 +4255,17 @@ Filters and gets a UI Flatten Filters by the given scopes
4258
4255
  ##### Returns
4259
4256
 
4260
4257
 
4261
- - The new array of UI Flattened filters
4262
-
4258
+ - true: the condition is satisfied
4263
4259
 
4264
4260
 
4265
4261
 
4266
- ### dist/filters/helpers/ui/getUIValues.js
4267
4262
 
4263
+ ### dist/filters/helpers/common/resolveFilterConditions.js
4268
4264
 
4269
- #### getUIValues(filter, addEnableds, rankingGroupIndex)
4270
4265
 
4266
+ #### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
4271
4267
 
4268
+ Resolves the conditions by given params
4272
4269
 
4273
4270
 
4274
4271
 
@@ -4277,9 +4274,10 @@ Filters and gets a UI Flatten Filters by the given scopes
4277
4274
 
4278
4275
  | Name | Type | Description | |
4279
4276
  | ---- | ---- | ----------- | -------- |
4280
- | filter | | | &nbsp; |
4281
- | addEnableds | | | &nbsp; |
4282
- | rankingGroupIndex | | | &nbsp; |
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; |
4283
4281
 
4284
4282
 
4285
4283
 
@@ -4287,17 +4285,17 @@ Filters and gets a UI Flatten Filters by the given scopes
4287
4285
  ##### Returns
4288
4286
 
4289
4287
 
4290
- -
4288
+ - true: the condition is satisfied
4291
4289
 
4292
4290
 
4293
4291
 
4294
4292
 
4295
- ### dist/filters/helpers/ui/resolveUIFlatFiltersByParams.js
4293
+ ### dist/filters/helpers/common/resolveScopeConditions.js
4296
4294
 
4297
4295
 
4298
- #### resolveUIFlatFilterByParams(filter, params)
4296
+ #### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
4299
4297
 
4300
- Resolves conditions between UI flattened filter and given parameters
4298
+ Resolves the conditions by given params
4301
4299
 
4302
4300
 
4303
4301
 
@@ -4306,8 +4304,10 @@ Resolves conditions between UI flattened filter and given parameters
4306
4304
 
4307
4305
  | Name | Type | Description | |
4308
4306
  | ---- | ---- | ----------- | -------- |
4309
- | filter | | UI Flatten Filter | &nbsp; |
4310
- | params | | Parameters to validate | &nbsp; |
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; |
4311
4311
 
4312
4312
 
4313
4313
 
@@ -4315,7 +4315,7 @@ Resolves conditions between UI flattened filter and given parameters
4315
4315
  ##### Returns
4316
4316
 
4317
4317
 
4318
- - true: the conditions are satisfied.
4318
+ - true: the condition is satisfied
4319
4319
 
4320
4320
 
4321
4321