@qrvey/utils 1.2.9-1 → 1.2.9-5

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 (162) hide show
  1. package/README.md +384 -384
  2. package/dist/cjs/columns/constants/COLUMN_PROPERTY_LABEL.d.ts +1 -0
  3. package/dist/cjs/columns/constants/COMPLEX_COLUMN_PROPERTY_LABEL.d.ts +1 -0
  4. package/dist/cjs/columns/constants/COMPLEX_COLUMN_PROPERTY_LABEL.js +1 -0
  5. package/dist/cjs/filters/adapters/FDToFlatUI.js +0 -2
  6. package/dist/cjs/filters/adapters/FDToUI.js +1 -2
  7. package/dist/cjs/filters/adapters/UIToFD.js +0 -1
  8. package/dist/cjs/filters/adapters/UIToFlatUI.js +0 -2
  9. package/dist/cjs/filters/adapters/UIToOldLogic.js +1 -1
  10. package/dist/cjs/filters/adapters/flatUIToOldLogic.js +1 -1
  11. package/dist/cjs/filters/adapters/flatUIToUI.js +0 -2
  12. package/dist/cjs/filters/adapters/logicToFlatUI.js +0 -2
  13. package/dist/cjs/filters/helpers/ui/getUIValues.d.ts +2 -1
  14. package/dist/cjs/filters/helpers/ui/getUIValues.js +25 -12
  15. package/dist/cjs/filters/interfaces/ui/IFUFilter.d.ts +1 -1
  16. package/dist/cjs/filters/interfaces/ui/IFUUIValueSettings.d.ts +6 -0
  17. package/dist/cjs/{globalization/interfaces/chart_builder/II18nChartBuilderComplexAddress.js → filters/interfaces/ui/IFUUIValueSettings.js} +0 -0
  18. package/dist/cjs/filters/interfaces/ui/index.d.ts +1 -0
  19. package/dist/cjs/filters/interfaces/ui/index.js +1 -0
  20. package/dist/cjs/globalization/interfaces/bucket_builder/II18nBucketBuilderMessages.d.ts +2 -1
  21. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilder.d.ts +0 -14
  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 +11 -9
  26. package/dist/cjs/globalization/interfaces/chart_builder/index.d.ts +0 -7
  27. package/dist/cjs/globalization/interfaces/chart_builder/index.js +0 -7
  28. package/dist/cjs/globalization/interfaces/common/II18nColumnProperties.d.ts +1 -0
  29. package/dist/cjs/globalization/interfaces/dashboard/II18nDashboard.d.ts +2 -0
  30. package/dist/cjs/globalization/interfaces/dashboard/II18nDashboardEmptyState.d.ts +5 -0
  31. package/dist/cjs/globalization/interfaces/{chart_builder/II18nChartBuilderComplexFile.js → dashboard/II18nDashboardEmptyState.js} +0 -0
  32. package/dist/cjs/globalization/interfaces/dashboard/index.d.ts +1 -0
  33. package/dist/cjs/globalization/interfaces/dashboard/index.js +1 -0
  34. package/dist/cjs/globalization/interfaces/filters/II18nFilterBuilderColumnSelector.d.ts +1 -0
  35. package/dist/cjs/globalization/interfaces/filters/II18nValueContainer.d.ts +1 -0
  36. package/dist/cjs/globalization/interfaces/panel/II18nPanelErrors.d.ts +11 -9
  37. package/dist/cjs/globalization/interfaces/panel/II18nPanelSummaryViews.d.ts +17 -9
  38. package/dist/cjs/globalization/labels/bucket_builder/I18N_BUCKET_BUILDER.js +3 -2
  39. package/dist/cjs/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL.d.ts +1 -1
  40. package/dist/cjs/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL.js +29 -63
  41. package/dist/cjs/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL_OPTIONS.js +27 -21
  42. package/dist/cjs/globalization/labels/common/I18N_COLUMN_PROPERTY_LABEL.js +1 -0
  43. package/dist/cjs/globalization/labels/dashboard/I18N_DASHBOARD.js +12 -7
  44. package/dist/cjs/globalization/labels/filters/I18N_FILTER_BUILDER.js +3 -2
  45. package/dist/cjs/globalization/labels/filters/I18N_VALUE_CONTAINER.js +3 -2
  46. package/dist/cjs/globalization/labels/formula_builder/I18N_FORMULA_BUILDER.js +1 -1
  47. package/dist/cjs/globalization/labels/panel/I18N_PANEL.js +28 -18
  48. package/dist/columns/constants/COLUMN_PROPERTY_LABEL.d.ts +1 -0
  49. package/dist/columns/constants/COMPLEX_COLUMN_PROPERTY_LABEL.d.ts +1 -0
  50. package/dist/columns/constants/COMPLEX_COLUMN_PROPERTY_LABEL.js +1 -0
  51. package/dist/filters/adapters/FDToFlatUI.js +0 -2
  52. package/dist/filters/adapters/FDToUI.js +1 -2
  53. package/dist/filters/adapters/UIToFD.js +0 -1
  54. package/dist/filters/adapters/UIToFlatUI.js +0 -2
  55. package/dist/filters/adapters/UIToOldLogic.js +1 -1
  56. package/dist/filters/adapters/flatUIToOldLogic.js +1 -1
  57. package/dist/filters/adapters/flatUIToUI.js +0 -2
  58. package/dist/filters/adapters/logicToFlatUI.js +0 -2
  59. package/dist/filters/helpers/ui/getUIValues.d.ts +2 -1
  60. package/dist/filters/helpers/ui/getUIValues.js +25 -12
  61. package/dist/filters/interfaces/ui/IFUFilter.d.ts +1 -1
  62. package/dist/filters/interfaces/ui/IFUUIValueSettings.d.ts +6 -0
  63. package/dist/{globalization/interfaces/chart_builder/II18nChartBuilderComplexAddress.js → filters/interfaces/ui/IFUUIValueSettings.js} +0 -0
  64. package/dist/filters/interfaces/ui/index.d.ts +1 -0
  65. package/dist/filters/interfaces/ui/index.js +1 -0
  66. package/dist/globalization/interfaces/bucket_builder/II18nBucketBuilderMessages.d.ts +2 -1
  67. package/dist/globalization/interfaces/chart_builder/II18nChartBuilder.d.ts +0 -14
  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 +11 -9
  72. package/dist/globalization/interfaces/chart_builder/index.d.ts +0 -7
  73. package/dist/globalization/interfaces/chart_builder/index.js +0 -7
  74. package/dist/globalization/interfaces/common/II18nColumnProperties.d.ts +1 -0
  75. package/dist/globalization/interfaces/dashboard/II18nDashboard.d.ts +2 -0
  76. package/dist/globalization/interfaces/dashboard/II18nDashboardEmptyState.d.ts +5 -0
  77. package/dist/globalization/interfaces/{chart_builder/II18nChartBuilderComplexFile.js → dashboard/II18nDashboardEmptyState.js} +0 -0
  78. package/dist/globalization/interfaces/dashboard/index.d.ts +1 -0
  79. package/dist/globalization/interfaces/dashboard/index.js +1 -0
  80. package/dist/globalization/interfaces/filters/II18nFilterBuilderColumnSelector.d.ts +1 -0
  81. package/dist/globalization/interfaces/filters/II18nValueContainer.d.ts +1 -0
  82. package/dist/globalization/interfaces/panel/II18nPanelErrors.d.ts +11 -9
  83. package/dist/globalization/interfaces/panel/II18nPanelSummaryViews.d.ts +17 -9
  84. package/dist/globalization/labels/bucket_builder/I18N_BUCKET_BUILDER.js +3 -2
  85. package/dist/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL.d.ts +1 -1
  86. package/dist/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL.js +29 -63
  87. package/dist/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL_OPTIONS.js +27 -21
  88. package/dist/globalization/labels/common/I18N_COLUMN_PROPERTY_LABEL.js +1 -0
  89. package/dist/globalization/labels/dashboard/I18N_DASHBOARD.js +12 -7
  90. package/dist/globalization/labels/filters/I18N_FILTER_BUILDER.js +3 -2
  91. package/dist/globalization/labels/filters/I18N_VALUE_CONTAINER.js +3 -2
  92. package/dist/globalization/labels/formula_builder/I18N_FORMULA_BUILDER.js +1 -1
  93. package/dist/globalization/labels/panel/I18N_PANEL.js +28 -18
  94. package/package.json +1 -1
  95. package/src/columns/constants/COMPLEX_COLUMN_PROPERTY_LABEL.ts +1 -0
  96. package/src/filters/adapters/FDToFlatUI.ts +0 -2
  97. package/src/filters/adapters/FDToUI.ts +0 -2
  98. package/src/filters/adapters/UIToFD.ts +0 -1
  99. package/src/filters/adapters/UIToFlatUI.ts +0 -2
  100. package/src/filters/adapters/UIToOldLogic.ts +1 -1
  101. package/src/filters/adapters/flatUIToOldLogic.ts +1 -1
  102. package/src/filters/adapters/flatUIToUI.ts +0 -2
  103. package/src/filters/adapters/logicToFlatUI.ts +1 -3
  104. package/src/filters/helpers/ui/getUIValues.ts +28 -12
  105. package/src/filters/interfaces/ui/IFUFilter.ts +1 -1
  106. package/src/filters/interfaces/ui/IFUUIValueSettings.ts +7 -0
  107. package/src/filters/interfaces/ui/index.ts +1 -0
  108. package/src/globalization/interfaces/bucket_builder/II18nBucketBuilderMessages.ts +2 -1
  109. package/src/globalization/interfaces/chart_builder/II18nChartBuilder.ts +0 -14
  110. package/src/globalization/interfaces/chart_builder/II18nChartBuilderDataPanel.ts +16 -15
  111. package/src/globalization/interfaces/chart_builder/II18nChartBuilderDimensions.ts +12 -11
  112. package/src/globalization/interfaces/chart_builder/II18nChartBuilderGeneralOptions.ts +16 -12
  113. package/src/globalization/interfaces/chart_builder/II18nChartBuilderSorting.ts +11 -9
  114. package/src/globalization/interfaces/chart_builder/index.ts +0 -7
  115. package/src/globalization/interfaces/common/II18nColumnProperties.ts +1 -0
  116. package/src/globalization/interfaces/dashboard/II18nDashboard.ts +2 -0
  117. package/src/globalization/interfaces/dashboard/II18nDashboardEmptyState.ts +5 -0
  118. package/src/globalization/interfaces/dashboard/index.ts +1 -0
  119. package/src/globalization/interfaces/filters/II18nFilterBuilderColumnSelector.ts +1 -0
  120. package/src/globalization/interfaces/filters/II18nValueContainer.ts +1 -0
  121. package/src/globalization/interfaces/panel/II18nPanelErrors.ts +11 -9
  122. package/src/globalization/interfaces/panel/II18nPanelSummaryViews.ts +17 -9
  123. package/src/globalization/labels/bucket_builder/I18N_BUCKET_BUILDER.ts +3 -2
  124. package/src/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL.ts +30 -65
  125. package/src/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL_OPTIONS.ts +28 -21
  126. package/src/globalization/labels/common/I18N_COLUMN_PROPERTY_LABEL.ts +1 -0
  127. package/src/globalization/labels/dashboard/I18N_DASHBOARD.ts +12 -7
  128. package/src/globalization/labels/filters/I18N_FILTER_BUILDER.ts +3 -2
  129. package/src/globalization/labels/filters/I18N_VALUE_CONTAINER.ts +3 -2
  130. package/src/globalization/labels/formula_builder/I18N_FORMULA_BUILDER.ts +1 -1
  131. package/src/globalization/labels/panel/I18N_PANEL.ts +28 -18
  132. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexAddress.d.ts +0 -5
  133. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexFile.d.ts +0 -4
  134. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexImage.d.ts +0 -4
  135. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexImage.js +0 -2
  136. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexImageAnalysis.d.ts +0 -4
  137. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexImageAnalysis.js +0 -2
  138. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexName.d.ts +0 -4
  139. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexName.js +0 -2
  140. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexText.d.ts +0 -6
  141. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexText.js +0 -2
  142. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexUsaAddress.d.ts +0 -5
  143. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexUsaAddress.js +0 -2
  144. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexAddress.d.ts +0 -5
  145. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexFile.d.ts +0 -4
  146. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexImage.d.ts +0 -4
  147. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexImage.js +0 -1
  148. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexImageAnalysis.d.ts +0 -4
  149. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexImageAnalysis.js +0 -1
  150. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexName.d.ts +0 -4
  151. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexName.js +0 -1
  152. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexText.d.ts +0 -6
  153. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexText.js +0 -1
  154. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexUsaAddress.d.ts +0 -5
  155. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexUsaAddress.js +0 -1
  156. package/src/globalization/interfaces/chart_builder/II18nChartBuilderComplexAddress.ts +0 -6
  157. package/src/globalization/interfaces/chart_builder/II18nChartBuilderComplexFile.ts +0 -4
  158. package/src/globalization/interfaces/chart_builder/II18nChartBuilderComplexImage.ts +0 -4
  159. package/src/globalization/interfaces/chart_builder/II18nChartBuilderComplexImageAnalysis.ts +0 -4
  160. package/src/globalization/interfaces/chart_builder/II18nChartBuilderComplexName.ts +0 -4
  161. package/src/globalization/interfaces/chart_builder/II18nChartBuilderComplexText.ts +0 -6
  162. package/src/globalization/interfaces/chart_builder/II18nChartBuilderComplexUsaAddress.ts +0 -6
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-1*
1
+ # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-5*
2
2
 
3
3
  > Helper, Utils for all Qrvey Projects
4
4
 
@@ -220,12 +220,12 @@ Transforms String Date from a [Year] format to Date object.
220
220
 
221
221
 
222
222
 
223
- ### dist/dates/helpers/getDateFormatByProperty.js
223
+ ### dist/dates/helpers/getDateByDateFormat.js
224
224
 
225
225
 
226
- #### getDateFormatByProperty(property)
226
+ #### getDateByDateFormat(date, format, time)
227
227
 
228
- Gets the date format by the given property
228
+ Gets a Date Object instance by a Date format
229
229
 
230
230
 
231
231
 
@@ -234,7 +234,9 @@ Gets the date format by the given property
234
234
 
235
235
  | Name | Type | Description | |
236
236
  | ---- | ---- | ----------- | -------- |
237
- | property | | The Column Property |   |
237
+ | date | | String with a formatted date |   |
238
+ | format | | The date format |   |
239
+ | time | | flag to convert the formatted date to miliseconds |   |
238
240
 
239
241
 
240
242
 
@@ -242,17 +244,17 @@ Gets the date format by the given property
242
244
  ##### Returns
243
245
 
244
246
 
245
- - The date format
247
+ - a Date object, milisecond time or the same value if date format does not match.
246
248
 
247
249
 
248
250
 
249
251
 
250
- ### dist/dates/helpers/getDateByDateFormat.js
252
+ ### dist/dates/helpers/getDateFormatByProperty.js
251
253
 
252
254
 
253
- #### getDateByDateFormat(date, format, time)
255
+ #### getDateFormatByProperty(property)
254
256
 
255
- Gets a Date Object instance by a Date format
257
+ Gets the date format by the given property
256
258
 
257
259
 
258
260
 
@@ -261,9 +263,7 @@ Gets a Date Object instance by a Date format
261
263
 
262
264
  | Name | Type | Description | |
263
265
  | ---- | ---- | ----------- | -------- |
264
- | date | | String with a formatted date |   |
265
- | format | | The date format |   |
266
- | time | | flag to convert the formatted date to miliseconds |   |
266
+ | property | | The Column Property |   |
267
267
 
268
268
 
269
269
 
@@ -271,7 +271,7 @@ Gets a Date Object instance by a Date format
271
271
  ##### Returns
272
272
 
273
273
 
274
- - a Date object, milisecond time or the same value if date format does not match.
274
+ - The date format
275
275
 
276
276
 
277
277
 
@@ -688,26 +688,6 @@ Output:
688
688
 
689
689
 
690
690
 
691
- ### dist/filters/classes/FilterInputErrorHandler.js
692
-
693
-
694
- #### new FilterInputErrorHandler()
695
-
696
-
697
-
698
-
699
-
700
-
701
-
702
-
703
- ##### Returns
704
-
705
-
706
- - `Void`
707
-
708
-
709
-
710
-
711
691
  ### dist/filters/adapters/FDToFlatUI.js
712
692
 
713
693
 
@@ -1558,6 +1538,26 @@ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
1558
1538
 
1559
1539
 
1560
1540
 
1541
+ ### dist/filters/classes/FilterInputErrorHandler.js
1542
+
1543
+
1544
+ #### new FilterInputErrorHandler()
1545
+
1546
+
1547
+
1548
+
1549
+
1550
+
1551
+
1552
+
1553
+ ##### Returns
1554
+
1555
+
1556
+ - `Void`
1557
+
1558
+
1559
+
1560
+
1561
1561
  ### dist/filters/helpers/applyHierarchyForAggFilters.js
1562
1562
 
1563
1563
 
@@ -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/mix/compareDeep.js
1871
+ ### dist/general/object/cloneDeep.js
1872
1872
 
1873
1873
 
1874
- #### compareDeep(object1, object2)
1874
+ #### cloneDeep(obj)
1875
1875
 
1876
- Compares two objects to know if they are equals. Go across nested objects.
1877
- Includes arrays in the comparison.
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
1878
1878
 
1879
1879
 
1880
1880
 
@@ -1883,8 +1883,7 @@ Includes arrays in the comparison.
1883
1883
 
1884
1884
  | Name | Type | Description | |
1885
1885
  | ---- | ---- | ----------- | -------- |
1886
- | object1 | | First Object to compare |   |
1887
- | object2 | | Second Object to compare |   |
1886
+ | obj | | The object |   |
1888
1887
 
1889
1888
 
1890
1889
 
@@ -1892,17 +1891,21 @@ Includes arrays in the comparison.
1892
1891
  ##### Returns
1893
1892
 
1894
1893
 
1895
- - True: objects are equal. False: Objects are not equal. Undefined: invalid
1894
+ - The new reference object or the given object if the parsing is incorrect or empty
1896
1895
 
1897
1896
 
1898
1897
 
1899
1898
 
1900
- ### dist/general/mix/getTag.js
1899
+ ### dist/general/object/get.js
1901
1900
 
1902
1901
 
1903
- #### getTag(value)
1902
+ #### _get(baseObject, path, defaultValue)
1904
1903
 
1905
- Gets the `toStringTag` of `value`.
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.
1906
+
1907
+ Empty arrays and empty objects are returned but the defaultValue is not
1908
+ Undefined and null values will return the defaultValue.
1906
1909
 
1907
1910
 
1908
1911
 
@@ -1911,25 +1914,59 @@ Gets the `toStringTag` of `value`.
1911
1914
 
1912
1915
  | Name | Type | Description | |
1913
1916
  | ---- | ---- | ----------- | -------- |
1914
- | value | | The value to query. |   |
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
+
1915
1921
 
1916
1922
 
1917
1923
 
1924
+ ##### Examples
1925
+
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
+
1918
1947
 
1919
1948
  ##### Returns
1920
1949
 
1921
1950
 
1922
- - `string` Returns the `toStringTag`.
1951
+ - the resolved value.
1923
1952
 
1924
1953
 
1925
1954
 
1926
1955
 
1927
- ### dist/general/mix/importScripts.js
1956
+ ### dist/general/object/getAttribute.js
1928
1957
 
1929
1958
 
1930
- #### importScripts(scripts)
1959
+ #### getAttribute(obj, key)
1931
1960
 
1932
- Import a set of external Scripts given the URL in both serie and cascade way
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
1933
1970
 
1934
1971
 
1935
1972
 
@@ -1938,12 +1975,8 @@ Import a set of external Scripts given the URL in both serie and cascade way
1938
1975
 
1939
1976
  | Name | Type | Description | |
1940
1977
  | ---- | ---- | ----------- | -------- |
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; |
1978
+ | obj | `object` | object to look for | &nbsp; |
1979
+ | key | `string` | String attribute in snake_case style | &nbsp; |
1947
1980
 
1948
1981
 
1949
1982
 
@@ -1951,41 +1984,24 @@ Import a set of external Scripts given the URL in both serie and cascade way
1951
1984
  ##### Examples
1952
1985
 
1953
1986
  ```javascript
1954
- // 1) Simple script (paralell loading)
1955
- importScripts(['http://myscript.js', 'http://another.js']);
1987
+ getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
1988
+ ```
1956
1989
 
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
- ]);
1962
1990
 
1963
- // 3) import dependent scripts (cascade)
1964
- importScripts([
1965
- { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] }
1966
- ]);
1991
+ ##### Returns
1967
1992
 
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
- ```
1976
1993
 
1994
+ - `Void`
1977
1995
 
1978
- ##### Returns
1979
1996
 
1980
1997
 
1981
- - `Promise` Promise when all script have been loaded
1982
1998
 
1999
+ ### dist/general/object/hasProperty.js
1983
2000
 
1984
2001
 
1985
- #### loadScript(url, type, noModule)
2002
+ #### _hasProperty(obj, property)
1986
2003
 
1987
- Creates the script element and appends to document.head
1988
- return a Promise that is resolved when the script is loaded
2004
+ Use the hasOwnProperty in order to verify if the given property exists in the object.
1989
2005
 
1990
2006
 
1991
2007
 
@@ -1994,27 +2010,38 @@ return a Promise that is resolved when the script is loaded
1994
2010
 
1995
2011
  | Name | Type | Description | |
1996
2012
  | ---- | ---- | ----------- | -------- |
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; |
2013
+ | obj | `object` | an object | &nbsp; |
2014
+ | property | `string` | String to verify if exists in the object as property | &nbsp; |
2015
+
2000
2016
 
2001
2017
 
2002
2018
 
2019
+ ##### Examples
2020
+
2021
+ ```javascript
2022
+ const prop = 'prop2'
2023
+ const obj1 = { prop1: 'hello', prop2: 'world'}
2024
+ _hasProperty(ob1, prop1) // true
2025
+
2026
+ const obj2 = { prop1: 'hello world' }
2027
+ _hasProperty(ob1, prop2) // false
2028
+ ```
2029
+
2003
2030
 
2004
2031
  ##### Returns
2005
2032
 
2006
2033
 
2007
- - `Void`
2034
+ - True if the object has the given property; otherwise, false.
2008
2035
 
2009
2036
 
2010
2037
 
2011
2038
 
2012
- ### dist/general/mix/isEmpty.js
2039
+ ### dist/general/object/isObject.js
2013
2040
 
2014
2041
 
2015
- #### isEmpty(variable, includeFalsy)
2042
+ #### isObject(obj)
2016
2043
 
2017
- Validates if the given argument is empty
2044
+ Checks if the given argument is an object type
2018
2045
 
2019
2046
 
2020
2047
 
@@ -2023,8 +2050,7 @@ Validates if the given argument is empty
2023
2050
 
2024
2051
  | Name | Type | Description | |
2025
2052
  | ---- | ---- | ----------- | -------- |
2026
- | variable | | the given variable | &nbsp; |
2027
- | includeFalsy | | flag to determine include the falsy variables into the validation | &nbsp; |
2053
+ | obj | | the variable to check | &nbsp; |
2028
2054
 
2029
2055
 
2030
2056
 
@@ -2032,19 +2058,18 @@ Validates if the given argument is empty
2032
2058
  ##### Returns
2033
2059
 
2034
2060
 
2035
- - true: the given argument is empty; false: is not.
2061
+ - True: It is an object; False: It is not.
2036
2062
 
2037
2063
 
2038
2064
 
2039
2065
 
2040
- ### dist/general/mix/isNaNV2.js
2066
+ ### dist/general/object/mapValues.js
2041
2067
 
2042
2068
 
2043
- #### isNaNV2(variable)
2069
+ #### mapValues(baseObject, iteratee)
2044
2070
 
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.
2071
+ Invoke iteratee (function) for each object key-value pair
2072
+ and return a mapped object
2048
2073
 
2049
2074
 
2050
2075
 
@@ -2053,7 +2078,8 @@ Validates if variable is null, undefined, or an empty string, also, the function
2053
2078
 
2054
2079
  | Name | Type | Description | |
2055
2080
  | ---- | ---- | ----------- | -------- |
2056
- | variable | | the variable to validate | &nbsp; |
2081
+ | baseObject | `Object` | Base object. | &nbsp; |
2082
+ | iteratee | `Function` | The executed per iteration. | &nbsp; |
2057
2083
 
2058
2084
 
2059
2085
 
@@ -2061,18 +2087,18 @@ Validates if variable is null, undefined, or an empty string, also, the function
2061
2087
  ##### Returns
2062
2088
 
2063
2089
 
2064
- - True if variable is a NaN or false otherwise
2090
+ - `Object` New mapped object.
2065
2091
 
2066
2092
 
2067
2093
 
2068
2094
 
2069
- ### dist/general/mix/isNull.js
2095
+ ### dist/general/object/mergeDeep.js
2070
2096
 
2071
2097
 
2072
- #### isNull(arg)
2098
+ #### mergeDeep(obj1, obj2, settings)
2073
2099
 
2074
- return if a given variable is either `null` or `undefined`
2075
- useful to avoid falsify validating Number Zero (0)
2100
+ Merges two objects into a new one.
2101
+ The second given argument to the first given argument.
2076
2102
 
2077
2103
 
2078
2104
 
@@ -2081,7 +2107,9 @@ useful to avoid falsify validating Number Zero (0)
2081
2107
 
2082
2108
  | Name | Type | Description | |
2083
2109
  | ---- | ---- | ----------- | -------- |
2084
- | arg | `any` | | &nbsp; |
2110
+ | obj1 | | The target object | &nbsp; |
2111
+ | obj2 | | The object to be merged | &nbsp; |
2112
+ | settings | | Object settings for this function | &nbsp; |
2085
2113
 
2086
2114
 
2087
2115
 
@@ -2089,19 +2117,13 @@ useful to avoid falsify validating Number Zero (0)
2089
2117
  ##### Returns
2090
2118
 
2091
2119
 
2092
- - `Boolean`
2093
-
2094
-
2095
-
2120
+ - a new merged object
2096
2121
 
2097
- ### dist/general/mix/randomId.js
2098
2122
 
2099
2123
 
2100
- #### randomId(length, exclude)
2124
+ #### isValid(obj1, obj2)
2101
2125
 
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.
2126
+ Validates if the two arguments are objects
2105
2127
 
2106
2128
 
2107
2129
 
@@ -2110,8 +2132,8 @@ Creates a random string
2110
2132
 
2111
2133
  | Name | Type | Description | |
2112
2134
  | ---- | ---- | ----------- | -------- |
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; |
2135
+ | obj1 | | The target object | &nbsp; |
2136
+ | obj2 | | The object to be merged | &nbsp; |
2115
2137
 
2116
2138
 
2117
2139
 
@@ -2119,19 +2141,13 @@ Creates a random string
2119
2141
  ##### Returns
2120
2142
 
2121
2143
 
2122
- - `String` Random string
2123
-
2124
-
2125
-
2144
+ - true: they are valid; false: they are not
2126
2145
 
2127
- ### dist/general/mix/size.js
2128
2146
 
2129
2147
 
2130
- #### size(obj)
2148
+ #### getParamsToMergeDeep(settings)
2131
2149
 
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.
2150
+ Validates and gets the settings with all set parameters.
2135
2151
 
2136
2152
 
2137
2153
 
@@ -2140,7 +2156,7 @@ Gets the length of the given array.
2140
2156
 
2141
2157
  | Name | Type | Description | |
2142
2158
  | ---- | ---- | ----------- | -------- |
2143
- | obj | `Any` | Any object-type variable | &nbsp; |
2159
+ | settings | | the settings object | &nbsp; |
2144
2160
 
2145
2161
 
2146
2162
 
@@ -2148,17 +2164,17 @@ Gets the length of the given array.
2148
2164
  ##### Returns
2149
2165
 
2150
2166
 
2151
- - `Number` the size of the given variable
2167
+ - a new settings object with all set parameters.
2152
2168
 
2153
2169
 
2154
2170
 
2155
2171
 
2156
- ### dist/general/string/capitalize.js
2172
+ ### dist/general/object/objectCopy.js
2157
2173
 
2158
2174
 
2159
- #### capitalize(text)
2175
+ #### objectCopy(entity, cache)
2160
2176
 
2161
- Upper case the first letter of a given text
2177
+ Created a new reference of the given argument
2162
2178
 
2163
2179
 
2164
2180
 
@@ -2167,7 +2183,8 @@ Upper case the first letter of a given text
2167
2183
 
2168
2184
  | Name | Type | Description | |
2169
2185
  | ---- | ---- | ----------- | -------- |
2170
- | text | `String` | | &nbsp; |
2186
+ | entity | | The variable to be copied | &nbsp; |
2187
+ | cache | | | &nbsp; |
2171
2188
 
2172
2189
 
2173
2190
 
@@ -2175,18 +2192,17 @@ Upper case the first letter of a given text
2175
2192
  ##### Returns
2176
2193
 
2177
2194
 
2178
- - `String` a capitalized text
2195
+ - A new reference of the given argument
2179
2196
 
2180
2197
 
2181
2198
 
2182
2199
 
2183
- ### dist/general/object/cloneDeep.js
2200
+ ### dist/general/object/omit.js
2184
2201
 
2185
2202
 
2186
- #### cloneDeep(obj)
2203
+ #### omit(obj, props)
2187
2204
 
2188
- A simple Deep Cloning function. Valid only for primivite values and object with primitive values.
2189
- Not to use this function with inner objects and functions
2205
+ return a new Object excluding attributes in _props_ list
2190
2206
 
2191
2207
 
2192
2208
 
@@ -2195,7 +2211,8 @@ Not to use this function with inner objects and functions
2195
2211
 
2196
2212
  | Name | Type | Description | |
2197
2213
  | ---- | ---- | ----------- | -------- |
2198
- | obj | | The object | &nbsp; |
2214
+ | obj | `Object` | base object | &nbsp; |
2215
+ | props | `Array.<String>` | list of attribute to exclude | &nbsp; |
2199
2216
 
2200
2217
 
2201
2218
 
@@ -2203,21 +2220,17 @@ Not to use this function with inner objects and functions
2203
2220
  ##### Returns
2204
2221
 
2205
2222
 
2206
- - The new reference object or the given object if the parsing is incorrect or empty
2207
-
2223
+ - `Object` clean object
2208
2224
 
2209
2225
 
2210
2226
 
2211
- ### dist/general/object/get.js
2212
2227
 
2228
+ ### dist/general/object/pick.js
2213
2229
 
2214
- #### _get(baseObject, path, defaultValue)
2215
2230
 
2216
- Like lodash _.get.
2217
- Gets the value at path of object. If the resolved value is undefined, the defaultValue is returned in its place.
2231
+ #### pick(baseObject, keys)
2218
2232
 
2219
- Empty arrays and empty objects are returned but the defaultValue is not
2220
- Undefined and null values will return the defaultValue.
2233
+ return a new object just with attributes in _keys_ list
2221
2234
 
2222
2235
 
2223
2236
 
@@ -2226,59 +2239,26 @@ Undefined and null values will return the defaultValue.
2226
2239
 
2227
2240
  | Name | Type | Description | |
2228
2241
  | ---- | ---- | ----------- | -------- |
2229
- | baseObject | | The object to query | &nbsp; |
2230
- | path | | The string path or collection of string paths of the property to get. | &nbsp; |
2231
- | defaultValue | | The value returned for undefined resolved values. | &nbsp; |
2232
-
2233
-
2234
-
2242
+ | baseObject | `Object` | base object | &nbsp; |
2243
+ | keys | `Array.<String>` | list of attributes to preserve | &nbsp; |
2235
2244
 
2236
- ##### Examples
2237
2245
 
2238
- ```javascript
2239
- // returns 'Hello'
2240
- _get({ item1: 'Hello', item2: 'World' }, 'item1')
2241
- ```
2242
- ```javascript
2243
- // returns 'A simple Hello'
2244
- _get({ item1: 'Hello', item2: 'World' }, 'item3', 'A simple Hello')
2245
- ```
2246
- ```javascript
2247
- // returns 'Hello Again'
2248
- _get({ item1: { item11: 'Hello Again' }, item2: {} }, 'item1.item11')
2249
- ```
2250
- ```javascript
2251
- // returns 'Hello 2'
2252
- _get({ item1: ['Hello 1', 'Hello 2' }, item2: [] }, 'item1[1]')
2253
- ```
2254
- ```javascript
2255
- // returns 'Hello Again'
2256
- _get({ item1: { item11: 'Hello Again' }, item2: {} }, ['item1', 'item11'])
2257
- ```
2258
2246
 
2259
2247
 
2260
2248
  ##### Returns
2261
2249
 
2262
2250
 
2263
- - the resolved value.
2251
+ - `Object` new object just with desired attributes
2264
2252
 
2265
2253
 
2266
2254
 
2267
2255
 
2268
- ### dist/general/object/getAttribute.js
2256
+ ### dist/general/object/serialize.js
2269
2257
 
2270
2258
 
2271
- #### getAttribute(obj, key)
2259
+ #### serialize(obj)
2272
2260
 
2273
- Searchs for properties in different case styles such as: lower, upper, camel and pascal
2274
- - To optimize the searching, it is required a key in a snake_case style
2275
- - List of cases that do not match
2276
- -- From lower to snake case
2277
- -- From upper to snake case
2278
- -- From lower to camel case
2279
- -- From upper to camel case
2280
- -- From lower to pascal case
2281
- -- From upper to pascal case
2261
+ serialize object to url param
2282
2262
 
2283
2263
 
2284
2264
 
@@ -2287,17 +2267,9 @@ Searchs for properties in different case styles such as: lower, upper, camel and
2287
2267
 
2288
2268
  | Name | Type | Description | |
2289
2269
  | ---- | ---- | ----------- | -------- |
2290
- | obj | `object` | object to look for | &nbsp; |
2291
- | key | `string` | String attribute in snake_case style | &nbsp; |
2292
-
2293
-
2294
-
2270
+ | obj | | - Object to be serialized | &nbsp; |
2295
2271
 
2296
- ##### Examples
2297
2272
 
2298
- ```javascript
2299
- getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
2300
- ```
2301
2273
 
2302
2274
 
2303
2275
  ##### Returns
@@ -2308,12 +2280,13 @@ getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase
2308
2280
 
2309
2281
 
2310
2282
 
2311
- ### dist/general/object/hasProperty.js
2283
+ ### dist/general/mix/compareDeep.js
2312
2284
 
2313
2285
 
2314
- #### _hasProperty(obj, property)
2286
+ #### compareDeep(object1, object2)
2315
2287
 
2316
- Use the hasOwnProperty in order to verify if the given property exists in the object.
2288
+ Compares two objects to know if they are equals. Go across nested objects.
2289
+ Includes arrays in the comparison.
2317
2290
 
2318
2291
 
2319
2292
 
@@ -2322,38 +2295,26 @@ Use the hasOwnProperty in order to verify if the given property exists in the ob
2322
2295
 
2323
2296
  | Name | Type | Description | |
2324
2297
  | ---- | ---- | ----------- | -------- |
2325
- | obj | `object` | an object | &nbsp; |
2326
- | property | `string` | String to verify if exists in the object as property | &nbsp; |
2327
-
2328
-
2329
-
2330
-
2331
- ##### Examples
2298
+ | object1 | | First Object to compare | &nbsp; |
2299
+ | object2 | | Second Object to compare | &nbsp; |
2332
2300
 
2333
- ```javascript
2334
- const prop = 'prop2'
2335
- const obj1 = { prop1: 'hello', prop2: 'world'}
2336
- _hasProperty(ob1, prop1) // true
2337
2301
 
2338
- const obj2 = { prop1: 'hello world' }
2339
- _hasProperty(ob1, prop2) // false
2340
- ```
2341
2302
 
2342
2303
 
2343
2304
  ##### Returns
2344
2305
 
2345
2306
 
2346
- - True if the object has the given property; otherwise, false.
2307
+ - True: objects are equal. False: Objects are not equal. Undefined: invalid
2347
2308
 
2348
2309
 
2349
2310
 
2350
2311
 
2351
- ### dist/general/object/isObject.js
2312
+ ### dist/general/mix/getTag.js
2352
2313
 
2353
2314
 
2354
- #### isObject(obj)
2315
+ #### getTag(value)
2355
2316
 
2356
- Checks if the given argument is an object type
2317
+ Gets the `toStringTag` of `value`.
2357
2318
 
2358
2319
 
2359
2320
 
@@ -2362,7 +2323,7 @@ Checks if the given argument is an object type
2362
2323
 
2363
2324
  | Name | Type | Description | |
2364
2325
  | ---- | ---- | ----------- | -------- |
2365
- | obj | | the variable to check | &nbsp; |
2326
+ | value | | The value to query. | &nbsp; |
2366
2327
 
2367
2328
 
2368
2329
 
@@ -2370,18 +2331,17 @@ Checks if the given argument is an object type
2370
2331
  ##### Returns
2371
2332
 
2372
2333
 
2373
- - True: It is an object; False: It is not.
2334
+ - `string` Returns the `toStringTag`.
2374
2335
 
2375
2336
 
2376
2337
 
2377
2338
 
2378
- ### dist/general/object/mapValues.js
2339
+ ### dist/general/mix/importScripts.js
2379
2340
 
2380
2341
 
2381
- #### mapValues(baseObject, iteratee)
2342
+ #### importScripts(scripts)
2382
2343
 
2383
- Invoke iteratee (function) for each object key-value pair
2384
- and return a mapped object
2344
+ Import a set of external Scripts given the URL in both serie and cascade way
2385
2345
 
2386
2346
 
2387
2347
 
@@ -2390,27 +2350,54 @@ and return a mapped object
2390
2350
 
2391
2351
  | Name | Type | Description | |
2392
2352
  | ---- | ---- | ----------- | -------- |
2393
- | baseObject | `Object` | Base object. | &nbsp; |
2394
- | iteratee | `Function` | The executed per iteration. | &nbsp; |
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; |
2395
2359
 
2396
2360
 
2397
2361
 
2398
2362
 
2399
- ##### Returns
2363
+ ##### Examples
2364
+
2365
+ ```javascript
2366
+ // 1) Simple script (paralell loading)
2367
+ importScripts(['http://myscript.js', 'http://another.js']);
2400
2368
 
2369
+ // 2) Loading `.js` and `.esm.js` script (parallel loading)
2370
+ importScripts([
2371
+ { url: 'http://myscript.esm.js', type: 'module' },
2372
+ { url: 'http://myscript.js', noModule: true }
2373
+ ]);
2401
2374
 
2402
- - `Object` New mapped object.
2375
+ // 3) import dependent scripts (cascade)
2376
+ importScripts([
2377
+ { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] }
2378
+ ]);
2379
+
2380
+ // 4) mix
2381
+ importScripts([
2382
+ { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] },
2383
+ { url: 'http://another.esm.js', type: 'module' },
2384
+ { url: 'http://another.js', noModule: true },
2385
+ 'http://simplescript.js'
2386
+ ]);
2387
+ ```
2403
2388
 
2404
2389
 
2390
+ ##### Returns
2405
2391
 
2406
2392
 
2407
- ### dist/general/object/mergeDeep.js
2393
+ - `Promise` Promise when all script have been loaded
2408
2394
 
2409
2395
 
2410
- #### mergeDeep(obj1, obj2, settings)
2411
2396
 
2412
- Merges two objects into a new one.
2413
- The second given argument to the first given argument.
2397
+ #### loadScript(url, type, noModule)
2398
+
2399
+ Creates the script element and appends to document.head
2400
+ return a Promise that is resolved when the script is loaded
2414
2401
 
2415
2402
 
2416
2403
 
@@ -2419,9 +2406,9 @@ The second given argument to the first given argument.
2419
2406
 
2420
2407
  | Name | Type | Description | |
2421
2408
  | ---- | ---- | ----------- | -------- |
2422
- | obj1 | | The target object | &nbsp; |
2423
- | obj2 | | The object to be merged | &nbsp; |
2424
- | settings | | Object settings for this function | &nbsp; |
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; |
2425
2412
 
2426
2413
 
2427
2414
 
@@ -2429,13 +2416,17 @@ The second given argument to the first given argument.
2429
2416
  ##### Returns
2430
2417
 
2431
2418
 
2432
- - a new merged object
2419
+ - `Void`
2433
2420
 
2434
2421
 
2435
2422
 
2436
- #### isValid(obj1, obj2)
2437
2423
 
2438
- Validates if the two arguments are objects
2424
+ ### dist/general/mix/isEmpty.js
2425
+
2426
+
2427
+ #### isEmpty(variable, includeFalsy)
2428
+
2429
+ Validates if the given argument is empty
2439
2430
 
2440
2431
 
2441
2432
 
@@ -2444,8 +2435,8 @@ Validates if the two arguments are objects
2444
2435
 
2445
2436
  | Name | Type | Description | |
2446
2437
  | ---- | ---- | ----------- | -------- |
2447
- | obj1 | | The target object | &nbsp; |
2448
- | obj2 | | The object to be merged | &nbsp; |
2438
+ | variable | | the given variable | &nbsp; |
2439
+ | includeFalsy | | flag to determine include the falsy variables into the validation | &nbsp; |
2449
2440
 
2450
2441
 
2451
2442
 
@@ -2453,13 +2444,19 @@ Validates if the two arguments are objects
2453
2444
  ##### Returns
2454
2445
 
2455
2446
 
2456
- - true: they are valid; false: they are not
2447
+ - true: the given argument is empty; false: is not.
2457
2448
 
2458
2449
 
2459
2450
 
2460
- #### getParamsToMergeDeep(settings)
2461
2451
 
2462
- Validates and gets the settings with all set parameters.
2452
+ ### dist/general/mix/isNaNV2.js
2453
+
2454
+
2455
+ #### isNaNV2(variable)
2456
+
2457
+ Validates if the recieved number is NaN type.
2458
+ This function recieves any variable but will return false.
2459
+ Validates if variable is null, undefined, or an empty string, also, the function uses isNaN native function.
2463
2460
 
2464
2461
 
2465
2462
 
@@ -2468,7 +2465,7 @@ Validates and gets the settings with all set parameters.
2468
2465
 
2469
2466
  | Name | Type | Description | |
2470
2467
  | ---- | ---- | ----------- | -------- |
2471
- | settings | | the settings object | &nbsp; |
2468
+ | variable | | the variable to validate | &nbsp; |
2472
2469
 
2473
2470
 
2474
2471
 
@@ -2476,17 +2473,18 @@ Validates and gets the settings with all set parameters.
2476
2473
  ##### Returns
2477
2474
 
2478
2475
 
2479
- - a new settings object with all set parameters.
2476
+ - True if variable is a NaN or false otherwise
2480
2477
 
2481
2478
 
2482
2479
 
2483
2480
 
2484
- ### dist/general/object/objectCopy.js
2481
+ ### dist/general/mix/isNull.js
2485
2482
 
2486
2483
 
2487
- #### objectCopy(entity, cache)
2484
+ #### isNull(arg)
2488
2485
 
2489
- Created a new reference of the given argument
2486
+ return if a given variable is either `null` or `undefined`
2487
+ useful to avoid falsify validating Number Zero (0)
2490
2488
 
2491
2489
 
2492
2490
 
@@ -2495,8 +2493,7 @@ Created a new reference of the given argument
2495
2493
 
2496
2494
  | Name | Type | Description | |
2497
2495
  | ---- | ---- | ----------- | -------- |
2498
- | entity | | The variable to be copied | &nbsp; |
2499
- | cache | | | &nbsp; |
2496
+ | arg | `any` | | &nbsp; |
2500
2497
 
2501
2498
 
2502
2499
 
@@ -2504,17 +2501,19 @@ Created a new reference of the given argument
2504
2501
  ##### Returns
2505
2502
 
2506
2503
 
2507
- - A new reference of the given argument
2504
+ - `Boolean`
2508
2505
 
2509
2506
 
2510
2507
 
2511
2508
 
2512
- ### dist/general/object/omit.js
2509
+ ### dist/general/mix/size.js
2513
2510
 
2514
2511
 
2515
- #### omit(obj, props)
2512
+ #### size(obj)
2516
2513
 
2517
- return a new Object excluding attributes in _props_ list
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
2517
 
2519
2518
 
2520
2519
 
@@ -2523,8 +2522,7 @@ return a new Object excluding attributes in _props_ list
2523
2522
 
2524
2523
  | Name | Type | Description | |
2525
2524
  | ---- | ---- | ----------- | -------- |
2526
- | obj | `Object` | base object | &nbsp; |
2527
- | props | `Array.<String>` | list of attribute to exclude | &nbsp; |
2525
+ | obj | `Any` | Any object-type variable | &nbsp; |
2528
2526
 
2529
2527
 
2530
2528
 
@@ -2532,17 +2530,19 @@ return a new Object excluding attributes in _props_ list
2532
2530
  ##### Returns
2533
2531
 
2534
2532
 
2535
- - `Object` clean object
2533
+ - `Number` the size of the given variable
2536
2534
 
2537
2535
 
2538
2536
 
2539
2537
 
2540
- ### dist/general/object/pick.js
2538
+ ### dist/general/mix/randomId.js
2541
2539
 
2542
2540
 
2543
- #### pick(baseObject, keys)
2541
+ #### randomId(length, exclude)
2544
2542
 
2545
- return a new object just with attributes in _keys_ list
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
2546
 
2547
2547
 
2548
2548
 
@@ -2551,8 +2551,8 @@ return a new object just with attributes in _keys_ list
2551
2551
 
2552
2552
  | Name | Type | Description | |
2553
2553
  | ---- | ---- | ----------- | -------- |
2554
- | baseObject | `Object` | base object | &nbsp; |
2555
- | keys | `Array.<String>` | list of attributes to preserve | &nbsp; |
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; |
2556
2556
 
2557
2557
 
2558
2558
 
@@ -2560,17 +2560,17 @@ return a new object just with attributes in _keys_ list
2560
2560
  ##### Returns
2561
2561
 
2562
2562
 
2563
- - `Object` new object just with desired attributes
2563
+ - `String` Random string
2564
2564
 
2565
2565
 
2566
2566
 
2567
2567
 
2568
- ### dist/general/object/serialize.js
2568
+ ### dist/general/string/capitalize.js
2569
2569
 
2570
2570
 
2571
- #### serialize(obj)
2571
+ #### capitalize(text)
2572
2572
 
2573
- serialize object to url param
2573
+ Upper case the first letter of a given text
2574
2574
 
2575
2575
 
2576
2576
 
@@ -2579,7 +2579,7 @@ serialize object to url param
2579
2579
 
2580
2580
  | Name | Type | Description | |
2581
2581
  | ---- | ---- | ----------- | -------- |
2582
- | obj | | - Object to be serialized | &nbsp; |
2582
+ | text | `String` | | &nbsp; |
2583
2583
 
2584
2584
 
2585
2585
 
@@ -2587,17 +2587,17 @@ serialize object to url param
2587
2587
  ##### Returns
2588
2588
 
2589
2589
 
2590
- - `Void`
2590
+ - `String` a capitalized text
2591
2591
 
2592
2592
 
2593
2593
 
2594
2594
 
2595
- ### dist/services/api/getAllQrveys.api.js
2595
+ ### dist/qrvey/helpers/getColumnsLabel.js
2596
2596
 
2597
2597
 
2598
- #### getAllQrveys(config, params)
2598
+ #### getColumnLabels(column)
2599
2599
 
2600
- POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
2600
+ Get an string of the properties of the given column.
2601
2601
 
2602
2602
 
2603
2603
 
@@ -2606,8 +2606,7 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
2606
2606
 
2607
2607
  | Name | Type | Description | |
2608
2608
  | ---- | ---- | ----------- | -------- |
2609
- | config | | Configuration | &nbsp; |
2610
- | params | | Object for getting precise data | &nbsp; |
2609
+ | column | | The column | &nbsp; |
2611
2610
 
2612
2611
 
2613
2612
 
@@ -2615,53 +2614,52 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
2615
2614
  ##### Returns
2616
2615
 
2617
2616
 
2618
- - `Void`
2619
-
2620
-
2617
+ - an string with the property, aggregate or calculation label.
2621
2618
 
2622
2619
 
2623
- ### dist/services/api/getAllDatasets.api.js
2624
2620
 
2625
2621
 
2626
- #### getAllDatasets(qrveyids)
2622
+ ### dist/stencil/decorators/Config.js
2627
2623
 
2628
- Get a dataset list from a collection of Qrvey IDs
2629
2624
 
2625
+ #### Config()
2630
2626
 
2627
+ Stencil.js - Prop Decorator
2628
+ Get and Parse the Widget Configuration Object and also provide the ability to get properties in different case styles such as: lower, upper, camel and pascal
2629
+ But for this, is required ask for a property in `snake_case` style
2631
2630
 
2632
2631
 
2633
- ##### Parameters
2634
2632
 
2635
- | Name | Type | Description | |
2636
- | ---- | ---- | ----------- | -------- |
2637
- | qrveyids | | Collection of Qrvey IDs | &nbsp; |
2638
2633
 
2639
2634
 
2640
2635
 
2636
+ ##### Examples
2641
2637
 
2642
- ##### Returns
2638
+ ```javascript
2639
+ \ @Config() @Prop() settings;
2643
2640
 
2641
+ someMethod() {
2642
+ this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
2643
+ }
2644
+ ```
2644
2645
 
2645
- - a promise
2646
2646
 
2647
+ ##### Returns
2647
2648
 
2648
2649
 
2650
+ - `Void`
2649
2651
 
2650
- ### dist/services/api/getDatasetColumns.api.js
2651
2652
 
2652
2653
 
2653
- #### getDatasetColumns(qrveyid)
2654
2654
 
2655
- Get a dataset by Qrvey ID
2655
+ ### dist/stencil/util/createRef.js
2656
2656
 
2657
2657
 
2658
+ #### createRef()
2658
2659
 
2660
+ lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
2659
2661
 
2660
- ##### Parameters
2661
2662
 
2662
- | Name | Type | Description | |
2663
- | ---- | ---- | ----------- | -------- |
2664
- | qrveyid | | The Qrvey ID | &nbsp; |
2665
2663
 
2666
2664
 
2667
2665
 
@@ -2669,17 +2667,21 @@ Get a dataset by Qrvey ID
2669
2667
  ##### Returns
2670
2668
 
2671
2669
 
2672
- - a promise
2670
+ - function - Function to use in ref prop in html elements
2673
2671
 
2674
2672
 
2675
2673
 
2676
2674
 
2677
- ### dist/qrvey/helpers/getColumnsLabel.js
2675
+ ### dist/stencil/util/getConfig.js
2678
2676
 
2679
2677
 
2680
- #### getColumnLabels(column)
2678
+ #### getConfig(cfg)
2681
2679
 
2682
- Get an string of the properties of the given column.
2680
+ verify the Config object type and try to return a parsed Object
2681
+ - In case _cfg_ is a string, first try to make a JSON parse in other case
2682
+ try to find this string as a variable on Windows object
2683
+ - If _cfg_ is a fuction, tis is invoked and parsed
2684
+ - Finally, if is an object, _cfg_ is inmediatly returned
2683
2685
 
2684
2686
 
2685
2687
 
@@ -2688,7 +2690,7 @@ Get an string of the properties of the given column.
2688
2690
 
2689
2691
  | Name | Type | Description | |
2690
2692
  | ---- | ---- | ----------- | -------- |
2691
- | column | | The column | &nbsp; |
2693
+ | cfg | | | &nbsp; |
2692
2694
 
2693
2695
 
2694
2696
 
@@ -2696,74 +2698,72 @@ Get an string of the properties of the given column.
2696
2698
  ##### Returns
2697
2699
 
2698
2700
 
2699
- - an string with the property, aggregate or calculation label.
2700
-
2701
+ - `Void`
2701
2702
 
2702
2703
 
2703
2704
 
2704
- ### dist/stencil/decorators/Config.js
2705
2705
 
2706
+ ### dist/services/api/getAllDatasets.api.js
2706
2707
 
2707
- #### Config()
2708
2708
 
2709
- Stencil.js - Prop Decorator
2710
- Get and Parse the Widget Configuration Object and also provide the ability to get properties in different case styles such as: lower, upper, camel and pascal
2711
- But for this, is required ask for a property in `snake_case` style
2709
+ #### getAllDatasets(qrveyids)
2712
2710
 
2711
+ Get a dataset list from a collection of Qrvey IDs
2713
2712
 
2714
2713
 
2715
2714
 
2716
2715
 
2716
+ ##### Parameters
2717
2717
 
2718
- ##### Examples
2718
+ | Name | Type | Description | |
2719
+ | ---- | ---- | ----------- | -------- |
2720
+ | qrveyids | | Collection of Qrvey IDs | &nbsp; |
2719
2721
 
2720
- ```javascript
2721
- \ @Config() @Prop() settings;
2722
2722
 
2723
- someMethod() {
2724
- this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
2725
- }
2726
- ```
2727
2723
 
2728
2724
 
2729
2725
  ##### Returns
2730
2726
 
2731
2727
 
2732
- - `Void`
2728
+ - a promise
2733
2729
 
2734
2730
 
2735
2731
 
2736
2732
 
2737
- ### dist/stencil/util/createRef.js
2733
+ ### dist/services/api/getAllQrveys.api.js
2738
2734
 
2739
2735
 
2740
- #### createRef()
2736
+ #### getAllQrveys(config, params)
2737
+
2738
+ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
2741
2739
 
2742
- lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
2743
2740
 
2744
2741
 
2745
2742
 
2743
+ ##### Parameters
2744
+
2745
+ | Name | Type | Description | |
2746
+ | ---- | ---- | ----------- | -------- |
2747
+ | config | | Configuration | &nbsp; |
2748
+ | params | | Object for getting precise data | &nbsp; |
2749
+
2746
2750
 
2747
2751
 
2748
2752
 
2749
2753
  ##### Returns
2750
2754
 
2751
2755
 
2752
- - function - Function to use in ref prop in html elements
2756
+ - `Void`
2753
2757
 
2754
2758
 
2755
2759
 
2756
2760
 
2757
- ### dist/stencil/util/getConfig.js
2761
+ ### dist/services/api/getDatasetColumns.api.js
2758
2762
 
2759
2763
 
2760
- #### getConfig(cfg)
2764
+ #### getDatasetColumns(qrveyid)
2761
2765
 
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
2766
+ Get a dataset by Qrvey ID
2767
2767
 
2768
2768
 
2769
2769
 
@@ -2772,7 +2772,7 @@ try to find this string as a variable on Windows object
2772
2772
 
2773
2773
  | Name | Type | Description | |
2774
2774
  | ---- | ---- | ----------- | -------- |
2775
- | cfg | | | &nbsp; |
2775
+ | qrveyid | | The Qrvey ID | &nbsp; |
2776
2776
 
2777
2777
 
2778
2778
 
@@ -2780,7 +2780,7 @@ try to find this string as a variable on Windows object
2780
2780
  ##### Returns
2781
2781
 
2782
2782
 
2783
- - `Void`
2783
+ - a promise
2784
2784
 
2785
2785
 
2786
2786
 
@@ -2921,13 +2921,12 @@ Parses a string date and returns a dayjs date
2921
2921
 
2922
2922
 
2923
2923
 
2924
- ### dist/filters/helpers/backend/buildExpression.js
2924
+ ### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
2925
2925
 
2926
2926
 
2927
- #### buildExpression(filter)
2927
+ #### getFilterBuilderGeneralConfig(config)
2928
2928
 
2929
- Builds filter expression by the filter data.
2930
- - If the resulting value array is empty the enabled property will be false.
2929
+ Returns a filter builder config object by a any given config
2931
2930
 
2932
2931
 
2933
2932
 
@@ -2936,7 +2935,7 @@ Builds filter expression by the filter data.
2936
2935
 
2937
2936
  | Name | Type | Description | |
2938
2937
  | ---- | ---- | ----------- | -------- |
2939
- | filter | | The filter to transform | &nbsp; |
2938
+ | config | | any config object | &nbsp; |
2940
2939
 
2941
2940
 
2942
2941
 
@@ -2944,17 +2943,18 @@ Builds filter expression by the filter data.
2944
2943
  ##### Returns
2945
2944
 
2946
2945
 
2947
- - a filter expression
2946
+ - The filter builder config object
2948
2947
 
2949
2948
 
2950
2949
 
2951
2950
 
2952
- ### dist/filters/helpers/backend/buildUserFilters.js
2951
+ ### dist/filters/helpers/backend/buildExpression.js
2953
2952
 
2954
2953
 
2955
- #### buildUserFilters(userFilters)
2954
+ #### buildExpression(filter)
2956
2955
 
2957
- Transform user Filters array into Filter Logic structure
2956
+ Builds filter expression by the filter data.
2957
+ - If the resulting value array is empty the enabled property will be false.
2958
2958
 
2959
2959
 
2960
2960
 
@@ -2963,7 +2963,7 @@ Transform user Filters array into Filter Logic structure
2963
2963
 
2964
2964
  | Name | Type | Description | |
2965
2965
  | ---- | ---- | ----------- | -------- |
2966
- | userFilters | | The filters that the user defined. | &nbsp; |
2966
+ | filter | | The filter to transform | &nbsp; |
2967
2967
 
2968
2968
 
2969
2969
 
@@ -2971,17 +2971,17 @@ Transform user Filters array into Filter Logic structure
2971
2971
  ##### Returns
2972
2972
 
2973
2973
 
2974
- - The filter logic for the given user filters. if No a given object is recieved, it will return an empty array.
2975
-
2974
+ - a filter expression
2976
2975
 
2977
2976
 
2978
2977
 
2979
- ### dist/filters/helpers/backend/getAggFiltersBySummaryIndex.js
2980
2978
 
2979
+ ### dist/filters/helpers/backend/buildUserFilters.js
2981
2980
 
2982
- #### getAggFiltersBySummaryIndex(aggFilters, summaryIndex)
2983
2981
 
2982
+ #### buildUserFilters(userFilters)
2984
2983
 
2984
+ Transform user Filters array into Filter Logic structure
2985
2985
 
2986
2986
 
2987
2987
 
@@ -2990,8 +2990,7 @@ Transform user Filters array into Filter Logic structure
2990
2990
 
2991
2991
  | Name | Type | Description | |
2992
2992
  | ---- | ---- | ----------- | -------- |
2993
- | aggFilters | | | &nbsp; |
2994
- | summaryIndex | | | &nbsp; |
2993
+ | userFilters | | The filters that the user defined. | &nbsp; |
2995
2994
 
2996
2995
 
2997
2996
 
@@ -2999,17 +2998,17 @@ Transform user Filters array into Filter Logic structure
2999
2998
  ##### Returns
3000
2999
 
3001
3000
 
3002
- -
3001
+ - The filter logic for the given user filters. if No a given object is recieved, it will return an empty array.
3003
3002
 
3004
3003
 
3005
3004
 
3006
3005
 
3007
- ### dist/filters/helpers/backend/getBackendGroupValue.js
3006
+ ### dist/filters/helpers/backend/getAggFiltersBySummaryIndex.js
3008
3007
 
3009
3008
 
3010
- #### getBackendGroupValue(filter)
3009
+ #### getAggFiltersBySummaryIndex(aggFilters, summaryIndex)
3010
+
3011
3011
 
3012
- Gets a group value for the backend logic structure
3013
3012
 
3014
3013
 
3015
3014
 
@@ -3018,7 +3017,8 @@ Gets a group value for the backend logic structure
3018
3017
 
3019
3018
  | Name | Type | Description | |
3020
3019
  | ---- | ---- | ----------- | -------- |
3021
- | filter | | The filter | &nbsp; |
3020
+ | aggFilters | | | &nbsp; |
3021
+ | summaryIndex | | | &nbsp; |
3022
3022
 
3023
3023
 
3024
3024
 
@@ -3026,17 +3026,17 @@ Gets a group value for the backend logic structure
3026
3026
  ##### Returns
3027
3027
 
3028
3028
 
3029
- - a property
3029
+ -
3030
3030
 
3031
3031
 
3032
3032
 
3033
3033
 
3034
- ### dist/filters/helpers/backend/getBackendProperty.js
3034
+ ### dist/filters/helpers/backend/getBackendGroupValue.js
3035
3035
 
3036
3036
 
3037
- #### getBackendProperty(filter)
3037
+ #### getBackendGroupValue(filter)
3038
3038
 
3039
- Gets a property for the logic structure
3039
+ Gets a group value for the backend logic structure
3040
3040
 
3041
3041
 
3042
3042
 
@@ -3160,12 +3160,12 @@ Gets the Ranking values.
3160
3160
 
3161
3161
 
3162
3162
 
3163
- ### dist/filters/helpers/backend/getLogicByScopes.js
3163
+ ### dist/filters/helpers/backend/getBackendProperty.js
3164
3164
 
3165
3165
 
3166
- #### getLogicByScopes(logics, scopes)
3166
+ #### getBackendProperty(filter)
3167
3167
 
3168
- Gets the filters from logic data by Scopes/Scope IDs.
3168
+ Gets a property for the logic structure
3169
3169
 
3170
3170
 
3171
3171
 
@@ -3174,8 +3174,7 @@ Gets the filters from logic data by Scopes/Scope IDs.
3174
3174
 
3175
3175
  | Name | Type | Description | |
3176
3176
  | ---- | ---- | ----------- | -------- |
3177
- | logics | | The logic array | &nbsp; |
3178
- | scopes | | The collection of Scopes/Scope IDs | &nbsp; |
3177
+ | filter | | The filter | &nbsp; |
3179
3178
 
3180
3179
 
3181
3180
 
@@ -3183,7 +3182,7 @@ Gets the filters from logic data by Scopes/Scope IDs.
3183
3182
  ##### Returns
3184
3183
 
3185
3184
 
3186
- - a new Logic array
3185
+ - a property
3187
3186
 
3188
3187
 
3189
3188
 
@@ -3217,12 +3216,12 @@ Gets filters from the logic by the scopes hierarchy.
3217
3216
 
3218
3217
 
3219
3218
 
3220
- ### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
3219
+ ### dist/filters/helpers/backend/getLogicByScopes.js
3221
3220
 
3222
3221
 
3223
- #### getFilterBuilderGeneralConfig(config)
3222
+ #### getLogicByScopes(logics, scopes)
3224
3223
 
3225
- Returns a filter builder config object by a any given config
3224
+ Gets the filters from logic data by Scopes/Scope IDs.
3226
3225
 
3227
3226
 
3228
3227
 
@@ -3231,7 +3230,8 @@ Returns a filter builder config object by a any given config
3231
3230
 
3232
3231
  | Name | Type | Description | |
3233
3232
  | ---- | ---- | ----------- | -------- |
3234
- | config | | any config object | &nbsp; |
3233
+ | logics | | The logic array | &nbsp; |
3234
+ | scopes | | The collection of Scopes/Scope IDs | &nbsp; |
3235
3235
 
3236
3236
 
3237
3237
 
@@ -3239,17 +3239,17 @@ Returns a filter builder config object by a any given config
3239
3239
  ##### Returns
3240
3240
 
3241
3241
 
3242
- - The filter builder config object
3242
+ - a new Logic array
3243
3243
 
3244
3244
 
3245
3245
 
3246
3246
 
3247
- ### dist/filters/helpers/common/areFiltersEquals.js
3247
+ ### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
3248
3248
 
3249
3249
 
3250
- #### areFiltersEquals(filter1, filter2)
3250
+ #### excludeFiltersByAggregateColumn(filterData)
3251
3251
 
3252
- Validates if both filters are the same
3252
+ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
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
+ | filterData | | The filter data object | &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
+ - The new filter data object 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/common/areFiltersEquals.js
3276
3275
 
3277
3276
 
3278
- #### excludeFiltersByAggregateColumn(filterData)
3277
+ #### areFiltersEquals(filter1, filter2)
3279
3278
 
3280
- Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
3279
+ Validates if both filters are the same
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
+ | filter1 | | filter 1 | &nbsp; |
3289
+ | filter2 | | filter 2 | &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
+ - true: the filters are equal; false: the filters are NOT equal
3298
3298
 
3299
3299
 
3300
3300
 
3301
3301
 
3302
- ### dist/filters/helpers/common/excludeFiltersByParams.js
3302
+ ### dist/filters/helpers/common/excludeFiltersByScopes.js
3303
3303
 
3304
3304
 
3305
- #### excludeFiltersByParams(filterData, params)
3305
+ #### excludeFiltersByScopes(filterData, scopes)
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
+ Excludes and returns a filter data without filters by the given scopes
3317
3308
 
3318
3309
 
3319
3310
 
@@ -3322,8 +3313,8 @@ 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
+ | filterData | | The Filter Data | &nbsp; |
3317
+ | scopes | | collection of scopes to be as filtering parameters | &nbsp; |
3327
3318
 
3328
3319
 
3329
3320
 
@@ -3331,17 +3322,26 @@ The validation to filter the stored filter is depending on:
3331
3322
  ##### Returns
3332
3323
 
3333
3324
 
3334
- - a new Filter object structure
3325
+ - The new Filter Data without filters by the given scopes.
3335
3326
 
3336
3327
 
3337
3328
 
3338
3329
 
3339
- ### dist/filters/helpers/common/excludeFiltersByScopes.js
3330
+ ### dist/filters/helpers/common/excludeFiltersByParams.js
3340
3331
 
3341
3332
 
3342
- #### excludeFiltersByScopes(filterData, scopes)
3333
+ #### excludeFiltersByParams(filterData, params)
3343
3334
 
3344
- Excludes and returns a filter data without filters by the given scopes
3335
+ Excludes filters from the given Filters.
3336
+ The validation to filter the stored filter is depending on:
3337
+ - Column
3338
+ - Qrvey ID
3339
+ - Scope type
3340
+ - Scope ID
3341
+ - Panel ID
3342
+ - Validator type
3343
+ - Property type
3344
+ - Enabled flags
3345
3345
 
3346
3346
 
3347
3347
 
@@ -3350,8 +3350,8 @@ Excludes and returns a filter data without filters by the given scopes
3350
3350
 
3351
3351
  | Name | Type | Description | |
3352
3352
  | ---- | ---- | ----------- | -------- |
3353
- | filterData | | The Filter Data | &nbsp; |
3354
- | scopes | | collection of scopes to be as filtering parameters | &nbsp; |
3353
+ | filterData | | The Filter Data or the UI Filter Data | &nbsp; |
3354
+ | params | | given parameters to validate the filter data | &nbsp; |
3355
3355
 
3356
3356
 
3357
3357
 
@@ -3359,7 +3359,7 @@ Excludes and returns a filter data without filters by the given scopes
3359
3359
  ##### Returns
3360
3360
 
3361
3361
 
3362
- - The new Filter Data without filters by the given scopes.
3362
+ - a new Filter object structure
3363
3363
 
3364
3364
 
3365
3365