@qrvey/utils 1.10.0-timezone-1 → 1.10.0

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 (206) hide show
  1. package/README.md +1618 -952
  2. package/dist/cjs/columns/constants/COLUMN_PROPERTIES.d.ts +1 -1
  3. package/dist/cjs/columns/constants/COLUMN_PROPERTY_LABEL.d.ts +1 -0
  4. package/dist/cjs/columns/constants/COMPOUND_COLUMN_PROPERTY_LABEL.d.ts +1 -0
  5. package/dist/cjs/columns/constants/COMPOUND_COLUMN_PROPERTY_LABEL.js +1 -0
  6. package/dist/cjs/columns/helpers/isNumericalColumn.js +3 -1
  7. package/dist/cjs/dates/adapters/ISOToNumericOffset.js +6 -1
  8. package/dist/cjs/dates/adapters/dateToHms.js +5 -7
  9. package/dist/cjs/dates/adapters/dateToMdyDate.d.ts +2 -1
  10. package/dist/cjs/dates/adapters/dateToMdyDate.js +9 -3
  11. package/dist/cjs/dates/adapters/dateToMonthYear.d.ts +2 -1
  12. package/dist/cjs/dates/adapters/dateToMonthYear.js +6 -2
  13. package/dist/cjs/dates/adapters/dateToQuarterYear.d.ts +2 -1
  14. package/dist/cjs/dates/adapters/dateToQuarterYear.js +6 -2
  15. package/dist/cjs/dates/adapters/dateToWeekYear.d.ts +2 -1
  16. package/dist/cjs/dates/adapters/dateToWeekYear.js +6 -2
  17. package/dist/cjs/dates/adapters/dateToYear.d.ts +2 -1
  18. package/dist/cjs/dates/adapters/dateToYear.js +6 -2
  19. package/dist/cjs/dates/adapters/hmsToDate.d.ts +2 -1
  20. package/dist/cjs/dates/adapters/hmsToDate.js +6 -2
  21. package/dist/cjs/dates/adapters/mdyDateToDate.d.ts +2 -1
  22. package/dist/cjs/dates/adapters/mdyDateToDate.js +7 -2
  23. package/dist/cjs/dates/adapters/monthYearToDate.d.ts +2 -1
  24. package/dist/cjs/dates/adapters/monthYearToDate.js +6 -2
  25. package/dist/cjs/dates/adapters/numericOffsetToISO.d.ts +1 -1
  26. package/dist/cjs/dates/adapters/numericOffsetToISO.js +15 -8
  27. package/dist/cjs/dates/adapters/quarterYearToDate.d.ts +2 -1
  28. package/dist/cjs/dates/adapters/quarterYearToDate.js +6 -2
  29. package/dist/cjs/dates/adapters/weekYearToDate.d.ts +2 -1
  30. package/dist/cjs/dates/adapters/weekYearToDate.js +6 -2
  31. package/dist/cjs/dates/adapters/yearToDate.d.ts +2 -1
  32. package/dist/cjs/dates/adapters/yearToDate.js +6 -2
  33. package/dist/cjs/dates/constants/TIMEZONE_TYPE.d.ts +5 -0
  34. package/dist/cjs/dates/constants/TIMEZONE_TYPE.js +9 -0
  35. package/dist/cjs/dates/helpers/getDateByDateFormat.d.ts +2 -1
  36. package/dist/cjs/dates/helpers/getDateByDateFormat.js +6 -6
  37. package/dist/cjs/dates/helpers/getDateByTimezone.d.ts +3 -3
  38. package/dist/cjs/dates/helpers/getDateByTimezone.js +12 -27
  39. package/dist/cjs/dates/helpers/getDateByTimezoneOffset.d.ts +1 -1
  40. package/dist/cjs/dates/helpers/getDateByTimezoneOffset.js +14 -6
  41. package/dist/cjs/dates/helpers/getDefaultDateSettings.d.ts +7 -0
  42. package/dist/cjs/dates/helpers/getDefaultDateSettings.js +17 -0
  43. package/dist/cjs/dates/helpers/getFormattedDateByFormat.d.ts +2 -1
  44. package/dist/cjs/dates/helpers/getFormattedDateByFormat.js +7 -7
  45. package/dist/cjs/dates/helpers/getTimezoneObject.d.ts +8 -1
  46. package/dist/cjs/dates/helpers/getTimezoneObject.js +98 -14
  47. package/dist/cjs/dates/helpers/getTimezoneOffsetByType.d.ts +13 -0
  48. package/dist/cjs/dates/helpers/getTimezoneOffsetByType.js +27 -0
  49. package/dist/cjs/dates/helpers/getUTCFormatByOffset.d.ts +7 -0
  50. package/dist/cjs/dates/helpers/getUTCFormatByOffset.js +19 -0
  51. package/dist/cjs/dates/helpers/index.d.ts +4 -1
  52. package/dist/cjs/dates/helpers/index.js +4 -1
  53. package/dist/cjs/dates/helpers/isValidPotentialDate.d.ts +1 -0
  54. package/dist/cjs/dates/helpers/isValidPotentialDate.js +14 -5
  55. package/dist/cjs/dates/interfaces/IBTimezone.d.ts +7 -0
  56. package/dist/cjs/dates/interfaces/IBTimezoneType.d.ts +2 -0
  57. package/dist/cjs/dates/interfaces/IDFDateToHmsSettings.d.ts +2 -1
  58. package/dist/cjs/dates/interfaces/IDTimezone.d.ts +3 -0
  59. package/dist/cjs/dates/interfaces/IDTimezoneType.d.ts +2 -0
  60. package/dist/cjs/dates/interfaces/IDTimezoneType.js +2 -0
  61. package/dist/cjs/dates/interfaces/IDateSettings.d.ts +5 -0
  62. package/dist/cjs/dates/interfaces/IDateSettings.js +2 -0
  63. package/dist/cjs/dates/interfaces/index.d.ts +4 -1
  64. package/dist/cjs/dates/interfaces/index.js +4 -1
  65. package/dist/cjs/filters/services/Filters.api.js +1 -1
  66. package/dist/cjs/format/format.js +11 -0
  67. package/dist/cjs/format/localization.js +10 -1
  68. package/dist/cjs/general/array/getArrayByProperty.d.ts +1 -1
  69. package/dist/cjs/general/array/getUniqueArray.d.ts +1 -1
  70. package/dist/cjs/general/array/getUniqueArray.js +2 -0
  71. package/dist/cjs/general/mix/isEmpty.js +2 -0
  72. package/dist/cjs/general/mix/isNaNV2.d.ts +1 -0
  73. package/dist/cjs/general/mix/isNaNV2.js +7 -2
  74. package/dist/cjs/general/numeric/getSign.js +1 -1
  75. package/dist/cjs/general/object/applyTimezoneDeep.d.ts +1 -1
  76. package/dist/cjs/general/object/applyTimezoneDeep.js +17 -12
  77. package/dist/cjs/general/object/isObject.js +3 -1
  78. package/dist/cjs/general/object/mergeDeep.d.ts +6 -0
  79. package/dist/cjs/general/object/mergeDeep.js +12 -10
  80. package/dist/cjs/general/object/objectCopy.d.ts +1 -1
  81. package/dist/cjs/general/object/removeUndefinedDeep.js +6 -3
  82. package/dist/cjs/general/string/padLeadingZeros.d.ts +28 -1
  83. package/dist/cjs/general/string/padLeadingZeros.js +75 -7
  84. package/dist/cjs/globalization/interfaces/common/II18nColumnProperties.d.ts +1 -0
  85. package/dist/cjs/globalization/interfaces/dashboard/II18nDashboardToast.d.ts +1 -0
  86. package/dist/cjs/globalization/interfaces/dashboard/II18nDashboardTooltips.d.ts +1 -0
  87. package/dist/cjs/globalization/labels/common/I18N_COLUMN_PROPERTY_LABEL.js +1 -0
  88. package/dist/cjs/globalization/labels/dashboard/I18N_DASHBOARD.js +2 -0
  89. package/dist/cjs/globalization/labels/filters/I18N_RELATIVE_CONTAINER.js +1 -1
  90. package/dist/cjs/globalization/labels/formula_builder/I18N_FORMULA_BUILDER.js +5 -5
  91. package/dist/cjs/globalization/labels/panel/I18N_PANEL.js +1 -1
  92. package/dist/cjs/interfaces/format/IFormatConfig.Interface.d.ts +1 -1
  93. package/dist/cjs/qrvey/helpers/transformValue.js +35 -14
  94. package/dist/cjs/qrvey/interfaces/IBDataset.d.ts +1 -1
  95. package/dist/cjs/qrvey/interfaces/IBModel.d.ts +4 -1
  96. package/dist/cjs/qrvey/interfaces/index.d.ts +0 -1
  97. package/dist/cjs/qrvey/interfaces/index.js +0 -1
  98. package/dist/cjs/services/adapters/BTimezoneToUITimezone.d.ts +6 -1
  99. package/dist/cjs/services/adapters/BTimezoneToUITimezone.js +10 -1
  100. package/dist/columns/constants/COLUMN_PROPERTIES.d.ts +1 -1
  101. package/dist/columns/constants/COLUMN_PROPERTY_LABEL.d.ts +1 -0
  102. package/dist/columns/constants/COMPOUND_COLUMN_PROPERTY_LABEL.d.ts +1 -0
  103. package/dist/columns/constants/COMPOUND_COLUMN_PROPERTY_LABEL.js +1 -0
  104. package/dist/columns/helpers/isNumericalColumn.js +3 -1
  105. package/dist/dates/adapters/ISOToNumericOffset.js +6 -1
  106. package/dist/dates/adapters/dateToHms.js +5 -7
  107. package/dist/dates/adapters/dateToMdyDate.d.ts +2 -1
  108. package/dist/dates/adapters/dateToMdyDate.js +9 -3
  109. package/dist/dates/adapters/dateToMonthYear.d.ts +2 -1
  110. package/dist/dates/adapters/dateToMonthYear.js +6 -2
  111. package/dist/dates/adapters/dateToQuarterYear.d.ts +2 -1
  112. package/dist/dates/adapters/dateToQuarterYear.js +6 -2
  113. package/dist/dates/adapters/dateToWeekYear.d.ts +2 -1
  114. package/dist/dates/adapters/dateToWeekYear.js +6 -2
  115. package/dist/dates/adapters/dateToYear.d.ts +2 -1
  116. package/dist/dates/adapters/dateToYear.js +6 -2
  117. package/dist/dates/adapters/hmsToDate.d.ts +2 -1
  118. package/dist/dates/adapters/hmsToDate.js +6 -2
  119. package/dist/dates/adapters/mdyDateToDate.d.ts +2 -1
  120. package/dist/dates/adapters/mdyDateToDate.js +7 -2
  121. package/dist/dates/adapters/monthYearToDate.d.ts +2 -1
  122. package/dist/dates/adapters/monthYearToDate.js +6 -2
  123. package/dist/dates/adapters/numericOffsetToISO.d.ts +1 -1
  124. package/dist/dates/adapters/numericOffsetToISO.js +15 -8
  125. package/dist/dates/adapters/quarterYearToDate.d.ts +2 -1
  126. package/dist/dates/adapters/quarterYearToDate.js +6 -2
  127. package/dist/dates/adapters/weekYearToDate.d.ts +2 -1
  128. package/dist/dates/adapters/weekYearToDate.js +6 -2
  129. package/dist/dates/adapters/yearToDate.d.ts +2 -1
  130. package/dist/dates/adapters/yearToDate.js +6 -2
  131. package/dist/dates/constants/TIMEZONE_TYPE.d.ts +5 -0
  132. package/dist/dates/constants/TIMEZONE_TYPE.js +6 -0
  133. package/dist/dates/helpers/getDateByDateFormat.d.ts +2 -1
  134. package/dist/dates/helpers/getDateByDateFormat.js +6 -6
  135. package/dist/dates/helpers/getDateByTimezone.d.ts +3 -3
  136. package/dist/dates/helpers/getDateByTimezone.js +12 -27
  137. package/dist/dates/helpers/getDateByTimezoneOffset.d.ts +1 -1
  138. package/dist/dates/helpers/getDateByTimezoneOffset.js +11 -6
  139. package/dist/dates/helpers/getDefaultDateSettings.d.ts +7 -0
  140. package/dist/dates/helpers/getDefaultDateSettings.js +13 -0
  141. package/dist/dates/helpers/getFormattedDateByFormat.d.ts +2 -1
  142. package/dist/dates/helpers/getFormattedDateByFormat.js +7 -7
  143. package/dist/dates/helpers/getTimezoneObject.d.ts +8 -1
  144. package/dist/dates/helpers/getTimezoneObject.js +97 -13
  145. package/dist/dates/helpers/getTimezoneOffsetByType.d.ts +13 -0
  146. package/dist/dates/helpers/getTimezoneOffsetByType.js +23 -0
  147. package/dist/dates/helpers/getUTCFormatByOffset.d.ts +7 -0
  148. package/dist/dates/helpers/getUTCFormatByOffset.js +15 -0
  149. package/dist/dates/helpers/index.d.ts +4 -1
  150. package/dist/dates/helpers/index.js +4 -1
  151. package/dist/dates/helpers/isValidPotentialDate.d.ts +1 -0
  152. package/dist/dates/helpers/isValidPotentialDate.js +14 -5
  153. package/dist/dates/interfaces/IBTimezone.d.ts +7 -0
  154. package/dist/dates/interfaces/IBTimezoneType.d.ts +2 -0
  155. package/dist/dates/interfaces/IDFDateToHmsSettings.d.ts +2 -1
  156. package/dist/dates/interfaces/IDTimezone.d.ts +3 -0
  157. package/dist/dates/interfaces/IDTimezoneType.d.ts +2 -0
  158. package/dist/dates/interfaces/IDTimezoneType.js +1 -0
  159. package/dist/dates/interfaces/IDateSettings.d.ts +5 -0
  160. package/dist/dates/interfaces/IDateSettings.js +1 -0
  161. package/dist/dates/interfaces/index.d.ts +4 -1
  162. package/dist/dates/interfaces/index.js +4 -1
  163. package/dist/filters/services/Filters.api.js +1 -1
  164. package/dist/format/format.js +11 -0
  165. package/dist/format/localization.js +10 -1
  166. package/dist/general/array/getArrayByProperty.d.ts +1 -1
  167. package/dist/general/array/getUniqueArray.d.ts +1 -1
  168. package/dist/general/array/getUniqueArray.js +2 -0
  169. package/dist/general/mix/isEmpty.js +2 -0
  170. package/dist/general/mix/isNaNV2.d.ts +1 -0
  171. package/dist/general/mix/isNaNV2.js +7 -2
  172. package/dist/general/numeric/getSign.js +1 -1
  173. package/dist/general/object/applyTimezoneDeep.d.ts +1 -1
  174. package/dist/general/object/applyTimezoneDeep.js +17 -12
  175. package/dist/general/object/isObject.js +3 -1
  176. package/dist/general/object/mergeDeep.d.ts +6 -0
  177. package/dist/general/object/mergeDeep.js +12 -10
  178. package/dist/general/object/objectCopy.d.ts +1 -1
  179. package/dist/general/object/removeUndefinedDeep.js +6 -3
  180. package/dist/general/string/padLeadingZeros.d.ts +28 -1
  181. package/dist/general/string/padLeadingZeros.js +75 -7
  182. package/dist/globalization/interfaces/common/II18nColumnProperties.d.ts +1 -0
  183. package/dist/globalization/interfaces/dashboard/II18nDashboardToast.d.ts +1 -0
  184. package/dist/globalization/interfaces/dashboard/II18nDashboardTooltips.d.ts +1 -0
  185. package/dist/globalization/labels/common/I18N_COLUMN_PROPERTY_LABEL.js +1 -0
  186. package/dist/globalization/labels/dashboard/I18N_DASHBOARD.js +2 -0
  187. package/dist/globalization/labels/filters/I18N_RELATIVE_CONTAINER.js +1 -1
  188. package/dist/globalization/labels/formula_builder/I18N_FORMULA_BUILDER.js +5 -5
  189. package/dist/globalization/labels/panel/I18N_PANEL.js +1 -1
  190. package/dist/interfaces/format/IFormatConfig.Interface.d.ts +1 -1
  191. package/dist/qrvey/helpers/transformValue.js +35 -14
  192. package/dist/qrvey/interfaces/IBDataset.d.ts +1 -1
  193. package/dist/qrvey/interfaces/IBModel.d.ts +4 -1
  194. package/dist/qrvey/interfaces/index.d.ts +0 -1
  195. package/dist/qrvey/interfaces/index.js +0 -1
  196. package/dist/services/adapters/BTimezoneToUITimezone.d.ts +6 -1
  197. package/dist/services/adapters/BTimezoneToUITimezone.js +10 -1
  198. package/package.json +4 -3
  199. package/dist/cjs/dates/interfaces/IGetDateByTimezoneSettings.d.ts +0 -6
  200. package/dist/cjs/qrvey/interfaces/IBTimezone.d.ts +0 -4
  201. package/dist/dates/interfaces/IGetDateByTimezoneSettings.d.ts +0 -6
  202. package/dist/qrvey/interfaces/IBTimezone.d.ts +0 -4
  203. /package/dist/cjs/{qrvey → dates}/interfaces/IBTimezone.js +0 -0
  204. /package/dist/cjs/dates/interfaces/{IGetDateByTimezoneSettings.js → IBTimezoneType.js} +0 -0
  205. /package/dist/{qrvey → dates}/interfaces/IBTimezone.js +0 -0
  206. /package/dist/dates/interfaces/{IGetDateByTimezoneSettings.js → IBTimezoneType.js} +0 -0
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.9.0*
1
+ # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.10.0*
2
2
 
3
3
  > Helper, Utils for all Qrvey Projects
4
4
 
@@ -402,6 +402,34 @@ Gets the column array
402
402
 
403
403
 
404
404
 
405
+ ### dist/columns/helpers/getModelColumn.js
406
+
407
+
408
+ #### getModelColumn(column, model)
409
+
410
+ Get a model column by a partial column info.
411
+
412
+
413
+
414
+
415
+ ##### Parameters
416
+
417
+ | Name | Type | Description | |
418
+ | ---- | ---- | ----------- | -------- |
419
+ | column | `IColumn` | The partial column info |   |
420
+ | model | `IModel` | The model object |   |
421
+
422
+
423
+
424
+
425
+ ##### Returns
426
+
427
+
428
+ - the model column
429
+
430
+
431
+
432
+
405
433
  ### dist/columns/helpers/getDatasetColumnByDatasets.js
406
434
 
407
435
 
@@ -456,12 +484,12 @@ Validates the arguments
456
484
 
457
485
 
458
486
 
459
- ### dist/columns/helpers/getModelColumn.js
487
+ ### dist/dates/adapters/ISOToNumericOffset.js
460
488
 
461
489
 
462
- #### getModelColumn(column, model)
490
+ #### ISOToNumericOffset(offset)
463
491
 
464
- Get a model column by a partial column info.
492
+ Gets the numeric offset (minutes) from the ISO offset (string)
465
493
 
466
494
 
467
495
 
@@ -470,8 +498,7 @@ Get a model column by a partial column info.
470
498
 
471
499
  | Name | Type | Description | |
472
500
  | ---- | ---- | ----------- | -------- |
473
- | column | `IColumn` | The partial column info |   |
474
- | model | `IModel` | The model object |   |
501
+ | offset | `string` | the timezone offset |   |
475
502
 
476
503
 
477
504
 
@@ -479,7 +506,7 @@ Get a model column by a partial column info.
479
506
  ##### Returns
480
507
 
481
508
 
482
- - the model column
509
+ - `number` the offset in minutes
483
510
 
484
511
 
485
512
 
@@ -607,12 +634,12 @@ Gets the Seconds
607
634
 
608
635
 
609
636
 
610
- ### dist/dates/adapters/dateToMdyDate.js
637
+ ### dist/dates/adapters/dateToMonthYear.js
611
638
 
612
639
 
613
- #### dateToMdyDate(date)
640
+ #### dateToMonthYear(date)
614
641
 
615
- Transform a Date to [mm/dd/yyyy] date format.
642
+ Transform a Date to [Month Year] date format.
616
643
 
617
644
 
618
645
 
@@ -629,17 +656,17 @@ Transform a Date to [mm/dd/yyyy] date format.
629
656
  ##### Returns
630
657
 
631
658
 
632
- - string of [mm/dd/yyyy] date format
659
+ - string of [Month Year] date format
633
660
 
634
661
 
635
662
 
636
663
 
637
- ### dist/dates/adapters/dateToMonthYear.js
664
+ ### dist/dates/adapters/dateToMdyDate.js
638
665
 
639
666
 
640
- #### dateToMonthYear(date)
667
+ #### dateToMdyDate(date)
641
668
 
642
- Transform a Date to [Month Year] date format.
669
+ Transform a Date to [mm/dd/yyyy] date format.
643
670
 
644
671
 
645
672
 
@@ -656,7 +683,7 @@ Transform a Date to [Month Year] date format.
656
683
  ##### Returns
657
684
 
658
685
 
659
- - string of [Month Year] date format
686
+ - string of [mm/dd/yyyy] date format
660
687
 
661
688
 
662
689
 
@@ -826,6 +853,33 @@ Transforms String Date from a [Month Year] format to Date object.
826
853
 
827
854
 
828
855
 
856
+ ### dist/dates/adapters/numericOffsetToISO.js
857
+
858
+
859
+ #### numericOffsetToISO(offset)
860
+
861
+ Gets the ISO offset From the numeric offset (minutes)
862
+
863
+
864
+
865
+
866
+ ##### Parameters
867
+
868
+ | Name | Type | Description | |
869
+ | ---- | ---- | ----------- | -------- |
870
+ | offset | `number` | the timezone offset |   |
871
+
872
+
873
+
874
+
875
+ ##### Returns
876
+
877
+
878
+ - `string` the offset in minutes
879
+
880
+
881
+
882
+
829
883
  ### dist/dates/adapters/quarterYearToDate.js
830
884
 
831
885
 
@@ -910,125 +964,108 @@ Transforms String Date from a [Year] format to Date object.
910
964
 
911
965
 
912
966
 
913
- ### dist/dates/helpers/adjustTimezone.js
967
+ ### dist/dates/relative/RelativeStatementAdapter.js
914
968
 
915
969
 
916
- #### adjustTimezone(date)
970
+ #### value()
917
971
 
918
- Adjusts a Date with the UTC-0 Timezone.
972
+ Resolves statement and returns statement value
919
973
 
920
974
 
921
975
 
922
976
 
923
- ##### Parameters
924
977
 
925
- | Name | Type | Description | |
926
- | ---- | ---- | ----------- | -------- |
927
- | date | | String, object or millisencond number of the date |   |
928
978
 
979
+ ##### Returns
929
980
 
930
981
 
982
+ - `AbsoluteRange` `string`
931
983
 
932
- ##### Returns
933
984
 
934
985
 
935
- - updated Date object
986
+ #### valueAsAnchor()
936
987
 
988
+ Resolves statement as an anchor
937
989
 
938
990
 
939
991
 
940
- ### dist/dates/helpers/areIncludedDateTokens.js
941
992
 
942
993
 
943
- #### areIncludedDateTokens(date, format)
944
994
 
945
- Determines if the given date has tokens. The date is splitted depending on date format.
946
- Undefined date is returning false.
995
+ ##### Returns
947
996
 
948
997
 
998
+ - `string`
949
999
 
950
1000
 
951
- ##### Parameters
952
1001
 
953
- | Name | Type | Description | |
954
- | ---- | ---- | ----------- | -------- |
955
- | date | | The string of the date. It may contain tokens. |   |
956
- | format | | The date format |   |
1002
+ #### _statementToRange() *private method*
957
1003
 
1004
+ Convert verbal statement to range value
958
1005
 
959
1006
 
960
1007
 
961
- ##### Returns
962
1008
 
963
1009
 
964
- - true: include tokens; false: otherwise
965
1010
 
1011
+ ##### Returns
966
1012
 
967
1013
 
1014
+ - `AbsoluteRange`
968
1015
 
969
- ### dist/dates/helpers/getDateByDateFormat.js
970
1016
 
971
1017
 
972
- #### getDateByDateFormat(date, format, time)
1018
+ #### _resolveAsThis() *private method*
973
1019
 
974
- Gets a Date Object instance by a Date format
1020
+ Apply 'this' cursor logic to statement
975
1021
 
976
1022
 
977
1023
 
978
1024
 
979
- ##### Parameters
980
1025
 
981
- | Name | Type | Description | |
982
- | ---- | ---- | ----------- | -------- |
983
- | date | | String with a formatted date |   |
984
- | format | | The date format |   |
985
- | time | | flag to convert the formatted date to miliseconds |   |
986
1026
 
1027
+ ##### Returns
987
1028
 
988
1029
 
1030
+ - `AbsoluteStatement`
989
1031
 
990
- ##### Returns
991
1032
 
992
1033
 
993
- - a Date object, milisecond time or the same value if date format does not match.
1034
+ #### _resolveAsTheLast() *private method*
994
1035
 
1036
+ Apply 'the last' cursor logic to statement
995
1037
 
996
1038
 
997
1039
 
998
- ### dist/dates/helpers/getDateFormatByProperty.js
999
1040
 
1000
1041
 
1001
- #### getDateFormatByProperty(property)
1002
1042
 
1003
- Gets the date format by the given property
1043
+ ##### Returns
1004
1044
 
1005
1045
 
1046
+ - `AbsoluteStatement`
1006
1047
 
1007
1048
 
1008
- ##### Parameters
1009
1049
 
1010
- | Name | Type | Description | |
1011
- | ---- | ---- | ----------- | -------- |
1012
- | property | | The Column Property |   |
1050
+ #### _resolveAsTheNext() *private method*
1013
1051
 
1052
+ Apply 'the next' cursor logic to statement
1014
1053
 
1015
1054
 
1016
1055
 
1017
- ##### Returns
1018
1056
 
1019
1057
 
1020
- - The date format
1021
1058
 
1059
+ ##### Returns
1022
1060
 
1023
1061
 
1062
+ - `AbsoluteStatement`
1024
1063
 
1025
- ### dist/dates/helpers/getDateFormatRegularExpressionInArray.js
1026
1064
 
1027
1065
 
1028
- #### getDateFormatRegularExpressionInArray(dateFormat)
1066
+ #### replaceNowToken(value, now)
1029
1067
 
1030
- Gets an array of regular expressions by the given date format.
1031
- Day format is the default date format
1068
+ Replace '@now' token inside a string
1032
1069
 
1033
1070
 
1034
1071
 
@@ -1037,7 +1074,8 @@ Day format is the default date format
1037
1074
 
1038
1075
  | Name | Type | Description | |
1039
1076
  | ---- | ---- | ----------- | -------- |
1040
- | dateFormat | `IDateFormat` | an string of the format |   |
1077
+ | value | `string` | |   |
1078
+ | now | `Date` | |   |
1041
1079
 
1042
1080
 
1043
1081
 
@@ -1045,17 +1083,13 @@ Day format is the default date format
1045
1083
  ##### Returns
1046
1084
 
1047
1085
 
1048
- - an array of regular expressions
1049
-
1050
-
1051
-
1086
+ - `string`
1052
1087
 
1053
- ### dist/dates/helpers/getDatePickerPickLevel.js
1054
1088
 
1055
1089
 
1056
- #### getDatePickerPickLevel(format)
1090
+ #### convertRelativeToAbsolute(args)
1057
1091
 
1058
- Gets the pick level number related to the Date picker element
1092
+ Returns a range object (date) from a group of statement params
1059
1093
 
1060
1094
 
1061
1095
 
@@ -1064,25 +1098,45 @@ Gets the pick level number related to the Date picker element
1064
1098
 
1065
1099
  | Name | Type | Description | |
1066
1100
  | ---- | ---- | ----------- | -------- |
1067
- | format | `IDateFormat` | The date format |   |
1101
+ | args | `RelativeToAbsoluteStruct` | |   |
1102
+
1068
1103
 
1069
1104
 
1070
1105
 
1106
+ ##### Examples
1107
+
1108
+ ```javascript
1109
+ pivot = '2021-03-03T12:30:40'
1110
+ unit = month
1111
+ steps = 2
1112
+ setTo = END
1113
+ resolverAsCalendar: true
1114
+ => Returns '2021-05-31T23:59:59'
1115
+ ```
1116
+ ```javascript
1117
+ pivot = '2021-03-03T12:30:40'
1118
+ unit = month
1119
+ steps = -2
1120
+ setTo = START
1121
+ resolverAsCalendar: false
1122
+ => Returns '2021-01-03T00:00:00'
1123
+ ```
1124
+
1071
1125
 
1072
1126
  ##### Returns
1073
1127
 
1074
1128
 
1075
- - `number` A number of the pick level setting
1129
+ - `string`
1076
1130
 
1077
1131
 
1078
1132
 
1079
1133
 
1080
- ### dist/dates/helpers/getDateRange.js
1134
+ ### dist/dates/relative/relative.js
1081
1135
 
1082
1136
 
1083
- #### getDateRange(value, dateGroupProperty, withTime)
1137
+ #### resolveRelative(statements, clock)
1084
1138
 
1085
- Get date range object from a string date value
1139
+ Resolve a list of relative statements according to operator
1086
1140
 
1087
1141
 
1088
1142
 
@@ -1091,9 +1145,8 @@ Get date range object from a string date value
1091
1145
 
1092
1146
  | Name | Type | Description | |
1093
1147
  | ---- | ---- | ----------- | -------- |
1094
- | value | `String` | string date value |   |
1095
- | dateGroupProperty | `String` | could be 'YEAR', 'QUARTER', 'MONTH' or 'DAY'. Deafult is 'DAY' |   |
1096
- | withTime | `Boolean` | determines if the date range will include time. Default is true |   |
1148
+ | statements | `Array.<RelativeStatement>` `Array.<string>` | - Raw statements/values | &nbsp; |
1149
+ | clock | `Date` | - Clock/time reference for relative date resolution | &nbsp; |
1097
1150
 
1098
1151
 
1099
1152
 
@@ -1101,42 +1154,36 @@ Get date range object from a string date value
1101
1154
  ##### Examples
1102
1155
 
1103
1156
  ```javascript
1104
- // 1) Year:
1105
- getDateRange('2020', 'YEAR');
1106
- // Will return:
1107
- {
1108
- from: '01/01/2020 00:00:00',
1109
- to: '12/31/2020 23:59:59'
1110
- }
1111
-
1112
- // 2) Quarter:
1113
- getDateRange('Q3 2020', 'QUARTER');
1114
- // Will return:
1157
+ Input:
1115
1158
  {
1116
- from: '07/01/2020 00:00:00',
1117
- to: '09/30/2020 23:59:59'
1159
+ "cursor": "the_next",
1160
+ "unit": "year",
1161
+ "number": 1,
1162
+ "includeCurrent": false,
1163
+ "isCalendarDate": false,
1164
+ "anchor": "03/05/2021"
1118
1165
  }
1119
1166
 
1120
- // 3) Month:
1121
- getDateRange('Oct 2020', 'MONTH');
1122
- // Will return:
1123
- {
1124
- from: '10/01/2020 00:00:00',
1125
- to: '10/31/2020 23:59:59'
1126
- }
1167
+ Output:
1168
+ { gte: "03/06/2021 00:00:00", lte: "03/05/2022 23:59:59" }
1127
1169
  ```
1128
1170
 
1129
1171
 
1130
1172
  ##### Returns
1131
1173
 
1132
1174
 
1133
- - `Object` an object with the date range with two string date properties: from and to
1175
+ - `Array.&lt;AbsoluteRange&gt;` `Array.&lt;string&gt;`
1134
1176
 
1135
1177
 
1136
1178
 
1137
- #### getStringDate(dt)
1138
1179
 
1139
- It takes a Date object as an argument and returns a string in the format of MM/DD/YYYY
1180
+ ### dist/dates/helpers/areIncludedDateTokens.js
1181
+
1182
+
1183
+ #### areIncludedDateTokens(date, format)
1184
+
1185
+ Determines if the given date has tokens. The date is splitted depending on date format.
1186
+ Undefined date is returning false.
1140
1187
 
1141
1188
 
1142
1189
 
@@ -1145,7 +1192,8 @@ It takes a Date object as an argument and returns a string in the format of MM/D
1145
1192
 
1146
1193
  | Name | Type | Description | |
1147
1194
  | ---- | ---- | ----------- | -------- |
1148
- | dt | `Date` | - Date - The date object to convert to a string | &nbsp; |
1195
+ | date | | The string of the date. It may contain tokens. | &nbsp; |
1196
+ | format | | The date format | &nbsp; |
1149
1197
 
1150
1198
 
1151
1199
 
@@ -1153,18 +1201,17 @@ It takes a Date object as an argument and returns a string in the format of MM/D
1153
1201
  ##### Returns
1154
1202
 
1155
1203
 
1156
- - A string in the format of MM/DD/YYYY
1204
+ - true: include tokens; false: otherwise
1157
1205
 
1158
1206
 
1159
1207
 
1160
1208
 
1161
- ### dist/dates/helpers/getFormattedDateByFormat.js
1209
+ ### dist/dates/helpers/getDateByDateFormat.js
1162
1210
 
1163
1211
 
1164
- #### getFormattedDateByFormat(date, format)
1212
+ #### getDateByDateFormat(date, format, time)
1165
1213
 
1166
- A Date object, string or millisecond number are gotten in order to convert it in an formatted string date
1167
- - Some strings are valid
1214
+ Gets a Date Object instance by a Date format
1168
1215
 
1169
1216
 
1170
1217
 
@@ -1175,6 +1222,7 @@ A Date object, string or millisecond number are gotten in order to convert it in
1175
1222
  | ---- | ---- | ----------- | -------- |
1176
1223
  | date | | String with a formatted date | &nbsp; |
1177
1224
  | format | | The date format | &nbsp; |
1225
+ | time | | flag to convert the formatted date to miliseconds | &nbsp; |
1178
1226
 
1179
1227
 
1180
1228
 
@@ -1182,17 +1230,17 @@ A Date object, string or millisecond number are gotten in order to convert it in
1182
1230
  ##### Returns
1183
1231
 
1184
1232
 
1185
- - a formmatted date or the same value if format does not match
1233
+ - a Date object, milisecond time or the same value if date format does not match.
1186
1234
 
1187
1235
 
1188
1236
 
1189
1237
 
1190
- ### dist/dates/helpers/getSeparatorByDateFormat.js
1238
+ ### dist/dates/helpers/getDateByTimezone.js
1191
1239
 
1192
1240
 
1193
- #### getSeparatorByDateFormat(format)
1241
+ #### getDateByTimezone(date, timezone)
1194
1242
 
1195
- Gets the separator of the date format
1243
+ Gets a date value in the given timezone
1196
1244
 
1197
1245
 
1198
1246
 
@@ -1201,7 +1249,8 @@ Gets the separator of the date format
1201
1249
 
1202
1250
  | Name | Type | Description | |
1203
1251
  | ---- | ---- | ----------- | -------- |
1204
- | format | `IDateFormat` | the date format | &nbsp; |
1252
+ | date | `string` | the date | &nbsp; |
1253
+ | timezone | `IDTimezone` | the timezone object | &nbsp; |
1205
1254
 
1206
1255
 
1207
1256
 
@@ -1209,18 +1258,18 @@ Gets the separator of the date format
1209
1258
  ##### Returns
1210
1259
 
1211
1260
 
1212
- - a separator string
1261
+ - `string` A transformed value
1213
1262
 
1214
1263
 
1215
1264
 
1216
1265
 
1217
- ### dist/dates/helpers/getWeek.js
1266
+ ### dist/dates/helpers/getDateByTimezoneOffset.js
1218
1267
 
1219
1268
 
1220
- #### getWeek(date)
1269
+ #### getDateByTimezoneOffset(date)
1221
1270
 
1222
- Gets the week number of the year
1223
- Additionally, the month and the year
1271
+ Gets a Date with the given offset of the Timezone.
1272
+ No given an offset the default is going to be set by the browser
1224
1273
 
1225
1274
 
1226
1275
 
@@ -1229,7 +1278,7 @@ Additionally, the month and the year
1229
1278
 
1230
1279
  | Name | Type | Description | |
1231
1280
  | ---- | ---- | ----------- | -------- |
1232
- | date | `Date` | the date object | &nbsp; |
1281
+ | date | | String, object or millisencond number of the date | &nbsp; |
1233
1282
 
1234
1283
 
1235
1284
 
@@ -1237,17 +1286,17 @@ Additionally, the month and the year
1237
1286
  ##### Returns
1238
1287
 
1239
1288
 
1240
- - an object with the week, month and year or undefined if the date is not valid.
1289
+ - updated Date object
1241
1290
 
1242
1291
 
1243
1292
 
1244
1293
 
1245
- ### dist/dates/helpers/isValidDateObject.js
1294
+ ### dist/dates/helpers/getDateFormatByProperty.js
1246
1295
 
1247
1296
 
1248
- #### isValidDateObject(date)
1297
+ #### getDateFormatByProperty(property)
1249
1298
 
1250
- If the date is a valid Date object, return true, otherwise return false.
1299
+ Gets the date format by the given property
1251
1300
 
1252
1301
 
1253
1302
 
@@ -1256,7 +1305,7 @@ If the date is a valid Date object, return true, otherwise return false.
1256
1305
 
1257
1306
  | Name | Type | Description | |
1258
1307
  | ---- | ---- | ----------- | -------- |
1259
- | date | `Date` | - The date object to check. | &nbsp; |
1308
+ | property | | The Column Property | &nbsp; |
1260
1309
 
1261
1310
 
1262
1311
 
@@ -1264,17 +1313,18 @@ If the date is a valid Date object, return true, otherwise return false.
1264
1313
  ##### Returns
1265
1314
 
1266
1315
 
1267
- - A boolean value.
1316
+ - The date format
1268
1317
 
1269
1318
 
1270
1319
 
1271
1320
 
1272
- ### dist/dates/helpers/isValidPotentialDate.js
1321
+ ### dist/dates/helpers/getDateFormatRegularExpressionInArray.js
1273
1322
 
1274
1323
 
1275
- #### isValidPotentialDate(date)
1324
+ #### getDateFormatRegularExpressionInArray(dateFormat)
1276
1325
 
1277
- Checks if the given date is allowed to continue the process for adapting dates
1326
+ Gets an array of regular expressions by the given date format.
1327
+ Day format is the default date format
1278
1328
 
1279
1329
 
1280
1330
 
@@ -1283,7 +1333,7 @@ Checks if the given date is allowed to continue the process for adapting dates
1283
1333
 
1284
1334
  | Name | Type | Description | |
1285
1335
  | ---- | ---- | ----------- | -------- |
1286
- | date | `string` `Date` `number` | String, object or millisencond number of the date | &nbsp; |
1336
+ | dateFormat | `IDateFormat` | an string of the format | &nbsp; |
1287
1337
 
1288
1338
 
1289
1339
 
@@ -1291,20 +1341,17 @@ Checks if the given date is allowed to continue the process for adapting dates
1291
1341
  ##### Returns
1292
1342
 
1293
1343
 
1294
- - true: the date is valid.
1344
+ - an array of regular expressions
1295
1345
 
1296
1346
 
1297
1347
 
1298
1348
 
1299
- ### dist/dates/helpers/validateDate.js
1349
+ ### dist/dates/helpers/getDatePickerPickLevel.js
1300
1350
 
1301
1351
 
1302
- #### validateDate(date, format)
1352
+ #### getDatePickerPickLevel(format)
1303
1353
 
1304
- Validate a string date depending on giving format
1305
- - If the string is a token label, the function lets it pass.
1306
- - Otherwise depends of the format
1307
- - Some escenarios the string is a mix of token labels and dates
1354
+ Gets the pick level number related to the Date picker element
1308
1355
 
1309
1356
 
1310
1357
 
@@ -1313,8 +1360,7 @@ Validate a string date depending on giving format
1313
1360
 
1314
1361
  | Name | Type | Description | |
1315
1362
  | ---- | ---- | ----------- | -------- |
1316
- | date | | String of date | &nbsp; |
1317
- | format | | String of the format to validate | &nbsp; |
1363
+ | format | `IDateFormat` | The date format | &nbsp; |
1318
1364
 
1319
1365
 
1320
1366
 
@@ -1322,51 +1368,109 @@ Validate a string date depending on giving format
1322
1368
  ##### Returns
1323
1369
 
1324
1370
 
1325
- - True if it is valid or not. Undefined if date is undefined
1371
+ - `number` A number of the pick level setting
1326
1372
 
1327
1373
 
1328
1374
 
1329
1375
 
1330
- ### dist/dates/relative/RelativeStatementAdapter.js
1376
+ ### dist/dates/helpers/getDateRange.js
1331
1377
 
1332
1378
 
1333
- #### value()
1379
+ #### getDateRange(value, dateGroupProperty, withTime)
1334
1380
 
1335
- Resolves statement and returns statement value
1381
+ Get date range object from a string date value
1382
+
1383
+
1384
+
1385
+
1386
+ ##### Parameters
1336
1387
 
1388
+ | Name | Type | Description | |
1389
+ | ---- | ---- | ----------- | -------- |
1390
+ | value | `String` | string date value | &nbsp; |
1391
+ | dateGroupProperty | `String` | could be 'YEAR', 'QUARTER', 'MONTH' or 'DAY'. Deafult is 'DAY' | &nbsp; |
1392
+ | withTime | `Boolean` | determines if the date range will include time. Default is true | &nbsp; |
1337
1393
 
1338
1394
 
1339
1395
 
1340
1396
 
1397
+ ##### Examples
1398
+
1399
+ ```javascript
1400
+ // 1) Year:
1401
+ getDateRange('2020', 'YEAR');
1402
+ // Will return:
1403
+ {
1404
+ from: '01/01/2020 00:00:00',
1405
+ to: '12/31/2020 23:59:59'
1406
+ }
1407
+
1408
+ // 2) Quarter:
1409
+ getDateRange('Q3 2020', 'QUARTER');
1410
+ // Will return:
1411
+ {
1412
+ from: '07/01/2020 00:00:00',
1413
+ to: '09/30/2020 23:59:59'
1414
+ }
1415
+
1416
+ // 3) Month:
1417
+ getDateRange('Oct 2020', 'MONTH');
1418
+ // Will return:
1419
+ {
1420
+ from: '10/01/2020 00:00:00',
1421
+ to: '10/31/2020 23:59:59'
1422
+ }
1423
+ ```
1424
+
1341
1425
 
1342
1426
  ##### Returns
1343
1427
 
1344
1428
 
1345
- - `AbsoluteRange` `string`
1429
+ - `Object` an object with the date range with two string date properties: from and to
1346
1430
 
1347
1431
 
1348
1432
 
1349
- #### valueAsAnchor()
1433
+ #### getStringDate(dt)
1350
1434
 
1351
- Resolves statement as an anchor
1435
+ It takes a Date object as an argument and returns a string in the format of MM/DD/YYYY
1352
1436
 
1353
1437
 
1354
1438
 
1355
1439
 
1440
+ ##### Parameters
1441
+
1442
+ | Name | Type | Description | |
1443
+ | ---- | ---- | ----------- | -------- |
1444
+ | dt | `Date` | - Date - The date object to convert to a string | &nbsp; |
1445
+
1446
+
1356
1447
 
1357
1448
 
1358
1449
  ##### Returns
1359
1450
 
1360
1451
 
1361
- - `string`
1452
+ - A string in the format of MM/DD/YYYY
1362
1453
 
1363
1454
 
1364
1455
 
1365
- #### _statementToRange() *private method*
1366
1456
 
1367
- Convert verbal statement to range value
1457
+ ### dist/dates/helpers/getFormattedDateByFormat.js
1458
+
1368
1459
 
1460
+ #### getFormattedDateByFormat(date, format)
1369
1461
 
1462
+ A Date object, string or millisecond number are gotten in order to convert it in an formatted string date
1463
+ - Some strings are valid
1464
+
1465
+
1466
+
1467
+
1468
+ ##### Parameters
1469
+
1470
+ | Name | Type | Description | |
1471
+ | ---- | ---- | ----------- | -------- |
1472
+ | date | | String with a formatted date | &nbsp; |
1473
+ | format | | The date format | &nbsp; |
1370
1474
 
1371
1475
 
1372
1476
 
@@ -1374,15 +1478,26 @@ Convert verbal statement to range value
1374
1478
  ##### Returns
1375
1479
 
1376
1480
 
1377
- - `AbsoluteRange`
1481
+ - a formmatted date or the same value if format does not match
1378
1482
 
1379
1483
 
1380
1484
 
1381
- #### _resolveAsThis() *private method*
1382
1485
 
1383
- Apply 'this' cursor logic to statement
1486
+ ### dist/dates/helpers/getSeparatorByDateFormat.js
1487
+
1488
+
1489
+ #### getSeparatorByDateFormat(format)
1490
+
1491
+ Gets the separator of the date format
1492
+
1493
+
1494
+
1384
1495
 
1496
+ ##### Parameters
1385
1497
 
1498
+ | Name | Type | Description | |
1499
+ | ---- | ---- | ----------- | -------- |
1500
+ | format | `IDateFormat` | the date format | &nbsp; |
1386
1501
 
1387
1502
 
1388
1503
 
@@ -1390,15 +1505,26 @@ Apply 'this' cursor logic to statement
1390
1505
  ##### Returns
1391
1506
 
1392
1507
 
1393
- - `AbsoluteStatement`
1508
+ - a separator string
1394
1509
 
1395
1510
 
1396
1511
 
1397
- #### _resolveAsTheLast() *private method*
1398
1512
 
1399
- Apply 'the last' cursor logic to statement
1513
+ ### dist/dates/helpers/getDefaultDateSettings.js
1514
+
1400
1515
 
1516
+ #### getDefaultDateSettings(settings)
1401
1517
 
1518
+ Gets the default properties for Date Settings object
1519
+
1520
+
1521
+
1522
+
1523
+ ##### Parameters
1524
+
1525
+ | Name | Type | Description | |
1526
+ | ---- | ---- | ----------- | -------- |
1527
+ | settings | | the date settings | &nbsp; |
1402
1528
 
1403
1529
 
1404
1530
 
@@ -1406,29 +1532,294 @@ Apply 'the last' cursor logic to statement
1406
1532
  ##### Returns
1407
1533
 
1408
1534
 
1409
- - `AbsoluteStatement`
1535
+ - a new object with the date settings.
1410
1536
 
1411
1537
 
1412
1538
 
1413
- #### _resolveAsTheNext() *private method*
1414
1539
 
1415
- Apply 'the next' cursor logic to statement
1540
+ ### dist/dates/helpers/getTimezoneObject.js
1541
+
1542
+
1543
+ #### getTimezoneObject(timezone, model)
1416
1544
 
1545
+ Gets the timezone object by the given argument or the model object
1546
+ - In any case, the offset is prioritized to override other properties.
1417
1547
 
1418
1548
 
1419
1549
 
1420
1550
 
1551
+ ##### Parameters
1552
+
1553
+ | Name | Type | Description | |
1554
+ | ---- | ---- | ----------- | -------- |
1555
+ | timezone | `IDTimezone` | the timezone object | &nbsp; |
1556
+ | model | `IModel` `IDataset` | the info of the dataset (model) | &nbsp; |
1557
+
1558
+
1559
+
1421
1560
 
1422
1561
  ##### Returns
1423
1562
 
1424
1563
 
1425
- - `AbsoluteStatement`
1564
+ - a new timezone object
1426
1565
 
1427
1566
 
1428
1567
 
1429
- #### replaceNowToken(value, now)
1568
+ #### getOffset(timezone, model)
1430
1569
 
1431
- Replace '@now' token inside a string
1570
+ Gets the offset of the timezone by the given objects
1571
+ - Searchs the first argument
1572
+ - If the timezone is empty, in the model timezone is searched
1573
+ - If it does not exist in any, a default one is set.
1574
+
1575
+
1576
+
1577
+
1578
+ ##### Parameters
1579
+
1580
+ | Name | Type | Description | |
1581
+ | ---- | ---- | ----------- | -------- |
1582
+ | timezone | `IDTimezone` | The timezone object | &nbsp; |
1583
+ | model | `IModel` `IDataset` | The model info | &nbsp; |
1584
+
1585
+
1586
+
1587
+
1588
+ ##### Returns
1589
+
1590
+
1591
+ - `IDTimezoneOffset` the offset of the objects
1592
+
1593
+
1594
+
1595
+ #### getType(timezone, model, offset)
1596
+
1597
+ Gets the type of the timezone
1598
+ - Searchs the first argument
1599
+ - If it does not exist, asking for the timezone offset in order to prioritized the offset above all.
1600
+ - If the timezone is empty, in the model timezone is searched.
1601
+ - If it does not exist in any, a default one is set.
1602
+
1603
+
1604
+
1605
+
1606
+ ##### Parameters
1607
+
1608
+ | Name | Type | Description | |
1609
+ | ---- | ---- | ----------- | -------- |
1610
+ | timezone | `IDTimezone` | The timezone object | &nbsp; |
1611
+ | model | `IModel` `IDataset` | The model info | &nbsp; |
1612
+ | offset | `IDTimezoneOffset` | a default offset if the validation are not satisfied | &nbsp; |
1613
+
1614
+
1615
+
1616
+
1617
+ ##### Returns
1618
+
1619
+
1620
+ - `IDTimezoneType` the rigth type of the timezone
1621
+
1622
+
1623
+
1624
+ #### getTypeByOffset(offset)
1625
+
1626
+ Gets the type by a offset
1627
+ - For a offset=0 the type is default
1628
+ - For a offset="browser" the type is browser
1629
+ - For a valid offset different to previous ones, the type is fixed;
1630
+ - Anything else, it is considered default.
1631
+
1632
+
1633
+
1634
+
1635
+ ##### Parameters
1636
+
1637
+ | Name | Type | Description | |
1638
+ | ---- | ---- | ----------- | -------- |
1639
+ | offset | `IDTimezoneOffset` | a given offset | &nbsp; |
1640
+
1641
+
1642
+
1643
+
1644
+ ##### Returns
1645
+
1646
+
1647
+ - `IDTimezoneType` the right timezone type for the offset
1648
+
1649
+
1650
+
1651
+ #### getUTC(timezone)
1652
+
1653
+ Gets the UTC string by the timezone object
1654
+
1655
+
1656
+
1657
+
1658
+ ##### Parameters
1659
+
1660
+ | Name | Type | Description | |
1661
+ | ---- | ---- | ----------- | -------- |
1662
+ | timezone | `IDTimezone` | the timezone object | &nbsp; |
1663
+
1664
+
1665
+
1666
+
1667
+ ##### Returns
1668
+
1669
+
1670
+ - `string` the label of the UTC value
1671
+
1672
+
1673
+
1674
+
1675
+ ### dist/dates/helpers/getTimezoneOffsetByType.js
1676
+
1677
+
1678
+ #### getTimezoneOffsetByType(type, timezone)
1679
+
1680
+ Gets the timezone offset by the timezone type.
1681
+ For browser types, it is calculated by a Date instance
1682
+ Default types is UTC-0
1683
+ Undefined or Fixed types is gotten by the offset property
1684
+
1685
+
1686
+
1687
+
1688
+ ##### Parameters
1689
+
1690
+ | Name | Type | Description | |
1691
+ | ---- | ---- | ----------- | -------- |
1692
+ | type | `IDTimezoneType` | the timezone type | &nbsp; |
1693
+ | timezone | `IDTimezone` `IBTimezone` | the timezone object | &nbsp; |
1694
+
1695
+
1696
+
1697
+
1698
+ ##### Returns
1699
+
1700
+
1701
+ - `IDTimezoneOffset` the offset of the timezone
1702
+
1703
+
1704
+
1705
+
1706
+ ### dist/dates/helpers/getUTCFormatByOffset.js
1707
+
1708
+
1709
+ #### getUTCFormatByOffset(timezone)
1710
+
1711
+ Gets the UTC format dependeing on the given offset
1712
+
1713
+
1714
+
1715
+
1716
+ ##### Parameters
1717
+
1718
+ | Name | Type | Description | |
1719
+ | ---- | ---- | ----------- | -------- |
1720
+ | timezone | `IDTimezone` | the timezone object | &nbsp; |
1721
+
1722
+
1723
+
1724
+
1725
+ ##### Returns
1726
+
1727
+
1728
+ - `string` an string with the UTC format
1729
+
1730
+
1731
+
1732
+
1733
+ ### dist/dates/helpers/getWeek.js
1734
+
1735
+
1736
+ #### getWeek(date)
1737
+
1738
+ Gets the week number of the year
1739
+ Additionally, the month and the year
1740
+
1741
+
1742
+
1743
+
1744
+ ##### Parameters
1745
+
1746
+ | Name | Type | Description | |
1747
+ | ---- | ---- | ----------- | -------- |
1748
+ | date | `Date` | the date object | &nbsp; |
1749
+
1750
+
1751
+
1752
+
1753
+ ##### Returns
1754
+
1755
+
1756
+ - an object with the week, month and year or undefined if the date is not valid.
1757
+
1758
+
1759
+
1760
+
1761
+ ### dist/dates/helpers/isValidDateObject.js
1762
+
1763
+
1764
+ #### isValidDateObject(date)
1765
+
1766
+ If the date is a valid Date object, return true, otherwise return false.
1767
+
1768
+
1769
+
1770
+
1771
+ ##### Parameters
1772
+
1773
+ | Name | Type | Description | |
1774
+ | ---- | ---- | ----------- | -------- |
1775
+ | date | `Date` | - The date object to check. | &nbsp; |
1776
+
1777
+
1778
+
1779
+
1780
+ ##### Returns
1781
+
1782
+
1783
+ - A boolean value.
1784
+
1785
+
1786
+
1787
+
1788
+ ### dist/dates/helpers/isValidISOOffset.js
1789
+
1790
+
1791
+ #### isValidISOOffset(offset)
1792
+
1793
+ Validate if offset uses a valid ISO 8601 offset specification
1794
+ - If the given offset is a numeric, returns an invalid flag.
1795
+
1796
+
1797
+
1798
+
1799
+ ##### Parameters
1800
+
1801
+ | Name | Type | Description | |
1802
+ | ---- | ---- | ----------- | -------- |
1803
+ | offset | `string` | the timezone offset | &nbsp; |
1804
+
1805
+
1806
+
1807
+
1808
+ ##### Returns
1809
+
1810
+
1811
+ - `boolean` true if the given offset is valid
1812
+
1813
+
1814
+
1815
+
1816
+ ### dist/dates/helpers/isValidPotentialDate.js
1817
+
1818
+
1819
+ #### isValidPotentialDate(date)
1820
+
1821
+ Checks if the given date is allowed to continue the process for adapting dates
1822
+ - If the string is a token or a combination of tokens is not valid
1432
1823
 
1433
1824
 
1434
1825
 
@@ -1437,8 +1828,7 @@ Replace '@now' token inside a string
1437
1828
 
1438
1829
  | Name | Type | Description | |
1439
1830
  | ---- | ---- | ----------- | -------- |
1440
- | value | `string` | | &nbsp; |
1441
- | now | `Date` | | &nbsp; |
1831
+ | date | `string` `Date` `number` | String, object or millisencond number of the date | &nbsp; |
1442
1832
 
1443
1833
 
1444
1834
 
@@ -1446,60 +1836,40 @@ Replace '@now' token inside a string
1446
1836
  ##### Returns
1447
1837
 
1448
1838
 
1449
- - `string`
1450
-
1451
-
1839
+ - true: the date is valid.
1452
1840
 
1453
- #### convertRelativeToAbsolute(args)
1454
1841
 
1455
- Returns a range object (date) from a group of statement params
1456
1842
 
1457
1843
 
1844
+ ### dist/filters/classes/FilterInputErrorHandler.js
1458
1845
 
1459
1846
 
1460
- ##### Parameters
1847
+ #### new FilterInputErrorHandler()
1461
1848
 
1462
- | Name | Type | Description | |
1463
- | ---- | ---- | ----------- | -------- |
1464
- | args | `RelativeToAbsoluteStruct` | | &nbsp; |
1465
1849
 
1466
1850
 
1467
1851
 
1468
1852
 
1469
- ##### Examples
1470
1853
 
1471
- ```javascript
1472
- pivot = '2021-03-03T12:30:40'
1473
- unit = month
1474
- steps = 2
1475
- setTo = END
1476
- resolverAsCalendar: true
1477
- => Returns '2021-05-31T23:59:59'
1478
- ```
1479
- ```javascript
1480
- pivot = '2021-03-03T12:30:40'
1481
- unit = month
1482
- steps = -2
1483
- setTo = START
1484
- resolverAsCalendar: false
1485
- => Returns '2021-01-03T00:00:00'
1486
- ```
1487
1854
 
1488
1855
 
1489
1856
  ##### Returns
1490
1857
 
1491
1858
 
1492
- - `string`
1859
+ - `Void`
1493
1860
 
1494
1861
 
1495
1862
 
1496
1863
 
1497
- ### dist/dates/relative/relative.js
1864
+ ### dist/dates/helpers/validateDate.js
1498
1865
 
1499
1866
 
1500
- #### resolveRelative(statements, clock)
1867
+ #### validateDate(date, format)
1501
1868
 
1502
- Resolve a list of relative statements according to operator
1869
+ Validate a string date depending on giving format
1870
+ - If the string is a token label, the function lets it pass.
1871
+ - Otherwise depends of the format
1872
+ - Some escenarios the string is a mix of token labels and dates
1503
1873
 
1504
1874
 
1505
1875
 
@@ -1508,34 +1878,16 @@ Resolve a list of relative statements according to operator
1508
1878
 
1509
1879
  | Name | Type | Description | |
1510
1880
  | ---- | ---- | ----------- | -------- |
1511
- | statements | `Array.<RelativeStatement>` `Array.<string>` | - Raw statements/values | &nbsp; |
1512
- | clock | `Date` | - Clock/time reference for relative date resolution | &nbsp; |
1513
-
1514
-
1515
-
1516
-
1517
- ##### Examples
1881
+ | date | | String of date | &nbsp; |
1882
+ | format | | String of the format to validate | &nbsp; |
1518
1883
 
1519
- ```javascript
1520
- Input:
1521
- {
1522
- "cursor": "the_next",
1523
- "unit": "year",
1524
- "number": 1,
1525
- "includeCurrent": false,
1526
- "isCalendarDate": false,
1527
- "anchor": "03/05/2021"
1528
- }
1529
1884
 
1530
- Output:
1531
- { gte: "03/06/2021 00:00:00", lte: "03/05/2022 23:59:59" }
1532
- ```
1533
1885
 
1534
1886
 
1535
1887
  ##### Returns
1536
1888
 
1537
1889
 
1538
- - `Array.&lt;AbsoluteRange&gt;` `Array.&lt;string&gt;`
1890
+ - True if it is valid or not. Undefined if date is undefined
1539
1891
 
1540
1892
 
1541
1893
 
@@ -2338,36 +2690,36 @@ Adapter for model answer to convert to recognizable values for Filter Builder
2338
2690
 
2339
2691
 
2340
2692
 
2341
- ### dist/filters/classes/FilterInputErrorHandler.js
2342
-
2693
+ ### dist/filters/helpers/OLD_getAggFilters.js
2343
2694
 
2344
- #### new FilterInputErrorHandler()
2345
2695
 
2696
+ #### getAggFilters(logics, summaries)
2346
2697
 
2347
2698
 
2348
2699
 
2349
2700
 
2350
2701
 
2351
2702
 
2703
+ ##### Parameters
2352
2704
 
2353
- ##### Returns
2705
+ | Name | Type | Description | |
2706
+ | ---- | ---- | ----------- | -------- |
2707
+ | logics | | | &nbsp; |
2708
+ | summaries | | | &nbsp; |
2354
2709
 
2355
2710
 
2356
- - `Void`
2357
2711
 
2358
2712
 
2713
+ ##### Returns
2359
2714
 
2360
2715
 
2361
- ### dist/format/duration/addDurationFormat.js
2716
+ - the filter aggregate structure
2362
2717
 
2363
2718
 
2364
- #### addDurationFormat(number, format[, locale, fractionDigits])
2365
2719
 
2366
- [TODO: The decimals dots are not working correctly, we need to reviewing (fractionDigits)]
2367
- "Convert a number of seconds to a human readable string."
2720
+ #### getAggregateFilters(logics, formatToFilters)
2368
2721
 
2369
- `addDurationFormat` is a function that takes a number, a format, an optional locale, and an optional
2370
- number of fraction digits, and returns a string
2722
+ Filters and gets the filters used for aggregate values.
2371
2723
 
2372
2724
 
2373
2725
 
@@ -2376,10 +2728,8 @@ number of fraction digits, and returns a string
2376
2728
 
2377
2729
  | Name | Type | Description | |
2378
2730
  | ---- | ---- | ----------- | -------- |
2379
- | number | `number` | - The number of milliseconds to format. | &nbsp; |
2380
- | format | `string` | - The format string. | &nbsp; |
2381
- | locale | `string` | - The locale to use for formatting. If not specified, the default locale is used. | *Optional* |
2382
- | fractionDigits | `number` | - The number of digits to show after the decimal point. | *Optional* |
2731
+ | logics | | The filter logic structure | &nbsp; |
2732
+ | formatToFilters | | Flag to change de way of returning the filter structure. | &nbsp; |
2383
2733
 
2384
2734
 
2385
2735
 
@@ -2387,34 +2737,46 @@ number of fraction digits, and returns a string
2387
2737
  ##### Returns
2388
2738
 
2389
2739
 
2390
- - A string
2740
+ - the aggregate filters in the IFilterFilters way or as logic structure.
2391
2741
 
2392
2742
 
2393
2743
 
2394
2744
 
2395
- ### dist/format/duration/durationFormatter.js
2745
+ ### dist/filters/helpers/applyHierarchyForAggFilters.js
2396
2746
 
2397
2747
 
2398
- #### setLocaleFormatter()
2748
+ #### applyHierarchyForAggFilters(chartSettings, scopes, currentScope)
2399
2749
 
2400
- It sets the locale formatter for the number.
2750
+ [TODO: Make a proper description for this function]
2401
2751
 
2402
2752
 
2403
2753
 
2404
2754
 
2755
+ ##### Parameters
2756
+
2757
+ | Name | Type | Description | |
2758
+ | ---- | ---- | ----------- | -------- |
2759
+ | chartSettings | | Chart Settings for the Filter Builder | &nbsp; |
2760
+ | scopes | | the pair id/label scopes | &nbsp; |
2761
+ | currentScope | | the scope to be validated | &nbsp; |
2762
+
2763
+
2405
2764
 
2406
2765
 
2407
2766
  ##### Returns
2408
2767
 
2409
2768
 
2410
- - `Void`
2769
+ - the chart settings
2411
2770
 
2412
2771
 
2413
2772
 
2414
- #### getNewNumberFormat(locale)
2415
2773
 
2416
- It returns a new instance of the Intl.NumberFormat class, which is a built-in JavaScript class
2417
- that formats numbers
2774
+ ### dist/filters/helpers/filtersTokensToString.js
2775
+
2776
+
2777
+ #### filtersTokensToString(tokens)
2778
+
2779
+ It takes an array of tokens and returns a string
2418
2780
 
2419
2781
 
2420
2782
 
@@ -2423,7 +2785,7 @@ that formats numbers
2423
2785
 
2424
2786
  | Name | Type | Description | |
2425
2787
  | ---- | ---- | ----------- | -------- |
2426
- | locale | `string` `Array.<string>` | - string | string[] | &nbsp; |
2788
+ | tokens | `Array.<IFFilterTokens>` | - IFFilterTokens[] - the tokens to convert to a string | &nbsp; |
2427
2789
 
2428
2790
 
2429
2791
 
@@ -2431,14 +2793,17 @@ that formats numbers
2431
2793
  ##### Returns
2432
2794
 
2433
2795
 
2434
- - A new instance of the Intl.NumberFormat class.
2796
+ - A string
2435
2797
 
2436
2798
 
2437
2799
 
2438
- #### setParts(template)
2439
2800
 
2440
- It takes a template string and sets the parts property to the result of calling the
2441
- parseFormatTemplate function with the template string as an argument
2801
+ ### dist/filters/helpers/getAggFiltersFromFilterData.js
2802
+
2803
+
2804
+ #### getAggFiltersFromFilterData(filterData, _summaries) *private method*
2805
+
2806
+
2442
2807
 
2443
2808
 
2444
2809
 
@@ -2447,7 +2812,8 @@ parseFormatTemplate function with the template string as an argument
2447
2812
 
2448
2813
  | Name | Type | Description | |
2449
2814
  | ---- | ---- | ----------- | -------- |
2450
- | template | `string` | - The format template string. | &nbsp; |
2815
+ | filterData | | | &nbsp; |
2816
+ | _summaries | | | &nbsp; |
2451
2817
 
2452
2818
 
2453
2819
 
@@ -2455,13 +2821,17 @@ parseFormatTemplate function with the template string as an argument
2455
2821
  ##### Returns
2456
2822
 
2457
2823
 
2458
- - `Void`
2824
+ - the aggFilters structure
2459
2825
 
2460
2826
 
2461
2827
 
2462
- #### matchFormatsReplace(template)
2463
2828
 
2464
- It replaces the H and D characters in the template with h and d respectively
2829
+ ### dist/filters/helpers/getAvailableScopes.js
2830
+
2831
+
2832
+ #### getAvailableScopes(config)
2833
+
2834
+ Gets Scopes/Scope IDs by given IDs
2465
2835
 
2466
2836
 
2467
2837
 
@@ -2470,7 +2840,7 @@ It replaces the H and D characters in the template with h and d respectively
2470
2840
 
2471
2841
  | Name | Type | Description | |
2472
2842
  | ---- | ---- | ----------- | -------- |
2473
- | template | `string` | - The template string to be used for the date format. | &nbsp; |
2843
+ | config | | given Differnts IDs in order set a available scope | &nbsp; |
2474
2844
 
2475
2845
 
2476
2846
 
@@ -2478,15 +2848,27 @@ It replaces the H and D characters in the template with h and d respectively
2478
2848
  ##### Returns
2479
2849
 
2480
2850
 
2481
- - The template string with all instances of H replaced with h and all instances of D replaced with d.
2851
+ - a Scopes/Scope IDs array
2482
2852
 
2483
2853
 
2484
2854
 
2485
- #### setNumberFactor()
2486
2855
 
2487
- It sets the numberFactor to the value of the duration part that matches the unit.
2856
+ ### dist/filters/helpers/getScopesByHierarchy.js
2857
+
2858
+
2859
+ #### getScopesByHierarchy(scopes, currentScope)
2860
+
2861
+ [TODO: Make a description for this]
2862
+
2863
+
2488
2864
 
2489
2865
 
2866
+ ##### Parameters
2867
+
2868
+ | Name | Type | Description | |
2869
+ | ---- | ---- | ----------- | -------- |
2870
+ | scopes | | the collection of Scopes/Scope IDs | &nbsp; |
2871
+ | currentScope | | Current scope type | &nbsp; |
2490
2872
 
2491
2873
 
2492
2874
 
@@ -2494,14 +2876,17 @@ It sets the numberFactor to the value of the duration part that matches the unit
2494
2876
  ##### Returns
2495
2877
 
2496
2878
 
2497
- - `Void`
2879
+ - A new array of Scopes/Scope IDs
2498
2880
 
2499
2881
 
2500
2882
 
2501
- #### parseFormatTemplate(template)
2502
2883
 
2503
- It takes a string, splits it into an array of strings, then maps each string to a config object,
2504
- then filters out any falsy values, then reverses the array
2884
+ ### dist/filters/helpers/getAvailableScopesIDsByConfig.js
2885
+
2886
+
2887
+ #### getAvailableScopesIDsByConfig(config)
2888
+
2889
+ Gets the Scopes IDS for the Available Scope function by any config
2505
2890
 
2506
2891
 
2507
2892
 
@@ -2510,7 +2895,7 @@ then filters out any falsy values, then reverses the array
2510
2895
 
2511
2896
  | Name | Type | Description | |
2512
2897
  | ---- | ---- | ----------- | -------- |
2513
- | template | `string` | - string - the template string that we want to parse | &nbsp; |
2898
+ | config | | any config | &nbsp; |
2514
2899
 
2515
2900
 
2516
2901
 
@@ -2518,14 +2903,17 @@ then filters out any falsy values, then reverses the array
2518
2903
  ##### Returns
2519
2904
 
2520
2905
 
2521
- - An array of objects that have the order and the name of the part of the duration.
2906
+ - a Available Scope IDS config
2522
2907
 
2523
2908
 
2524
2909
 
2525
- #### format(number)
2526
2910
 
2527
- It takes a number, multiplies it by a factor, then uses the parts array to calculate the number
2528
- of each part in the number, then uses the template to format the number
2911
+ ### dist/filters/helpers/getTokensFromFilters.js
2912
+
2913
+
2914
+ #### getTokensFromFilters(filters, options)
2915
+
2916
+ It takes a filter object and returns an array of tokens that represent the filter
2529
2917
 
2530
2918
 
2531
2919
 
@@ -2534,7 +2922,8 @@ of each part in the number, then uses the template to format the number
2534
2922
 
2535
2923
  | Name | Type | Description | |
2536
2924
  | ---- | ---- | ----------- | -------- |
2537
- | number | `number` | - The number of milliseconds to format. | &nbsp; |
2925
+ | filters | `IFUData` | - The filters object. | &nbsp; |
2926
+ | options | `IFTokensFromFiltersSettings` | - IFTokensFromFiltersSettings | &nbsp; |
2538
2927
 
2539
2928
 
2540
2929
 
@@ -2542,13 +2931,17 @@ of each part in the number, then uses the template to format the number
2542
2931
  ##### Returns
2543
2932
 
2544
2933
 
2545
- - The template string with the values replaced.
2934
+ - `Array.&lt;IFFilterTokens&gt;` An array of tokens that represents the filters object
2546
2935
 
2547
2936
 
2548
2937
 
2549
- #### formatValue(parts, part)
2550
2938
 
2551
- It takes a dictionary of values and a list of keys, and returns a formatted string
2939
+ ### dist/filters/helpers/getVerboseFilter.js
2940
+
2941
+
2942
+ #### getVerboseFilter(filters, options)
2943
+
2944
+ It takes a set of filters and returns a string that describes the filters
2552
2945
 
2553
2946
 
2554
2947
 
@@ -2557,8 +2950,8 @@ It takes a dictionary of values and a list of keys, and returns a formatted stri
2557
2950
 
2558
2951
  | Name | Type | Description | |
2559
2952
  | ---- | ---- | ----------- | -------- |
2560
- | parts | | - { [x: string]: any; } | &nbsp; |
2561
- | part | `string` `Array.<string|number>` | - This is the part of the date that we're formatting. | &nbsp; |
2953
+ | filters | `IFUData` | - The filters object that you want to convert to a string. | &nbsp; |
2954
+ | options | `IFTokensFromFiltersSettings` | - IFTokensFromFiltersSettings | &nbsp; |
2562
2955
 
2563
2956
 
2564
2957
 
@@ -2566,7 +2959,7 @@ It takes a dictionary of values and a list of keys, and returns a formatted stri
2566
2959
  ##### Returns
2567
2960
 
2568
2961
 
2569
- - The value of the part of the date that is being formatted.
2962
+ - A string
2570
2963
 
2571
2964
 
2572
2965
 
@@ -2811,6 +3204,30 @@ Gets the filters from the chart settings
2811
3204
 
2812
3205
 
2813
3206
 
3207
+ #### _getResponse(records)
3208
+
3209
+ Tranform response in array of object with value key
3210
+ Null or undefined values are avoided
3211
+
3212
+
3213
+
3214
+
3215
+ ##### Parameters
3216
+
3217
+ | Name | Type | Description | |
3218
+ | ---- | ---- | ----------- | -------- |
3219
+ | records | | The data from preview response | &nbsp; |
3220
+
3221
+
3222
+
3223
+
3224
+ ##### Returns
3225
+
3226
+
3227
+ - the sumaries
3228
+
3229
+
3230
+
2814
3231
  #### UChartApi._getPreviewRequestBody(uFilter, filterLogic, chartSettings)
2815
3232
 
2816
3233
  Gets request body structure
@@ -3137,13 +3554,36 @@ Sets the Filter Builder Filter
3137
3554
  ##### Returns
3138
3555
 
3139
3556
 
3140
- - `Void`
3557
+ - `Void`
3558
+
3559
+
3560
+
3561
+ #### _getSearchLogic(uFilter)
3562
+
3563
+ Gets the filter object structure for the searching text
3564
+
3565
+
3566
+
3567
+
3568
+ ##### Parameters
3569
+
3570
+ | Name | Type | Description | |
3571
+ | ---- | ---- | ----------- | -------- |
3572
+ | uFilter | `IFUFlattenedFilter` | The filter object | &nbsp; |
3573
+
3574
+
3575
+
3576
+
3577
+ ##### Returns
3578
+
3579
+
3580
+ - the filter object structure
3141
3581
 
3142
3582
 
3143
3583
 
3144
- #### _getSearchLogic(uFilter)
3584
+ #### _getFilterCharts(uFilter, searchLogic, chartSettings)
3145
3585
 
3146
- Gets the filter object structure for the searching text
3586
+ Gets the filters from the chart settings
3147
3587
 
3148
3588
 
3149
3589
 
@@ -3153,6 +3593,8 @@ Gets the filter object structure for the searching text
3153
3593
  | Name | Type | Description | |
3154
3594
  | ---- | ---- | ----------- | -------- |
3155
3595
  | uFilter | `IFUFlattenedFilter` | The filter object | &nbsp; |
3596
+ | searchLogic | `OLD_IFilterData` | Additional filter object for the searching text | &nbsp; |
3597
+ | chartSettings | `IFUChartSettings` | The settings of the chart. For Aggregate Columns. | &nbsp; |
3156
3598
 
3157
3599
 
3158
3600
 
@@ -3160,13 +3602,14 @@ Gets the filter object structure for the searching text
3160
3602
  ##### Returns
3161
3603
 
3162
3604
 
3163
- - the filter object structure
3605
+ - the filters from the chart settings
3164
3606
 
3165
3607
 
3166
3608
 
3167
- #### _getFilterCharts(uFilter, searchLogic, chartSettings)
3609
+ #### _getResponse(records)
3168
3610
 
3169
- Gets the filters from the chart settings
3611
+ Tranform response in array of object with value key
3612
+ Null or undefined values are avoided
3170
3613
 
3171
3614
 
3172
3615
 
@@ -3175,9 +3618,7 @@ Gets the filters from the chart settings
3175
3618
 
3176
3619
  | Name | Type | Description | |
3177
3620
  | ---- | ---- | ----------- | -------- |
3178
- | uFilter | `IFUFlattenedFilter` | The filter object | &nbsp; |
3179
- | searchLogic | `OLD_IFilterData` | Additional filter object for the searching text | &nbsp; |
3180
- | chartSettings | `IFUChartSettings` | The settings of the chart. For Aggregate Columns. | &nbsp; |
3621
+ | records | | The data from preview response | &nbsp; |
3181
3622
 
3182
3623
 
3183
3624
 
@@ -3185,7 +3626,7 @@ Gets the filters from the chart settings
3185
3626
  ##### Returns
3186
3627
 
3187
3628
 
3188
- - the filters from the chart settings
3629
+ - the sumaries
3189
3630
 
3190
3631
 
3191
3632
 
@@ -3427,36 +3868,16 @@ Checks if two filter columns are the same.
3427
3868
 
3428
3869
 
3429
3870
 
3430
- ### dist/filters/helpers/OLD_getAggFilters.js
3431
-
3432
-
3433
- #### getAggFilters(logics, summaries)
3434
-
3435
-
3436
-
3437
-
3438
-
3439
-
3440
- ##### Parameters
3441
-
3442
- | Name | Type | Description | |
3443
- | ---- | ---- | ----------- | -------- |
3444
- | logics | | | &nbsp; |
3445
- | summaries | | | &nbsp; |
3446
-
3447
-
3448
-
3449
-
3450
- ##### Returns
3451
-
3452
-
3453
- - the filter aggregate structure
3871
+ ### dist/format/duration/addDurationFormat.js
3454
3872
 
3455
3873
 
3874
+ #### addDurationFormat(number, format[, locale, fractionDigits])
3456
3875
 
3457
- #### getAggregateFilters(logics, formatToFilters)
3876
+ [TODO: The decimals dots are not working correctly, we need to reviewing (fractionDigits)]
3877
+ "Convert a number of seconds to a human readable string."
3458
3878
 
3459
- Filters and gets the filters used for aggregate values.
3879
+ `addDurationFormat` is a function that takes a number, a format, an optional locale, and an optional
3880
+ number of fraction digits, and returns a string
3460
3881
 
3461
3882
 
3462
3883
 
@@ -3465,8 +3886,10 @@ Filters and gets the filters used for aggregate values.
3465
3886
 
3466
3887
  | Name | Type | Description | |
3467
3888
  | ---- | ---- | ----------- | -------- |
3468
- | logics | | The filter logic structure | &nbsp; |
3469
- | formatToFilters | | Flag to change de way of returning the filter structure. | &nbsp; |
3889
+ | number | `number` | - The number of milliseconds to format. | &nbsp; |
3890
+ | format | `string` | - The format string. | &nbsp; |
3891
+ | locale | `string` | - The locale to use for formatting. If not specified, the default locale is used. | *Optional* |
3892
+ | fractionDigits | `number` | - The number of digits to show after the decimal point. | *Optional* |
3470
3893
 
3471
3894
 
3472
3895
 
@@ -3474,28 +3897,19 @@ Filters and gets the filters used for aggregate values.
3474
3897
  ##### Returns
3475
3898
 
3476
3899
 
3477
- - the aggregate filters in the IFilterFilters way or as logic structure.
3478
-
3479
-
3480
-
3900
+ - A string
3481
3901
 
3482
- ### dist/filters/helpers/applyHierarchyForAggFilters.js
3483
3902
 
3484
3903
 
3485
- #### applyHierarchyForAggFilters(chartSettings, scopes, currentScope)
3486
3904
 
3487
- [TODO: Make a proper description for this function]
3905
+ ### dist/format/duration/durationFormatter.js
3488
3906
 
3489
3907
 
3908
+ #### setLocaleFormatter()
3490
3909
 
3910
+ It sets the locale formatter for the number.
3491
3911
 
3492
- ##### Parameters
3493
3912
 
3494
- | Name | Type | Description | |
3495
- | ---- | ---- | ----------- | -------- |
3496
- | chartSettings | | Chart Settings for the Filter Builder | &nbsp; |
3497
- | scopes | | the pair id/label scopes | &nbsp; |
3498
- | currentScope | | the scope to be validated | &nbsp; |
3499
3913
 
3500
3914
 
3501
3915
 
@@ -3503,17 +3917,14 @@ Filters and gets the filters used for aggregate values.
3503
3917
  ##### Returns
3504
3918
 
3505
3919
 
3506
- - the chart settings
3507
-
3508
-
3509
-
3920
+ - `Void`
3510
3921
 
3511
- ### dist/filters/helpers/filtersTokensToString.js
3512
3922
 
3513
3923
 
3514
- #### filtersTokensToString(tokens)
3924
+ #### getNewNumberFormat(locale)
3515
3925
 
3516
- It takes an array of tokens and returns a string
3926
+ It returns a new instance of the Intl.NumberFormat class, which is a built-in JavaScript class
3927
+ that formats numbers
3517
3928
 
3518
3929
 
3519
3930
 
@@ -3522,7 +3933,7 @@ It takes an array of tokens and returns a string
3522
3933
 
3523
3934
  | Name | Type | Description | |
3524
3935
  | ---- | ---- | ----------- | -------- |
3525
- | tokens | `Array.<IFFilterTokens>` | - IFFilterTokens[] - the tokens to convert to a string | &nbsp; |
3936
+ | locale | `string` `Array.<string>` | - string | string[] | &nbsp; |
3526
3937
 
3527
3938
 
3528
3939
 
@@ -3530,17 +3941,14 @@ It takes an array of tokens and returns a string
3530
3941
  ##### Returns
3531
3942
 
3532
3943
 
3533
- - A string
3534
-
3535
-
3536
-
3537
-
3538
- ### dist/filters/helpers/getAggFiltersFromFilterData.js
3944
+ - A new instance of the Intl.NumberFormat class.
3539
3945
 
3540
3946
 
3541
- #### getAggFiltersFromFilterData(filterData, _summaries) *private method*
3542
3947
 
3948
+ #### setParts(template)
3543
3949
 
3950
+ It takes a template string and sets the parts property to the result of calling the
3951
+ parseFormatTemplate function with the template string as an argument
3544
3952
 
3545
3953
 
3546
3954
 
@@ -3549,8 +3957,7 @@ It takes an array of tokens and returns a string
3549
3957
 
3550
3958
  | Name | Type | Description | |
3551
3959
  | ---- | ---- | ----------- | -------- |
3552
- | filterData | | | &nbsp; |
3553
- | _summaries | | | &nbsp; |
3960
+ | template | `string` | - The format template string. | &nbsp; |
3554
3961
 
3555
3962
 
3556
3963
 
@@ -3558,17 +3965,13 @@ It takes an array of tokens and returns a string
3558
3965
  ##### Returns
3559
3966
 
3560
3967
 
3561
- - the aggFilters structure
3562
-
3563
-
3564
-
3968
+ - `Void`
3565
3969
 
3566
- ### dist/filters/helpers/getAvailableScopes.js
3567
3970
 
3568
3971
 
3569
- #### getAvailableScopes(config)
3972
+ #### matchFormatsReplace(template)
3570
3973
 
3571
- Gets Scopes/Scope IDs by given IDs
3974
+ It replaces the H and D characters in the template with h and d respectively
3572
3975
 
3573
3976
 
3574
3977
 
@@ -3577,7 +3980,7 @@ Gets Scopes/Scope IDs by given IDs
3577
3980
 
3578
3981
  | Name | Type | Description | |
3579
3982
  | ---- | ---- | ----------- | -------- |
3580
- | config | | given Differnts IDs in order set a available scope | &nbsp; |
3983
+ | template | `string` | - The template string to be used for the date format. | &nbsp; |
3581
3984
 
3582
3985
 
3583
3986
 
@@ -3585,26 +3988,15 @@ Gets Scopes/Scope IDs by given IDs
3585
3988
  ##### Returns
3586
3989
 
3587
3990
 
3588
- - a Scopes/Scope IDs array
3589
-
3590
-
3591
-
3592
-
3593
- ### dist/filters/helpers/getAvailableScopesIDsByConfig.js
3594
-
3595
-
3596
- #### getAvailableScopesIDsByConfig(config)
3991
+ - The template string with all instances of H replaced with h and all instances of D replaced with d.
3597
3992
 
3598
- Gets the Scopes IDS for the Available Scope function by any config
3599
3993
 
3600
3994
 
3995
+ #### setNumberFactor()
3601
3996
 
3997
+ It sets the numberFactor to the value of the duration part that matches the unit.
3602
3998
 
3603
- ##### Parameters
3604
3999
 
3605
- | Name | Type | Description | |
3606
- | ---- | ---- | ----------- | -------- |
3607
- | config | | any config | &nbsp; |
3608
4000
 
3609
4001
 
3610
4002
 
@@ -3612,17 +4004,14 @@ Gets the Scopes IDS for the Available Scope function by any config
3612
4004
  ##### Returns
3613
4005
 
3614
4006
 
3615
- - a Available Scope IDS config
3616
-
3617
-
3618
-
4007
+ - `Void`
3619
4008
 
3620
- ### dist/filters/helpers/getScopesByHierarchy.js
3621
4009
 
3622
4010
 
3623
- #### getScopesByHierarchy(scopes, currentScope)
4011
+ #### parseFormatTemplate(template)
3624
4012
 
3625
- [TODO: Make a description for this]
4013
+ It takes a string, splits it into an array of strings, then maps each string to a config object,
4014
+ then filters out any falsy values, then reverses the array
3626
4015
 
3627
4016
 
3628
4017
 
@@ -3631,8 +4020,7 @@ Gets the Scopes IDS for the Available Scope function by any config
3631
4020
 
3632
4021
  | Name | Type | Description | |
3633
4022
  | ---- | ---- | ----------- | -------- |
3634
- | scopes | | the collection of Scopes/Scope IDs | &nbsp; |
3635
- | currentScope | | Current scope type | &nbsp; |
4023
+ | template | `string` | - string - the template string that we want to parse | &nbsp; |
3636
4024
 
3637
4025
 
3638
4026
 
@@ -3640,17 +4028,14 @@ Gets the Scopes IDS for the Available Scope function by any config
3640
4028
  ##### Returns
3641
4029
 
3642
4030
 
3643
- - A new array of Scopes/Scope IDs
3644
-
3645
-
3646
-
4031
+ - An array of objects that have the order and the name of the part of the duration.
3647
4032
 
3648
- ### dist/filters/helpers/getTokensFromFilters.js
3649
4033
 
3650
4034
 
3651
- #### getTokensFromFilters(filters, options)
4035
+ #### format(number)
3652
4036
 
3653
- It takes a filter object and returns an array of tokens that represent the filter
4037
+ It takes a number, multiplies it by a factor, then uses the parts array to calculate the number
4038
+ of each part in the number, then uses the template to format the number
3654
4039
 
3655
4040
 
3656
4041
 
@@ -3659,8 +4044,7 @@ It takes a filter object and returns an array of tokens that represent the filte
3659
4044
 
3660
4045
  | Name | Type | Description | |
3661
4046
  | ---- | ---- | ----------- | -------- |
3662
- | filters | `IFUData` | - The filters object. | &nbsp; |
3663
- | options | `IFTokensFromFiltersSettings` | - IFTokensFromFiltersSettings | &nbsp; |
4047
+ | number | `number` | - The number of milliseconds to format. | &nbsp; |
3664
4048
 
3665
4049
 
3666
4050
 
@@ -3668,17 +4052,13 @@ It takes a filter object and returns an array of tokens that represent the filte
3668
4052
  ##### Returns
3669
4053
 
3670
4054
 
3671
- - `Array.&lt;IFFilterTokens&gt;` An array of tokens that represents the filters object
3672
-
3673
-
3674
-
4055
+ - The template string with the values replaced.
3675
4056
 
3676
- ### dist/filters/helpers/getVerboseFilter.js
3677
4057
 
3678
4058
 
3679
- #### getVerboseFilter(filters, options)
4059
+ #### formatValue(parts, part)
3680
4060
 
3681
- It takes a set of filters and returns a string that describes the filters
4061
+ It takes a dictionary of values and a list of keys, and returns a formatted string
3682
4062
 
3683
4063
 
3684
4064
 
@@ -3687,8 +4067,8 @@ It takes a set of filters and returns a string that describes the filters
3687
4067
 
3688
4068
  | Name | Type | Description | |
3689
4069
  | ---- | ---- | ----------- | -------- |
3690
- | filters | `IFUData` | - The filters object that you want to convert to a string. | &nbsp; |
3691
- | options | `IFTokensFromFiltersSettings` | - IFTokensFromFiltersSettings | &nbsp; |
4070
+ | parts | | - { [x: string]: any; } | &nbsp; |
4071
+ | part | `string` `Array.<string|number>` | - This is the part of the date that we're formatting. | &nbsp; |
3692
4072
 
3693
4073
 
3694
4074
 
@@ -3696,7 +4076,7 @@ It takes a set of filters and returns a string that describes the filters
3696
4076
  ##### Returns
3697
4077
 
3698
4078
 
3699
- - A string
4079
+ - The value of the part of the date that is being formatted.
3700
4080
 
3701
4081
 
3702
4082
 
@@ -3822,12 +4202,95 @@ Filters a nested tree array by a custom condition on the last child node
3822
4202
 
3823
4203
 
3824
4204
 
3825
- ### dist/general/array/flattenDeep.js
4205
+ ### dist/general/array/flattenDeep.js
4206
+
4207
+
4208
+ #### flattenDeep(arr)
4209
+
4210
+ Flat deeply an array
4211
+
4212
+
4213
+
4214
+
4215
+ ##### Parameters
4216
+
4217
+ | Name | Type | Description | |
4218
+ | ---- | ---- | ----------- | -------- |
4219
+ | arr | | Array to flat deeply | &nbsp; |
4220
+
4221
+
4222
+
4223
+
4224
+ ##### Returns
4225
+
4226
+
4227
+ - flatten array
4228
+
4229
+
4230
+
4231
+
4232
+ ### dist/general/array/getArrayByProperty.js
4233
+
4234
+
4235
+ #### getArrayByProperty(arr, property)
4236
+
4237
+ Gets a collection of object values by the given property
4238
+
4239
+
4240
+
4241
+
4242
+ ##### Parameters
4243
+
4244
+ | Name | Type | Description | |
4245
+ | ---- | ---- | ----------- | -------- |
4246
+ | arr | | An array | &nbsp; |
4247
+ | property | | the property to get the value collection | &nbsp; |
4248
+
4249
+
4250
+
4251
+
4252
+ ##### Returns
4253
+
4254
+
4255
+ - a collection of values by property
4256
+
4257
+
4258
+
4259
+
4260
+ ### dist/general/array/getFirstIndexFromArray.js
4261
+
4262
+
4263
+ #### getFirstIndexFromArray(array, callback)
4264
+
4265
+ Gets the first index from the array by a callback condition
4266
+
4267
+
4268
+
4269
+
4270
+ ##### Parameters
4271
+
4272
+ | Name | Type | Description | |
4273
+ | ---- | ---- | ----------- | -------- |
4274
+ | array | | | &nbsp; |
4275
+ | callback | | function callback | &nbsp; |
4276
+
4277
+
4278
+
4279
+
4280
+ ##### Returns
4281
+
4282
+
4283
+ - the first index of the array. -1 when the condition is not satisfied
4284
+
4285
+
4286
+
4287
+
4288
+ ### dist/general/array/getLastIndexFromArray.js
3826
4289
 
3827
4290
 
3828
- #### flattenDeep(arr)
4291
+ #### getLastIndexFromArray(array, callback)
3829
4292
 
3830
- Flat deeply an array
4293
+ Gets the last index from the array by a callback condition
3831
4294
 
3832
4295
 
3833
4296
 
@@ -3836,7 +4299,8 @@ Flat deeply an array
3836
4299
 
3837
4300
  | Name | Type | Description | |
3838
4301
  | ---- | ---- | ----------- | -------- |
3839
- | arr | | Array to flat deeply | &nbsp; |
4302
+ | array | | | &nbsp; |
4303
+ | callback | | function callback | &nbsp; |
3840
4304
 
3841
4305
 
3842
4306
 
@@ -3844,17 +4308,19 @@ Flat deeply an array
3844
4308
  ##### Returns
3845
4309
 
3846
4310
 
3847
- - flatten array
4311
+ - the last index of the array. -1 when the condition is not satisfied
3848
4312
 
3849
4313
 
3850
4314
 
3851
4315
 
3852
- ### dist/general/array/getArrayByProperty.js
4316
+ ### dist/general/array/getUniqueArray.js
3853
4317
 
3854
4318
 
3855
- #### getArrayByProperty(arr, property)
4319
+ #### getUniqueArray(arr, prop)
3856
4320
 
3857
- Gets a collection of object values by the given property
4321
+ Remove duplicated items from a given array by property name
4322
+ // 1. Store the keys of the unique objects
4323
+ // 2. Eliminate the dead keys & store unique objects
3858
4324
 
3859
4325
 
3860
4326
 
@@ -3863,8 +4329,8 @@ Gets a collection of object values by the given property
3863
4329
 
3864
4330
  | Name | Type | Description | |
3865
4331
  | ---- | ---- | ----------- | -------- |
3866
- | arr | | An array | &nbsp; |
3867
- | property | | the property to get the value collection | &nbsp; |
4332
+ | arr | | The array | &nbsp; |
4333
+ | prop | | Property name to search duplicated values | &nbsp; |
3868
4334
 
3869
4335
 
3870
4336
 
@@ -3872,17 +4338,17 @@ Gets a collection of object values by the given property
3872
4338
  ##### Returns
3873
4339
 
3874
4340
 
3875
- - a collection of values by property
4341
+ - Array without duplicated items.
3876
4342
 
3877
4343
 
3878
4344
 
3879
4345
 
3880
- ### dist/general/array/getFirstIndexFromArray.js
4346
+ ### dist/general/numeric/getSign.js
3881
4347
 
3882
4348
 
3883
- #### getFirstIndexFromArray(array, callback)
4349
+ #### getSign(num)
3884
4350
 
3885
- Gets the first index from the array by a callback condition
4351
+ Gets the numeric sign of a given number
3886
4352
 
3887
4353
 
3888
4354
 
@@ -3891,8 +4357,7 @@ Gets the first index from the array by a callback condition
3891
4357
 
3892
4358
  | Name | Type | Description | |
3893
4359
  | ---- | ---- | ----------- | -------- |
3894
- | array | | | &nbsp; |
3895
- | callback | | function callback | &nbsp; |
4360
+ | num | `number` | the number | &nbsp; |
3896
4361
 
3897
4362
 
3898
4363
 
@@ -3900,17 +4365,17 @@ Gets the first index from the array by a callback condition
3900
4365
  ##### Returns
3901
4366
 
3902
4367
 
3903
- - the first index of the array. -1 when the condition is not satisfied
4368
+ - `string` an string with the sign
3904
4369
 
3905
4370
 
3906
4371
 
3907
4372
 
3908
- ### dist/general/array/getLastIndexFromArray.js
4373
+ ### dist/general/function/debounce.js
3909
4374
 
3910
4375
 
3911
- #### getLastIndexFromArray(array, callback)
4376
+ #### debounce(fn, time)
3912
4377
 
3913
- Gets the last index from the array by a callback condition
4378
+ Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last time the debounced function was invoked.
3914
4379
 
3915
4380
 
3916
4381
 
@@ -3919,8 +4384,8 @@ Gets the last index from the array by a callback condition
3919
4384
 
3920
4385
  | Name | Type | Description | |
3921
4386
  | ---- | ---- | ----------- | -------- |
3922
- | array | | | &nbsp; |
3923
- | callback | | function callback | &nbsp; |
4387
+ | fn | `Function` | original Function | &nbsp; |
4388
+ | time | `Number` | default 500ms | &nbsp; |
3924
4389
 
3925
4390
 
3926
4391
 
@@ -3928,19 +4393,17 @@ Gets the last index from the array by a callback condition
3928
4393
  ##### Returns
3929
4394
 
3930
4395
 
3931
- - the last index of the array. -1 when the condition is not satisfied
4396
+ - `Function` debounced functions
3932
4397
 
3933
4398
 
3934
4399
 
3935
4400
 
3936
- ### dist/general/array/getUniqueArray.js
4401
+ ### dist/general/function/throttled.js
3937
4402
 
3938
4403
 
3939
- #### getUniqueArray(arr, prop)
4404
+ #### throttled(fn, time)
3940
4405
 
3941
- Remove duplicated items from a given array by property name
3942
- // 1. Store the keys of the unique objects
3943
- // 2. Eliminate the dead keys & store unique objects
4406
+ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
3944
4407
 
3945
4408
 
3946
4409
 
@@ -3949,8 +4412,8 @@ Remove duplicated items from a given array by property name
3949
4412
 
3950
4413
  | Name | Type | Description | |
3951
4414
  | ---- | ---- | ----------- | -------- |
3952
- | arr | | The array | &nbsp; |
3953
- | prop | | Property name to search duplicated values | &nbsp; |
4415
+ | fn | `Function` | original Function | &nbsp; |
4416
+ | time | `Number` | default 500ms | &nbsp; |
3954
4417
 
3955
4418
 
3956
4419
 
@@ -3958,7 +4421,7 @@ Remove duplicated items from a given array by property name
3958
4421
  ##### Returns
3959
4422
 
3960
4423
 
3961
- - Array without duplicated items.
4424
+ - `Function` throttled function
3962
4425
 
3963
4426
 
3964
4427
 
@@ -4146,6 +4609,7 @@ Conditions:
4146
4609
  Special case for isNaN
4147
4610
  - The isNaN('') is considered as false statement. The empty string is converted to 0 which is not NaN.
4148
4611
  - Boolean variables is considered as false statement.
4612
+ - Date objects is considered as true.
4149
4613
 
4150
4614
 
4151
4615
 
@@ -4195,6 +4659,35 @@ useful to avoid falsify validating Number Zero (0)
4195
4659
 
4196
4660
 
4197
4661
 
4662
+ ### dist/general/mix/size.js
4663
+
4664
+
4665
+ #### size(obj)
4666
+
4667
+ Gets the length of the given array.
4668
+ - Useful for Object, Array and string type.
4669
+ - For `null` or `undefined` or else argument the returned value will be 0.
4670
+
4671
+
4672
+
4673
+
4674
+ ##### Parameters
4675
+
4676
+ | Name | Type | Description | |
4677
+ | ---- | ---- | ----------- | -------- |
4678
+ | obj | `Any` | Any object-type variable | &nbsp; |
4679
+
4680
+
4681
+
4682
+
4683
+ ##### Returns
4684
+
4685
+
4686
+ - `Number` the size of the given variable
4687
+
4688
+
4689
+
4690
+
4198
4691
  ### dist/general/mix/randomId.js
4199
4692
 
4200
4693
 
@@ -4225,14 +4718,12 @@ Creates a random string
4225
4718
 
4226
4719
 
4227
4720
 
4228
- ### dist/general/mix/size.js
4721
+ ### dist/general/object/applyTimezoneDeep.js
4229
4722
 
4230
4723
 
4231
- #### size(obj)
4724
+ #### applyTimezoneDeep(obj, timezone)
4232
4725
 
4233
- Gets the length of the given array.
4234
- - Useful for Object, Array and string type.
4235
- - For `null` or `undefined` or else argument the returned value will be 0.
4726
+ Transforms the date+times propertiesof the given object by the Timezone object
4236
4727
 
4237
4728
 
4238
4729
 
@@ -4241,7 +4732,8 @@ Gets the length of the given array.
4241
4732
 
4242
4733
  | Name | Type | Description | |
4243
4734
  | ---- | ---- | ----------- | -------- |
4244
- | obj | `Any` | Any object-type variable | &nbsp; |
4735
+ | obj | `any` | the object | &nbsp; |
4736
+ | timezone | `IDTimezone` | the timezone object | &nbsp; |
4245
4737
 
4246
4738
 
4247
4739
 
@@ -4249,7 +4741,7 @@ Gets the length of the given array.
4249
4741
  ##### Returns
4250
4742
 
4251
4743
 
4252
- - `Number` the size of the given variable
4744
+ - `IFSData` `IFUData` the new filter data with the transformed datetime values
4253
4745
 
4254
4746
 
4255
4747
 
@@ -4720,12 +5212,12 @@ Upper case the first letter of a given text
4720
5212
 
4721
5213
 
4722
5214
 
4723
- ### dist/general/function/debounce.js
5215
+ ### dist/general/string/padLeadingZeros.js
4724
5216
 
4725
5217
 
4726
- #### debounce(fn, time)
5218
+ #### padLeadingZeros(num, size, padding)
4727
5219
 
4728
- Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last time the debounced function was invoked.
5220
+ Sets an amount of zeros as prefix of the given number by its length
4729
5221
 
4730
5222
 
4731
5223
 
@@ -4734,26 +5226,75 @@ Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last
4734
5226
 
4735
5227
  | Name | Type | Description | |
4736
5228
  | ---- | ---- | ----------- | -------- |
4737
- | fn | `Function` | original Function | &nbsp; |
4738
- | time | `Number` | default 500ms | &nbsp; |
5229
+ | num | `number` `string` | the number | &nbsp; |
5230
+ | size | `number` | the quantity of zeros to add | &nbsp; |
5231
+ | padding | `number` | True: to pad with missing zeros; depending on the num length. False: to fill zeros by the amount. | &nbsp; |
5232
+
4739
5233
 
4740
5234
 
4741
5235
 
5236
+ ##### Examples
5237
+
5238
+ ```javascript
5239
+ num = 100
5240
+ size = 2
5241
+ padding = true
5242
+ => Returns "100"
5243
+ ```
5244
+ ```javascript
5245
+ num = 100
5246
+ size = 5
5247
+ padding = true
5248
+ => Returns "00100"
5249
+ ```
5250
+ ```javascript
5251
+ num = 100
5252
+ size = 2
5253
+ padding = false
5254
+ => Returns "00100"
5255
+ ```
5256
+ ```javascript
5257
+ num = 100
5258
+ size = 5
5259
+ padding = false
5260
+ => Returns "00000100"
5261
+ ```
5262
+
4742
5263
 
4743
5264
  ##### Returns
4744
5265
 
4745
5266
 
4746
- - `Function` debounced functions
5267
+ - the string of the number with the prefixed zeros
4747
5268
 
4748
5269
 
4749
5270
 
5271
+ #### getAbsoluteNum(num, sign)
4750
5272
 
4751
- ### dist/general/function/throttled.js
5273
+ Gets the absolute number of the giving parameters
4752
5274
 
4753
5275
 
4754
- #### throttled(fn, time)
4755
5276
 
4756
- Make sure to only invokes _fn_ at most once per every _time_ milliseconds
5277
+
5278
+ ##### Parameters
5279
+
5280
+ | Name | Type | Description | |
5281
+ | ---- | ---- | ----------- | -------- |
5282
+ | num | `number` `string` | the number | &nbsp; |
5283
+ | sign | `string` | the sign of the number | &nbsp; |
5284
+
5285
+
5286
+
5287
+
5288
+ ##### Returns
5289
+
5290
+
5291
+ - `string` the absolute number
5292
+
5293
+
5294
+
5295
+ #### getNumSign(num)
5296
+
5297
+ Gets the number sign
4757
5298
 
4758
5299
 
4759
5300
 
@@ -4762,8 +5303,7 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
4762
5303
 
4763
5304
  | Name | Type | Description | |
4764
5305
  | ---- | ---- | ----------- | -------- |
4765
- | fn | `Function` | original Function | &nbsp; |
4766
- | time | `Number` | default 500ms | &nbsp; |
5306
+ | num | `number` `string` | the number | &nbsp; |
4767
5307
 
4768
5308
 
4769
5309
 
@@ -4771,52 +5311,173 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
4771
5311
  ##### Returns
4772
5312
 
4773
5313
 
4774
- - `Function` throttled function
5314
+ - `string` the number sign
4775
5315
 
4776
5316
 
4777
5317
 
4778
5318
 
4779
- ### dist/stencil/decorators/Config.js
5319
+ ### dist/qrvey/helpers/areStaticColumnValues.js
5320
+
5321
+
5322
+ #### areStaticColumnValues(column)
5323
+
5324
+ Determines if the given column is belonging to static values questions.
5325
+ Static values questions are questions that do not need request an info from backend, instead the info is got from Model, Question/List object.
5326
+
5327
+
5328
+
5329
+
5330
+ ##### Parameters
5331
+
5332
+ | Name | Type | Description | |
5333
+ | ---- | ---- | ----------- | -------- |
5334
+ | column | | The question column | &nbsp; |
5335
+
5336
+
5337
+
5338
+
5339
+ ##### Returns
5340
+
5341
+
5342
+ - true if the column belongs to a static values question; otherwise, false
5343
+
5344
+
5345
+
5346
+
5347
+ ### dist/qrvey/helpers/getCategorizableExpression.js
5348
+
5349
+
5350
+ #### getCategorizableExpression(column, dataset)
5351
+
5352
+ Special function for Expression Columns.
5353
+ This function allows validating if expression columns have active category option.
5354
+ This is esential in order to display the asigned property for expression.
5355
+
5356
+
5357
+
5358
+
5359
+ ##### Parameters
5360
+
5361
+ | Name | Type | Description | |
5362
+ | ---- | ---- | ----------- | -------- |
5363
+ | column | | The column with info | &nbsp; |
5364
+ | dataset | | the dataset object to search the column | &nbsp; |
5365
+
5366
+
5367
+
5368
+
5369
+ ##### Returns
5370
+
5371
+
5372
+ - true if expression column is categorizable; otherwise not. If does not exist, undefined is sent.
5373
+
5374
+
5375
+
5376
+
5377
+ ### dist/qrvey/helpers/getDataAnswersByColumn.js
5378
+
5379
+
5380
+ #### getDataAnswersByColumn(column, model, property)
5381
+
5382
+ Get answers located in model object. If column exists in the model, answers will be gotten depending on column type.
5383
+ For Rating columns, needs a number sequence (From 1 to 5).
5384
+ For Expression columns, needs a property type attribute for categorizable ones; for non-categorizable expressions is not required this attribute.
5385
+ For the others columns, answers is located in the property of the same name.
5386
+
5387
+
5388
+
5389
+
5390
+ ##### Parameters
5391
+
5392
+ | Name | Type | Description | |
5393
+ | ---- | ---- | ----------- | -------- |
5394
+ | column | | Info of the column | &nbsp; |
5395
+ | model | | The model object | &nbsp; |
5396
+ | property | | Optional Attribute, especially for expression columns. | &nbsp; |
5397
+
5398
+
5399
+
5400
+
5401
+ ##### Returns
5402
+
5403
+
5404
+ - Formatted answers inside of answer property.
5405
+
5406
+
5407
+
5408
+
5409
+ ### dist/qrvey/helpers/getDatasetByColumn.js
5410
+
5411
+
5412
+ #### getDatasetByColumn(column, datasets)
5413
+
5414
+ Gets a dataset by a given partial column
5415
+
5416
+
5417
+
5418
+
5419
+ ##### Parameters
5420
+
5421
+ | Name | Type | Description | |
5422
+ | ---- | ---- | ----------- | -------- |
5423
+ | column | | the partial column | &nbsp; |
5424
+ | datasets | | the collection of dataset to look for one. | &nbsp; |
5425
+
5426
+
5427
+
5428
+
5429
+ ##### Returns
5430
+
5431
+
5432
+ - the found dataset or undefined
5433
+
5434
+
5435
+
5436
+
5437
+ ### dist/qrvey/helpers/getDropdownAnswers.js
5438
+
5439
+
5440
+ #### getDropdownAnswers(question)
4780
5441
 
5442
+ Get the answers of dropdown columns.
5443
+ Answers is a direct array of strings so it is necessary to format them.
4781
5444
 
4782
- #### Config()
4783
5445
 
4784
- Stencil.js - Prop Decorator
4785
- 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
4786
- But for this, is required ask for a property in `snake_case` style
4787
5446
 
4788
5447
 
5448
+ ##### Parameters
4789
5449
 
5450
+ | Name | Type | Description | |
5451
+ | ---- | ---- | ----------- | -------- |
5452
+ | question | | The column located inside the model object. | &nbsp; |
4790
5453
 
4791
5454
 
4792
5455
 
4793
- ##### Examples
4794
5456
 
4795
- ```javascript
4796
- \ @Config() @Prop() settings;
5457
+ ##### Returns
4797
5458
 
4798
- someMethod() {
4799
- this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
4800
- }
4801
- ```
4802
5459
 
5460
+ - Formatted answers inside of an answer property.
4803
5461
 
4804
- ##### Returns
4805
5462
 
4806
5463
 
4807
- - `Void`
4808
5464
 
5465
+ ### dist/qrvey/helpers/getExpressionAnswers.js
4809
5466
 
4810
5467
 
5468
+ #### getExpressionAnswers(column, property)
4811
5469
 
4812
- ### dist/stencil/util/createRef.js
5470
+ Get the answers of expression columns. Depends of the property attribute and if the column is categorizable.
4813
5471
 
4814
5472
 
4815
- #### createRef()
4816
5473
 
4817
- lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
4818
5474
 
5475
+ ##### Parameters
4819
5476
 
5477
+ | Name | Type | Description | |
5478
+ | ---- | ---- | ----------- | -------- |
5479
+ | column | | The column located inside the model object. | &nbsp; |
5480
+ | property | | Optional Attribute, especially for expression columns. | &nbsp; |
4820
5481
 
4821
5482
 
4822
5483
 
@@ -4824,21 +5485,17 @@ lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom
4824
5485
  ##### Returns
4825
5486
 
4826
5487
 
4827
- - function - Function to use in ref prop in html elements
5488
+ - Formatted answers inside of an answer property.
4828
5489
 
4829
5490
 
4830
5491
 
4831
5492
 
4832
- ### dist/stencil/util/getConfig.js
5493
+ ### dist/qrvey/helpers/getImageAnswers.js
4833
5494
 
4834
5495
 
4835
- #### getConfig(cfg)
5496
+ #### getImageAnswers(column)
4836
5497
 
4837
- verify the Config object type and try to return a parsed Object
4838
- - In case _cfg_ is a string, first try to make a JSON parse in other case
4839
- try to find this string as a variable on Windows object
4840
- - If _cfg_ is a fuction, tis is invoked and parsed
4841
- - Finally, if is an object, _cfg_ is inmediatly returned
5498
+ Get the answers of image columns.
4842
5499
 
4843
5500
 
4844
5501
 
@@ -4847,7 +5504,7 @@ try to find this string as a variable on Windows object
4847
5504
 
4848
5505
  | Name | Type | Description | |
4849
5506
  | ---- | ---- | ----------- | -------- |
4850
- | cfg | | | &nbsp; |
5507
+ | column | | The column located inside the model object. | &nbsp; |
4851
5508
 
4852
5509
 
4853
5510
 
@@ -4855,21 +5512,18 @@ try to find this string as a variable on Windows object
4855
5512
  ##### Returns
4856
5513
 
4857
5514
 
4858
- - `Void`
5515
+ - Formatted answers inside of an answer property.
4859
5516
 
4860
5517
 
4861
5518
 
4862
5519
 
4863
- ### dist/services/api/getAllDatasets.api.js
5520
+ ### dist/qrvey/helpers/getImageUploadHasAnalysis.js
4864
5521
 
4865
5522
 
4866
- #### getAllDatasets(config, qrveyids)
5523
+ #### getImageUploadHasAnalysis(column, model)
4867
5524
 
4868
- Get a dataset list from a collection of Qrvey IDs
4869
- Considerations for qrveyids second argument:
4870
- - If it is a undefined argument, the function will return all available datasets of the app
4871
- - If it is a empty array argument, the function will return an empty dataset list. (A request will not be executed)
4872
- - If it is a non-empty array argument, the function will return a set of available datasets
5525
+ Special function for Image Upload
5526
+ This function returns if the current column has object or text analysis as property.
4873
5527
 
4874
5528
 
4875
5529
 
@@ -4878,8 +5532,8 @@ Considerations for qrveyids second argument:
4878
5532
 
4879
5533
  | Name | Type | Description | |
4880
5534
  | ---- | ---- | ----------- | -------- |
4881
- | config | | the widget config. Includes general configuration properties | &nbsp; |
4882
- | qrveyids | | Collection of Qrvey IDs for returning a set of available datasets | &nbsp; |
5535
+ | column | | The column with info | &nbsp; |
5536
+ | model | | The model object | &nbsp; |
4883
5537
 
4884
5538
 
4885
5539
 
@@ -4887,17 +5541,17 @@ Considerations for qrveyids second argument:
4887
5541
  ##### Returns
4888
5542
 
4889
5543
 
4890
- - a promise that if it is resolved displays a collection of dataset info.
5544
+ - true if this column has analysis. Otherwise false.
4891
5545
 
4892
5546
 
4893
5547
 
4894
5548
 
4895
- ### dist/services/api/getAllQrveys.api.js
5549
+ ### dist/qrvey/helpers/getRatingAnswers.js
4896
5550
 
4897
5551
 
4898
- #### getAllQrveys(config, params)
5552
+ #### getRatingAnswers(_question)
4899
5553
 
4900
- Request function for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
5554
+ Get the answers of rating columns.
4901
5555
 
4902
5556
 
4903
5557
 
@@ -4906,8 +5560,7 @@ Request function for getting Qrveys such as Web Forms and Datasets. Use params f
4906
5560
 
4907
5561
  | Name | Type | Description | |
4908
5562
  | ---- | ---- | ----------- | -------- |
4909
- | config | | Configuration | &nbsp; |
4910
- | params | | Object for getting precise data | &nbsp; |
5563
+ | _question | | The column located inside the model object. | &nbsp; |
4911
5564
 
4912
5565
 
4913
5566
 
@@ -4915,17 +5568,17 @@ Request function for getting Qrveys such as Web Forms and Datasets. Use params f
4915
5568
  ##### Returns
4916
5569
 
4917
5570
 
4918
- - `Void`
5571
+ - Formatted answers inside of an answer property
4919
5572
 
4920
5573
 
4921
5574
 
4922
5575
 
4923
- ### dist/services/api/getDatasetColumns.api.js
5576
+ ### dist/qrvey/helpers/getSlidebarAnswers.js
4924
5577
 
4925
5578
 
4926
- #### getDatasetColumns(qrveyid)
5579
+ #### getSlidebarAnswers(_question)
4927
5580
 
4928
- Get a dataset by Qrvey ID
5581
+ Get the answers of slidebar columns. The quantity of answers depend on the steps chosen in maker.
4929
5582
 
4930
5583
 
4931
5584
 
@@ -4934,7 +5587,7 @@ Get a dataset by Qrvey ID
4934
5587
 
4935
5588
  | Name | Type | Description | |
4936
5589
  | ---- | ---- | ----------- | -------- |
4937
- | qrveyid | | The Qrvey ID | &nbsp; |
5590
+ | _question | | The column located inside the model object. | &nbsp; |
4938
5591
 
4939
5592
 
4940
5593
 
@@ -4942,17 +5595,17 @@ Get a dataset by Qrvey ID
4942
5595
  ##### Returns
4943
5596
 
4944
5597
 
4945
- - a promise
5598
+ - Formatted answers inside of an answer property
4946
5599
 
4947
5600
 
4948
5601
 
4949
5602
 
4950
- ### dist/services/api/getDatasetsByIds.api.js
5603
+ ### dist/qrvey/helpers/getSuffixTranslateByColumn.js
4951
5604
 
4952
5605
 
4953
- #### getDatasetsByIds(qrveyid)
5606
+ #### getSuffixTranslateByColumn(column)
4954
5607
 
4955
- Get a dataset by Qrvey ID
5608
+ Gets a string of the translate structure by the given column
4956
5609
 
4957
5610
 
4958
5611
 
@@ -4961,7 +5614,7 @@ Get a dataset by Qrvey ID
4961
5614
 
4962
5615
  | Name | Type | Description | |
4963
5616
  | ---- | ---- | ----------- | -------- |
4964
- | qrveyid | | The Qrvey ID | &nbsp; |
5617
+ | column | | the Info of the column | &nbsp; |
4965
5618
 
4966
5619
 
4967
5620
 
@@ -4969,18 +5622,18 @@ Get a dataset by Qrvey ID
4969
5622
  ##### Returns
4970
5623
 
4971
5624
 
4972
- - a promise
5625
+ - a string of the translation structure where the label is located.
4973
5626
 
4974
5627
 
4975
5628
 
4976
5629
 
4977
- ### dist/qrvey/helpers/areStaticColumnValues.js
5630
+ ### dist/qrvey/helpers/getValueWithSuffixes.js
4978
5631
 
4979
5632
 
4980
- #### areStaticColumnValues(column)
5633
+ #### getValueWithSuffixes(value, suffixes)
4981
5634
 
4982
- Determines if the given column is belonging to static values questions.
4983
- Static values questions are questions that do not need request an info from backend, instead the info is got from Model, Question/List object.
5635
+ Get a string value with suffixes if available.
5636
+ Add suffix into the value string. Prioritized for numeric values.
4984
5637
 
4985
5638
 
4986
5639
 
@@ -4989,7 +5642,8 @@ Static values questions are questions that do not need request an info from back
4989
5642
 
4990
5643
  | Name | Type | Description | |
4991
5644
  | ---- | ---- | ----------- | -------- |
4992
- | column | | The question column | &nbsp; |
5645
+ | value | | a number or string | &nbsp; |
5646
+ | suffixes | | An object with singular or plural suffix string. | &nbsp; |
4993
5647
 
4994
5648
 
4995
5649
 
@@ -4997,19 +5651,18 @@ Static values questions are questions that do not need request an info from back
4997
5651
  ##### Returns
4998
5652
 
4999
5653
 
5000
- - true if the column belongs to a static values question; otherwise, false
5654
+ - a string value with suffix
5001
5655
 
5002
5656
 
5003
5657
 
5004
5658
 
5005
- ### dist/qrvey/helpers/getCategorizableExpression.js
5659
+ ### dist/qrvey/helpers/getYesNoAnswers.js
5006
5660
 
5007
5661
 
5008
- #### getCategorizableExpression(column, dataset)
5662
+ #### getYesNoAnswers(column)
5009
5663
 
5010
- Special function for Expression Columns.
5011
- This function allows validating if expression columns have active category option.
5012
- This is esential in order to display the asigned property for expression.
5664
+ Get the answers of Yes/No columns.
5665
+ Yes/No answers from model object are capitalized but the filters need values in lowercase.
5013
5666
 
5014
5667
 
5015
5668
 
@@ -5018,8 +5671,7 @@ This is esential in order to display the asigned property for expression.
5018
5671
 
5019
5672
  | Name | Type | Description | |
5020
5673
  | ---- | ---- | ----------- | -------- |
5021
- | column | | The column with info | &nbsp; |
5022
- | dataset | | the dataset object to search the column | &nbsp; |
5674
+ | column | | The column located inside the model object. | &nbsp; |
5023
5675
 
5024
5676
 
5025
5677
 
@@ -5027,20 +5679,17 @@ This is esential in order to display the asigned property for expression.
5027
5679
  ##### Returns
5028
5680
 
5029
5681
 
5030
- - true if expression column is categorizable; otherwise not. If does not exist, undefined is sent.
5682
+ - Formatted answers inside of an answer property
5031
5683
 
5032
5684
 
5033
5685
 
5034
5686
 
5035
- ### dist/qrvey/helpers/getDataAnswersByColumn.js
5687
+ ### dist/qrvey/helpers/transformValue.js
5036
5688
 
5037
5689
 
5038
- #### getDataAnswersByColumn(column, model, property)
5690
+ #### transformValue(value, settings)
5039
5691
 
5040
- Get answers located in model object. If column exists in the model, answers will be gotten depending on column type.
5041
- For Rating columns, needs a number sequence (From 1 to 5).
5042
- For Expression columns, needs a property type attribute for categorizable ones; for non-categorizable expressions is not required this attribute.
5043
- For the others columns, answers is located in the property of the same name.
5692
+ Transforms a value depending of localization/globalization and extras settings.
5044
5693
 
5045
5694
 
5046
5695
 
@@ -5049,9 +5698,8 @@ For the others columns, answers is located in the property of the same name.
5049
5698
 
5050
5699
  | Name | Type | Description | |
5051
5700
  | ---- | ---- | ----------- | -------- |
5052
- | column | | Info of the column | &nbsp; |
5053
- | model | | The model object | &nbsp; |
5054
- | property | | Optional Attribute, especially for expression columns. | &nbsp; |
5701
+ | value | | A value to transform | &nbsp; |
5702
+ | settings | | The settings of the transformValue function | &nbsp; |
5055
5703
 
5056
5704
 
5057
5705
 
@@ -5059,17 +5707,13 @@ For the others columns, answers is located in the property of the same name.
5059
5707
  ##### Returns
5060
5708
 
5061
5709
 
5062
- - Formatted answers inside of answer property.
5063
-
5064
-
5065
-
5710
+ - A transformed value
5066
5711
 
5067
- ### dist/qrvey/helpers/getDatasetByColumn.js
5068
5712
 
5069
5713
 
5070
- #### getDatasetByColumn(column, datasets)
5714
+ #### getDefaultSettings(settings)
5071
5715
 
5072
- Gets a dataset by a given partial column
5716
+ Gets the default settings properties
5073
5717
 
5074
5718
 
5075
5719
 
@@ -5078,8 +5722,7 @@ Gets a dataset by a given partial column
5078
5722
 
5079
5723
  | Name | Type | Description | |
5080
5724
  | ---- | ---- | ----------- | -------- |
5081
- | column | | the partial column | &nbsp; |
5082
- | datasets | | the collection of dataset to look for one. | &nbsp; |
5725
+ | settings | `ITransformValueSettings` | the given settings | &nbsp; |
5083
5726
 
5084
5727
 
5085
5728
 
@@ -5087,18 +5730,13 @@ Gets a dataset by a given partial column
5087
5730
  ##### Returns
5088
5731
 
5089
5732
 
5090
- - the found dataset or undefined
5091
-
5092
-
5733
+ - `ITransformValueSettings` the settings with default properties
5093
5734
 
5094
5735
 
5095
- ### dist/qrvey/helpers/getDropdownAnswers.js
5096
-
5097
5736
 
5098
- #### getDropdownAnswers(question)
5737
+ #### getOutputFormat(settings)
5099
5738
 
5100
- Get the answers of dropdown columns.
5101
- Answers is a direct array of strings so it is necessary to format them.
5739
+ Gets the outputformat settings
5102
5740
 
5103
5741
 
5104
5742
 
@@ -5107,7 +5745,7 @@ Answers is a direct array of strings so it is necessary to format them.
5107
5745
 
5108
5746
  | Name | Type | Description | |
5109
5747
  | ---- | ---- | ----------- | -------- |
5110
- | question | | The column located inside the model object. | &nbsp; |
5748
+ | settings | | The settings of the transformValue function | &nbsp; |
5111
5749
 
5112
5750
 
5113
5751
 
@@ -5115,17 +5753,13 @@ Answers is a direct array of strings so it is necessary to format them.
5115
5753
  ##### Returns
5116
5754
 
5117
5755
 
5118
- - Formatted answers inside of an answer property.
5119
-
5120
-
5121
-
5756
+ - the outputformat settings
5122
5757
 
5123
- ### dist/qrvey/helpers/getExpressionAnswers.js
5124
5758
 
5125
5759
 
5126
- #### getExpressionAnswers(column, property)
5760
+ #### getFormatConfig(settings)
5127
5761
 
5128
- Get the answers of expression columns. Depends of the property attribute and if the column is categorizable.
5762
+ Gets the format config if the locale exists in i18n settings
5129
5763
 
5130
5764
 
5131
5765
 
@@ -5134,8 +5768,7 @@ Get the answers of expression columns. Depends of the property attribute and if
5134
5768
 
5135
5769
  | Name | Type | Description | |
5136
5770
  | ---- | ---- | ----------- | -------- |
5137
- | column | | The column located inside the model object. | &nbsp; |
5138
- | property | | Optional Attribute, especially for expression columns. | &nbsp; |
5771
+ | settings | | The settings of the transformValue function | &nbsp; |
5139
5772
 
5140
5773
 
5141
5774
 
@@ -5143,17 +5776,14 @@ Get the answers of expression columns. Depends of the property attribute and if
5143
5776
  ##### Returns
5144
5777
 
5145
5778
 
5146
- - Formatted answers inside of an answer property.
5147
-
5148
-
5149
-
5779
+ - the format config
5150
5780
 
5151
- ### dist/qrvey/helpers/getImageAnswers.js
5152
5781
 
5153
5782
 
5154
- #### getImageAnswers(column)
5783
+ #### getOutputFormatByPoperty(settings)
5155
5784
 
5156
- Get the answers of image columns.
5785
+ If the property is a day, return the date format without the time, otherwise return the original
5786
+ format.
5157
5787
 
5158
5788
 
5159
5789
 
@@ -5162,7 +5792,7 @@ Get the answers of image columns.
5162
5792
 
5163
5793
  | Name | Type | Description | |
5164
5794
  | ---- | ---- | ----------- | -------- |
5165
- | column | | The column located inside the model object. | &nbsp; |
5795
+ | settings | `ITransformValueSettings` | - ITransformValueSettings | &nbsp; |
5166
5796
 
5167
5797
 
5168
5798
 
@@ -5170,18 +5800,14 @@ Get the answers of image columns.
5170
5800
  ##### Returns
5171
5801
 
5172
5802
 
5173
- - Formatted answers inside of an answer property.
5174
-
5175
-
5176
-
5803
+ - The outputFormat of the column.
5177
5804
 
5178
- ### dist/qrvey/helpers/getImageUploadHasAnalysis.js
5179
5805
 
5180
5806
 
5181
- #### getImageUploadHasAnalysis(column, model)
5807
+ #### isDateWithTime(property)
5182
5808
 
5183
- Special function for Image Upload
5184
- This function returns if the current column has object or text analysis as property.
5809
+ Get the format related to the columnn property.
5810
+ If the property is hour, minute, second, or undefined, return true.
5185
5811
 
5186
5812
 
5187
5813
 
@@ -5190,8 +5816,7 @@ This function returns if the current column has object or text analysis as prope
5190
5816
 
5191
5817
  | Name | Type | Description | |
5192
5818
  | ---- | ---- | ----------- | -------- |
5193
- | column | | The column with info | &nbsp; |
5194
- | model | | The model object | &nbsp; |
5819
+ | property | `IColumnPropertyType` | - The property of the date to group by. | &nbsp; |
5195
5820
 
5196
5821
 
5197
5822
 
@@ -5199,17 +5824,17 @@ This function returns if the current column has object or text analysis as prope
5199
5824
  ##### Returns
5200
5825
 
5201
5826
 
5202
- - true if this column has analysis. Otherwise false.
5827
+ - `boolean` A boolean value.
5203
5828
 
5204
5829
 
5205
5830
 
5206
5831
 
5207
- ### dist/qrvey/helpers/getRatingAnswers.js
5832
+ ### dist/services/adapters/BBranchesMapToUIBranchesMap.adapter.js
5208
5833
 
5209
5834
 
5210
- #### getRatingAnswers(_question)
5835
+ #### BBranchesMapToUIBranchesMap(branchesMap)
5211
5836
 
5212
- Get the answers of rating columns.
5837
+ Adapts the branches map from backend to the UI branches map
5213
5838
 
5214
5839
 
5215
5840
 
@@ -5218,7 +5843,7 @@ Get the answers of rating columns.
5218
5843
 
5219
5844
  | Name | Type | Description | |
5220
5845
  | ---- | ---- | ----------- | -------- |
5221
- | _question | | The column located inside the model object. | &nbsp; |
5846
+ | branchesMap | | the backend branches map | &nbsp; |
5222
5847
 
5223
5848
 
5224
5849
 
@@ -5226,17 +5851,17 @@ Get the answers of rating columns.
5226
5851
  ##### Returns
5227
5852
 
5228
5853
 
5229
- - Formatted answers inside of an answer property
5854
+ - The Branches map array
5230
5855
 
5231
5856
 
5232
5857
 
5233
5858
 
5234
- ### dist/qrvey/helpers/getSlidebarAnswers.js
5859
+ ### dist/services/adapters/BTimezoneToUITimezone.js
5235
5860
 
5236
5861
 
5237
- #### getSlidebarAnswers(_question)
5862
+ #### BTimezoneToUITimezone(timezone)
5238
5863
 
5239
- Get the answers of slidebar columns. The quantity of answers depend on the steps chosen in maker.
5864
+ Transforms the backenc timezone structure to UI timezone structure
5240
5865
 
5241
5866
 
5242
5867
 
@@ -5245,7 +5870,7 @@ Get the answers of slidebar columns. The quantity of answers depend on the steps
5245
5870
 
5246
5871
  | Name | Type | Description | |
5247
5872
  | ---- | ---- | ----------- | -------- |
5248
- | _question | | The column located inside the model object. | &nbsp; |
5873
+ | timezone | `IBTimezone` | the backend timezone object | &nbsp; |
5249
5874
 
5250
5875
 
5251
5876
 
@@ -5253,17 +5878,21 @@ Get the answers of slidebar columns. The quantity of answers depend on the steps
5253
5878
  ##### Returns
5254
5879
 
5255
5880
 
5256
- - Formatted answers inside of an answer property
5881
+ - `IDTimezone` the UI timezone object
5257
5882
 
5258
5883
 
5259
5884
 
5260
5885
 
5261
- ### dist/qrvey/helpers/getSuffixTranslateByColumn.js
5886
+ ### dist/services/api/getAllDatasets.api.js
5262
5887
 
5263
5888
 
5264
- #### getSuffixTranslateByColumn(column)
5889
+ #### getAllDatasets(config, qrveyids)
5265
5890
 
5266
- Gets a string of the translate structure by the given column
5891
+ Get a dataset list from a collection of Qrvey IDs
5892
+ Considerations for qrveyids second argument:
5893
+ - If it is a undefined argument, the function will return all available datasets of the app
5894
+ - If it is a empty array argument, the function will return an empty dataset list. (A request will not be executed)
5895
+ - If it is a non-empty array argument, the function will return a set of available datasets
5267
5896
 
5268
5897
 
5269
5898
 
@@ -5272,7 +5901,8 @@ Gets a string of the translate structure by the given column
5272
5901
 
5273
5902
  | Name | Type | Description | |
5274
5903
  | ---- | ---- | ----------- | -------- |
5275
- | column | | the Info of the column | &nbsp; |
5904
+ | config | | the widget config. Includes general configuration properties | &nbsp; |
5905
+ | qrveyids | | Collection of Qrvey IDs for returning a set of available datasets | &nbsp; |
5276
5906
 
5277
5907
 
5278
5908
 
@@ -5280,18 +5910,17 @@ Gets a string of the translate structure by the given column
5280
5910
  ##### Returns
5281
5911
 
5282
5912
 
5283
- - a string of the translation structure where the label is located.
5913
+ - a promise that if it is resolved displays a collection of dataset info.
5284
5914
 
5285
5915
 
5286
5916
 
5287
5917
 
5288
- ### dist/qrvey/helpers/getValueWithSuffixes.js
5918
+ ### dist/services/api/getAllQrveys.api.js
5289
5919
 
5290
5920
 
5291
- #### getValueWithSuffixes(value, suffixes)
5921
+ #### getAllQrveys(config, params)
5292
5922
 
5293
- Get a string value with suffixes if available.
5294
- Add suffix into the value string. Prioritized for numeric values.
5923
+ Request function for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
5295
5924
 
5296
5925
 
5297
5926
 
@@ -5300,8 +5929,8 @@ Add suffix into the value string. Prioritized for numeric values.
5300
5929
 
5301
5930
  | Name | Type | Description | |
5302
5931
  | ---- | ---- | ----------- | -------- |
5303
- | value | | a number or string | &nbsp; |
5304
- | suffixes | | An object with singular or plural suffix string. | &nbsp; |
5932
+ | config | | Configuration | &nbsp; |
5933
+ | params | | Object for getting precise data | &nbsp; |
5305
5934
 
5306
5935
 
5307
5936
 
@@ -5309,18 +5938,17 @@ Add suffix into the value string. Prioritized for numeric values.
5309
5938
  ##### Returns
5310
5939
 
5311
5940
 
5312
- - a string value with suffix
5941
+ - `Void`
5313
5942
 
5314
5943
 
5315
5944
 
5316
5945
 
5317
- ### dist/qrvey/helpers/getYesNoAnswers.js
5946
+ ### dist/services/api/getDatasetsByIds.api.js
5318
5947
 
5319
5948
 
5320
- #### getYesNoAnswers(column)
5949
+ #### getDatasetsByIds(qrveyid)
5321
5950
 
5322
- Get the answers of Yes/No columns.
5323
- Yes/No answers from model object are capitalized but the filters need values in lowercase.
5951
+ Get a dataset by Qrvey ID
5324
5952
 
5325
5953
 
5326
5954
 
@@ -5329,7 +5957,7 @@ Yes/No answers from model object are capitalized but the filters need values in
5329
5957
 
5330
5958
  | Name | Type | Description | |
5331
5959
  | ---- | ---- | ----------- | -------- |
5332
- | column | | The column located inside the model object. | &nbsp; |
5960
+ | qrveyid | | The Qrvey ID | &nbsp; |
5333
5961
 
5334
5962
 
5335
5963
 
@@ -5337,17 +5965,17 @@ Yes/No answers from model object are capitalized but the filters need values in
5337
5965
  ##### Returns
5338
5966
 
5339
5967
 
5340
- - Formatted answers inside of an answer property
5968
+ - a promise
5341
5969
 
5342
5970
 
5343
5971
 
5344
5972
 
5345
- ### dist/qrvey/helpers/transformValue.js
5973
+ ### dist/services/api/getDatasetColumns.api.js
5346
5974
 
5347
5975
 
5348
- #### transformValue(value, settings)
5976
+ #### getDatasetColumns(qrveyid)
5349
5977
 
5350
- Transforms a value depending of localization/globalization and extras settings.
5978
+ Get a dataset by Qrvey ID
5351
5979
 
5352
5980
 
5353
5981
 
@@ -5356,8 +5984,7 @@ Transforms a value depending of localization/globalization and extras settings.
5356
5984
 
5357
5985
  | Name | Type | Description | |
5358
5986
  | ---- | ---- | ----------- | -------- |
5359
- | value | | A value to transform | &nbsp; |
5360
- | settings | | The settings of the transformValue function | &nbsp; |
5987
+ | qrveyid | | The Qrvey ID | &nbsp; |
5361
5988
 
5362
5989
 
5363
5990
 
@@ -5365,45 +5992,52 @@ Transforms a value depending of localization/globalization and extras settings.
5365
5992
  ##### Returns
5366
5993
 
5367
5994
 
5368
- - A transformed value
5995
+ - a promise
5369
5996
 
5370
5997
 
5371
5998
 
5372
- #### getOutputFormat(settings)
5373
5999
 
5374
- Gets the outputformat settings
6000
+ ### dist/stencil/decorators/Config.js
6001
+
6002
+
6003
+ #### Config()
6004
+
6005
+ Stencil.js - Prop Decorator
6006
+ 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
6007
+ But for this, is required ask for a property in `snake_case` style
5375
6008
 
5376
6009
 
5377
6010
 
5378
6011
 
5379
- ##### Parameters
5380
6012
 
5381
- | Name | Type | Description | |
5382
- | ---- | ---- | ----------- | -------- |
5383
- | settings | | The settings of the transformValue function | &nbsp; |
5384
6013
 
6014
+ ##### Examples
6015
+
6016
+ ```javascript
6017
+ \ @Config() @Prop() settings;
5385
6018
 
6019
+ someMethod() {
6020
+ this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
6021
+ }
6022
+ ```
5386
6023
 
5387
6024
 
5388
6025
  ##### Returns
5389
6026
 
5390
6027
 
5391
- - the outputformat settings
6028
+ - `Void`
5392
6029
 
5393
6030
 
5394
6031
 
5395
- #### getFormatConfig(settings)
5396
6032
 
5397
- Gets the format config
6033
+ ### dist/stencil/util/createRef.js
5398
6034
 
5399
6035
 
6036
+ #### createRef()
5400
6037
 
6038
+ lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
5401
6039
 
5402
- ##### Parameters
5403
6040
 
5404
- | Name | Type | Description | |
5405
- | ---- | ---- | ----------- | -------- |
5406
- | settings | | The settings of the transformValue function | &nbsp; |
5407
6041
 
5408
6042
 
5409
6043
 
@@ -5411,17 +6045,21 @@ Gets the format config
5411
6045
  ##### Returns
5412
6046
 
5413
6047
 
5414
- - the format config
6048
+ - function - Function to use in ref prop in html elements
5415
6049
 
5416
6050
 
5417
6051
 
5418
6052
 
5419
- ### dist/services/adapters/BBranchesMapToUIBranchesMap.adapter.js
6053
+ ### dist/stencil/util/getConfig.js
5420
6054
 
5421
6055
 
5422
- #### BBranchesMapToUIBranchesMap(branchesMap)
6056
+ #### getConfig(cfg)
5423
6057
 
5424
- Adapts the branches map from backend to the UI branches map
6058
+ verify the Config object type and try to return a parsed Object
6059
+ - In case _cfg_ is a string, first try to make a JSON parse in other case
6060
+ try to find this string as a variable on Windows object
6061
+ - If _cfg_ is a fuction, tis is invoked and parsed
6062
+ - Finally, if is an object, _cfg_ is inmediatly returned
5425
6063
 
5426
6064
 
5427
6065
 
@@ -5430,7 +6068,7 @@ Adapts the branches map from backend to the UI branches map
5430
6068
 
5431
6069
  | Name | Type | Description | |
5432
6070
  | ---- | ---- | ----------- | -------- |
5433
- | branchesMap | | the backend branches map | &nbsp; |
6071
+ | cfg | | | &nbsp; |
5434
6072
 
5435
6073
 
5436
6074
 
@@ -5438,7 +6076,7 @@ Adapts the branches map from backend to the UI branches map
5438
6076
  ##### Returns
5439
6077
 
5440
6078
 
5441
- - The Branches map array
6079
+ - `Void`
5442
6080
 
5443
6081
 
5444
6082
 
@@ -5579,33 +6217,6 @@ Parses a string date and returns a dayjs date
5579
6217
 
5580
6218
 
5581
6219
 
5582
- ### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
5583
-
5584
-
5585
- #### getFilterBuilderGeneralConfig(config)
5586
-
5587
- Returns a filter builder config object by a any given config
5588
-
5589
-
5590
-
5591
-
5592
- ##### Parameters
5593
-
5594
- | Name | Type | Description | |
5595
- | ---- | ---- | ----------- | -------- |
5596
- | config | | any config object | &nbsp; |
5597
-
5598
-
5599
-
5600
-
5601
- ##### Returns
5602
-
5603
-
5604
- - The filter builder config object
5605
-
5606
-
5607
-
5608
-
5609
6220
  ### dist/filters/helpers/backend/buildExpression.js
5610
6221
 
5611
6222
 
@@ -5845,36 +6456,6 @@ Gets the Ranking values.
5845
6456
 
5846
6457
 
5847
6458
 
5848
- ### dist/filters/helpers/backend/getLogicByDatasets.js
5849
-
5850
-
5851
- #### getLogicByDatasets(logic, datasets)
5852
-
5853
- [TODO: Add filterEmptyArrays to the filterNestedTree filter condition. Firstly, that function should accept this argument]
5854
- Filters the logic by a qrveyids array
5855
- If an qrveyid is not provided in the expression the filter passes normally
5856
-
5857
-
5858
-
5859
-
5860
- ##### Parameters
5861
-
5862
- | Name | Type | Description | |
5863
- | ---- | ---- | ----------- | -------- |
5864
- | logic | | The logic of the filter | &nbsp; |
5865
- | datasets | | The collection of qrveyids | &nbsp; |
5866
-
5867
-
5868
-
5869
-
5870
- ##### Returns
5871
-
5872
-
5873
- - a new filtered logic
5874
-
5875
-
5876
-
5877
-
5878
6459
  ### dist/filters/helpers/backend/getLogicByDatasetsColumns.js
5879
6460
 
5880
6461
 
@@ -6023,6 +6604,36 @@ Gets the default settings for the getLogicByDatasetsColumn function
6023
6604
 
6024
6605
 
6025
6606
 
6607
+ ### dist/filters/helpers/backend/getLogicByDatasets.js
6608
+
6609
+
6610
+ #### getLogicByDatasets(logic, datasets)
6611
+
6612
+ [TODO: Add filterEmptyArrays to the filterNestedTree filter condition. Firstly, that function should accept this argument]
6613
+ Filters the logic by a qrveyids array
6614
+ If an qrveyid is not provided in the expression the filter passes normally
6615
+
6616
+
6617
+
6618
+
6619
+ ##### Parameters
6620
+
6621
+ | Name | Type | Description | |
6622
+ | ---- | ---- | ----------- | -------- |
6623
+ | logic | | The logic of the filter | &nbsp; |
6624
+ | datasets | | The collection of qrveyids | &nbsp; |
6625
+
6626
+
6627
+
6628
+
6629
+ ##### Returns
6630
+
6631
+
6632
+ - a new filtered logic
6633
+
6634
+
6635
+
6636
+
6026
6637
  ### dist/filters/helpers/backend/getLogicByScopes.js
6027
6638
 
6028
6639
 
@@ -6080,6 +6691,33 @@ Gets filters from the logic by the scopes hierarchy.
6080
6691
 
6081
6692
 
6082
6693
 
6694
+ ### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
6695
+
6696
+
6697
+ #### getFilterBuilderGeneralConfig(config)
6698
+
6699
+ Returns a filter builder config object by a any given config
6700
+
6701
+
6702
+
6703
+
6704
+ ##### Parameters
6705
+
6706
+ | Name | Type | Description | |
6707
+ | ---- | ---- | ----------- | -------- |
6708
+ | config | | any config object | &nbsp; |
6709
+
6710
+
6711
+
6712
+
6713
+ ##### Returns
6714
+
6715
+
6716
+ - The filter builder config object
6717
+
6718
+
6719
+
6720
+
6083
6721
  ### dist/filters/helpers/common/areFiltersEquals.js
6084
6722
 
6085
6723
 
@@ -6348,6 +6986,43 @@ Module specially for CLS.
6348
6986
 
6349
6987
 
6350
6988
 
6989
+ ### dist/filters/helpers/common/getFiltersByParams.js
6990
+
6991
+
6992
+ #### getFiltersByParams(filterData, params)
6993
+
6994
+ Gets filters from the given params.
6995
+ The validation to filter the stored filter is depending on:
6996
+ - Column
6997
+ - Qrvey ID
6998
+ - Scope type
6999
+ - Scope ID
7000
+ - Panel ID
7001
+ - Validator type
7002
+ - Property type
7003
+ - Enabled flags
7004
+
7005
+
7006
+
7007
+
7008
+ ##### Parameters
7009
+
7010
+ | Name | Type | Description | |
7011
+ | ---- | ---- | ----------- | -------- |
7012
+ | filterData | | The Filter Data or the UI Filter Data | &nbsp; |
7013
+ | params | | given parameters to validate the dataset | &nbsp; |
7014
+
7015
+
7016
+
7017
+
7018
+ ##### Returns
7019
+
7020
+
7021
+ - a new Filter object structure
7022
+
7023
+
7024
+
7025
+
6351
7026
  ### dist/filters/helpers/common/getFiltersByScopes.js
6352
7027
 
6353
7028
 
@@ -6404,12 +7079,12 @@ Gets filters from Filter Data by Scopes/Scope IDs.
6404
7079
 
6405
7080
 
6406
7081
 
6407
- ### dist/filters/helpers/common/getFiltersByVisibility.js
7082
+ ### dist/filters/helpers/common/getFiltersByTimezone.js
6408
7083
 
6409
7084
 
6410
- #### getFiltersByVisibility(filterData, scopes)
7085
+ #### getFiltersByTimezone(filterData, timezone)
6411
7086
 
6412
- Get a new Filter Data by filtering scopes/scope IDs and enabled flags
7087
+ Gets and transforms the Filter Data by the Timezone object
6413
7088
 
6414
7089
 
6415
7090
 
@@ -6418,8 +7093,8 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
6418
7093
 
6419
7094
  | Name | Type | Description | |
6420
7095
  | ---- | ---- | ----------- | -------- |
6421
- | filterData | | a Filter Data or UI Filter Data | &nbsp; |
6422
- | scopes | | a Scopes/Scope IDs array | &nbsp; |
7096
+ | filterData | `IFSData` `IFUData` | the filter data | &nbsp; |
7097
+ | timezone | `IDTimezone` | the timezone object | &nbsp; |
6423
7098
 
6424
7099
 
6425
7100
 
@@ -6427,26 +7102,17 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
6427
7102
  ##### Returns
6428
7103
 
6429
7104
 
6430
- - a new Filter Data
7105
+ - `IFSData` `IFUData` the new filter data with the transformed datetime values
6431
7106
 
6432
7107
 
6433
7108
 
6434
7109
 
6435
- ### dist/filters/helpers/common/getFiltersByParams.js
7110
+ ### dist/filters/helpers/common/getFiltersByVisibility.js
6436
7111
 
6437
7112
 
6438
- #### getFiltersByParams(filterData, params)
7113
+ #### getFiltersByVisibility(filterData, scopes)
6439
7114
 
6440
- Gets filters from the given params.
6441
- The validation to filter the stored filter is depending on:
6442
- - Column
6443
- - Qrvey ID
6444
- - Scope type
6445
- - Scope ID
6446
- - Panel ID
6447
- - Validator type
6448
- - Property type
6449
- - Enabled flags
7115
+ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
6450
7116
 
6451
7117
 
6452
7118
 
@@ -6455,8 +7121,8 @@ The validation to filter the stored filter is depending on:
6455
7121
 
6456
7122
  | Name | Type | Description | |
6457
7123
  | ---- | ---- | ----------- | -------- |
6458
- | filterData | | The Filter Data or the UI Filter Data | &nbsp; |
6459
- | params | | given parameters to validate the dataset | &nbsp; |
7124
+ | filterData | | a Filter Data or UI Filter Data | &nbsp; |
7125
+ | scopes | | a Scopes/Scope IDs array | &nbsp; |
6460
7126
 
6461
7127
 
6462
7128
 
@@ -6464,7 +7130,7 @@ The validation to filter the stored filter is depending on:
6464
7130
  ##### Returns
6465
7131
 
6466
7132
 
6467
- - a new Filter object structure
7133
+ - a new Filter Data
6468
7134
 
6469
7135
 
6470
7136
 
@@ -6604,12 +7270,40 @@ Gets the values from the model object that will be used to filter. Static values
6604
7270
 
6605
7271
 
6606
7272
 
6607
- ### dist/filters/helpers/common/haveFiltersByDataset.js
7273
+ ### dist/filters/helpers/common/haveFiltersByDataset.js
7274
+
7275
+
7276
+ #### haveFiltersByDataset(filterData, qrveyid)
7277
+
7278
+ Validates if the filter data has filters by a dataset ID (Qrvey ID).
7279
+
7280
+
7281
+
7282
+
7283
+ ##### Parameters
7284
+
7285
+ | Name | Type | Description | |
7286
+ | ---- | ---- | ----------- | -------- |
7287
+ | filterData | | the filter data or the UI filter data. | &nbsp; |
7288
+ | qrveyid | | The Qrvey ID | &nbsp; |
7289
+
7290
+
7291
+
7292
+
7293
+ ##### Returns
7294
+
7295
+
7296
+ - true: the filter data has filters by the Qrvey ID
7297
+
7298
+
7299
+
7300
+
7301
+ ### dist/filters/helpers/common/isBetweenValidator.js
6608
7302
 
6609
7303
 
6610
- #### haveFiltersByDataset(filterData, qrveyid)
7304
+ #### isBetweenValidator(validator)
6611
7305
 
6612
- Validates if the filter data has filters by a dataset ID (Qrvey ID).
7306
+ Validates if the given validator is a Between type
6613
7307
 
6614
7308
 
6615
7309
 
@@ -6618,8 +7312,7 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
6618
7312
 
6619
7313
  | Name | Type | Description | |
6620
7314
  | ---- | ---- | ----------- | -------- |
6621
- | filterData | | the filter data or the UI filter data. | &nbsp; |
6622
- | qrveyid | | The Qrvey ID | &nbsp; |
7315
+ | validator | | The validator | &nbsp; |
6623
7316
 
6624
7317
 
6625
7318
 
@@ -6627,7 +7320,7 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
6627
7320
  ##### Returns
6628
7321
 
6629
7322
 
6630
- - true: the filter data has filters by the Qrvey ID
7323
+ - true: it is a between validator; false: it is not a between validator
6631
7324
 
6632
7325
 
6633
7326
 
@@ -6660,12 +7353,12 @@ Determines if the filter column and property is a distinct group dates type
6660
7353
 
6661
7354
 
6662
7355
 
6663
- ### dist/filters/helpers/common/isBetweenValidator.js
7356
+ ### dist/filters/helpers/common/isInValidator.js
6664
7357
 
6665
7358
 
6666
- #### isBetweenValidator(validator)
7359
+ #### isInValidator(validator)
6667
7360
 
6668
- Validates if the given validator is a Between type
7361
+ Validates if the given validator is a In type
6669
7362
 
6670
7363
 
6671
7364
 
@@ -6682,7 +7375,7 @@ Validates if the given validator is a Between type
6682
7375
  ##### Returns
6683
7376
 
6684
7377
 
6685
- - true: it is a between validator; false: it is not a between validator
7378
+ - true: it is a In validator; false: it is not a In validator
6686
7379
 
6687
7380
 
6688
7381
 
@@ -6714,12 +7407,12 @@ Checks if the given validator is a Null type.
6714
7407
 
6715
7408
 
6716
7409
 
6717
- ### dist/filters/helpers/common/isInValidator.js
7410
+ ### dist/filters/helpers/common/isRangeValidator.js
6718
7411
 
6719
7412
 
6720
- #### isInValidator(validator)
7413
+ #### isRangeValidator(validator)
6721
7414
 
6722
- Validates if the given validator is a In type
7415
+ Validates if the given validator is a Range type. Range type means the value has min and max values to filter
6723
7416
 
6724
7417
 
6725
7418
 
@@ -6728,7 +7421,7 @@ Validates if the given validator is a In type
6728
7421
 
6729
7422
  | Name | Type | Description | |
6730
7423
  | ---- | ---- | ----------- | -------- |
6731
- | validator | | The validator | &nbsp; |
7424
+ | validator | | The filter validator | &nbsp; |
6732
7425
 
6733
7426
 
6734
7427
 
@@ -6736,7 +7429,7 @@ Validates if the given validator is a In type
6736
7429
  ##### Returns
6737
7430
 
6738
7431
 
6739
- - true: it is a In validator; false: it is not a In validator
7432
+ - true: it is a range validator
6740
7433
 
6741
7434
 
6742
7435
 
@@ -6796,33 +7489,6 @@ Validates if the given validator is a regular type. Regular type means the filte
6796
7489
 
6797
7490
 
6798
7491
 
6799
- ### dist/filters/helpers/common/isRangeValidator.js
6800
-
6801
-
6802
- #### isRangeValidator(validator)
6803
-
6804
- Validates if the given validator is a Range type. Range type means the value has min and max values to filter
6805
-
6806
-
6807
-
6808
-
6809
- ##### Parameters
6810
-
6811
- | Name | Type | Description | |
6812
- | ---- | ---- | ----------- | -------- |
6813
- | validator | | The filter validator | &nbsp; |
6814
-
6815
-
6816
-
6817
-
6818
- ##### Returns
6819
-
6820
-
6821
- - true: it is a range validator
6822
-
6823
-
6824
-
6825
-
6826
7492
  ### dist/filters/helpers/common/mergeFilters.js
6827
7493
 
6828
7494
 
@@ -7071,12 +7737,12 @@ Resolves the conditions by given params
7071
7737
 
7072
7738
 
7073
7739
 
7074
- ### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
7740
+ ### dist/filters/helpers/settings/areMultipleScopesByProperties.js
7075
7741
 
7076
7742
 
7077
- #### excludeUIFlatFiltersByScopes(uFilters, scopes)
7743
+ #### areMultipleScopesByProperties(settings, scopeProperties, condition)
7078
7744
 
7079
- Excludes and returns a UI Flat Filters without filters by the given scopes
7745
+ Validates if the scope settings is satisfied by properties in multiple scopes
7080
7746
 
7081
7747
 
7082
7748
 
@@ -7085,8 +7751,9 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
7085
7751
 
7086
7752
  | Name | Type | Description | |
7087
7753
  | ---- | ---- | ----------- | -------- |
7088
- | uFilters | | The Flatten UI Filters | &nbsp; |
7089
- | scopes | | collection of scopes types | &nbsp; |
7754
+ | settings | `IFSettings` | the filter setting | &nbsp; |
7755
+ | scopeProperties | `string` | the property or the string path of the scope settings | &nbsp; |
7756
+ | condition | `string` | validate with AND or OR condition | &nbsp; |
7090
7757
 
7091
7758
 
7092
7759
 
@@ -7094,17 +7761,17 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
7094
7761
  ##### Returns
7095
7762
 
7096
7763
 
7097
- - The new array of UI Flattened filters
7764
+ - true iif there are scopes to be satisfied; false: one or none scopes to be satisfied
7098
7765
 
7099
7766
 
7100
7767
 
7101
7768
 
7102
- ### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
7769
+ ### dist/filters/helpers/settings/areMultipleScopesByProperty.js
7103
7770
 
7104
7771
 
7105
- #### excludeUIFiltersByAggregate(uFilters)
7772
+ #### areMultipleScopesByProperty(settings, property)
7106
7773
 
7107
- Excludes Aggregate Filters in the Flattened UI Filters array
7774
+ Validates if the scope settings is satisfied the property in multiple scopes
7108
7775
 
7109
7776
 
7110
7777
 
@@ -7113,7 +7780,8 @@ Excludes Aggregate Filters in the Flattened UI Filters array
7113
7780
 
7114
7781
  | Name | Type | Description | |
7115
7782
  | ---- | ---- | ----------- | -------- |
7116
- | uFilters | | Collection of Flat UI Filters | &nbsp; |
7783
+ | settings | `IFSettings` | the filter setting | &nbsp; |
7784
+ | property | `string` | the property or the string path of the scope settings | &nbsp; |
7117
7785
 
7118
7786
 
7119
7787
 
@@ -7121,17 +7789,20 @@ Excludes Aggregate Filters in the Flattened UI Filters array
7121
7789
  ##### Returns
7122
7790
 
7123
7791
 
7124
- - a new Flat UI Filters that were excluded the aggregate filters
7792
+ - true if there are scopes to be satisfied; false: one or none scopes to be satisfied
7125
7793
 
7126
7794
 
7127
7795
 
7128
7796
 
7129
- ### dist/filters/helpers/ui/getFilterPropertyLabel.js
7797
+ ### dist/filters/helpers/settings/getFilterSettings.js
7130
7798
 
7131
7799
 
7132
- #### getFilterPropertyLabel(filter)
7800
+ #### getFilterSettings(filterSettings, allowedScopes, otherSettings)
7133
7801
 
7134
- Gets the label of the filter property
7802
+ Gets a new filter settings object according to various conditions
7803
+ - By allowed scopes. Different implementation could accept some scopes, so the forbidden scopes into the filter settings will be skipped
7804
+ - If there is not filter settings provived, a default one is returned
7805
+ - The returned filter settings depend on the coexisting scopes
7135
7806
 
7136
7807
 
7137
7808
 
@@ -7140,7 +7811,9 @@ Gets the label of the filter property
7140
7811
 
7141
7812
  | Name | Type | Description | |
7142
7813
  | ---- | ---- | ----------- | -------- |
7143
- | filter | | The UI Filter | &nbsp; |
7814
+ | filterSettings | `IFSettings` | the given filter settings | &nbsp; |
7815
+ | allowedScopes | `Array.<IFScope>` | a collection of scope types that are permitted | &nbsp; |
7816
+ | otherSettings | `IFSettings` | another filter settings object to be merged with the filterSettings param | &nbsp; |
7144
7817
 
7145
7818
 
7146
7819
 
@@ -7148,17 +7821,13 @@ Gets the label of the filter property
7148
7821
  ##### Returns
7149
7822
 
7150
7823
 
7151
- - a string of the filter property label
7152
-
7153
-
7154
-
7824
+ - a new filter settings object
7155
7825
 
7156
- ### dist/filters/helpers/ui/getOutputFormatByColumn.js
7157
7826
 
7158
7827
 
7159
- #### getOutputFormatByColumn(column, datasets)
7828
+ #### getFilterSettingsByMultipleScopes(settings, allowedScopes)
7160
7829
 
7161
- Gets output format object from Datasets by the given column. Item of the datasets array must have outputformat item in order to be returned
7830
+ Gets the filter settings by multiple scopes conditions
7162
7831
 
7163
7832
 
7164
7833
 
@@ -7167,8 +7836,8 @@ Gets output format object from Datasets by the given column. Item of the dataset
7167
7836
 
7168
7837
  | Name | Type | Description | |
7169
7838
  | ---- | ---- | ----------- | -------- |
7170
- | column | | The column | &nbsp; |
7171
- | datasets | | array of datasets | &nbsp; |
7839
+ | settings | `IFSettings` | the given filter settings | &nbsp; |
7840
+ | allowedScopes | `Array.<IFScope>` | a collection of scope types that are permitted | &nbsp; |
7172
7841
 
7173
7842
 
7174
7843
 
@@ -7176,18 +7845,13 @@ Gets output format object from Datasets by the given column. Item of the dataset
7176
7845
  ##### Returns
7177
7846
 
7178
7847
 
7179
- - The output format object
7180
-
7181
-
7182
-
7848
+ - a new filter settings object
7183
7849
 
7184
- ### dist/filters/helpers/ui/getQrveyIdsByUIFilters.js
7185
7850
 
7186
7851
 
7187
- #### getQrveyIdsByUIFilters(uiFilter)
7852
+ #### getFilterSettingsByOnlyScope(settings, allowedScopes)
7188
7853
 
7189
- Gets a collection of Qrvey IDs in the UI Filter structure.
7190
- Looks around all filter structure finding the qrveyid propertty in each dataset
7854
+ Gets the filter settings when a single scope is permitted
7191
7855
 
7192
7856
 
7193
7857
 
@@ -7196,35 +7860,8 @@ Looks around all filter structure finding the qrveyid propertty in each dataset
7196
7860
 
7197
7861
  | Name | Type | Description | |
7198
7862
  | ---- | ---- | ----------- | -------- |
7199
- | uiFilter | | | &nbsp; |
7200
-
7201
-
7202
-
7203
-
7204
- ##### Returns
7205
-
7206
-
7207
- - `Void`
7208
-
7209
-
7210
-
7211
-
7212
- ### dist/filters/helpers/ui/getUIFlatFilterByParams.js
7213
-
7214
-
7215
- #### getUIFlatFilterByParams()
7216
-
7217
- Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
7218
- The validation to filter the stored filter is depending on:
7219
- - Column
7220
- - Qrvey ID,
7221
- - Scope type
7222
- - Scope ID
7223
- - Panel ID
7224
- - Validator type
7225
- - Property type
7226
-
7227
-
7863
+ | settings | `IFSettings` | the given filter settings | &nbsp; |
7864
+ | allowedScopes | `Array.<IFScope>` | a collection of scope types that are permitted | &nbsp; |
7228
7865
 
7229
7866
 
7230
7867
 
@@ -7232,28 +7869,22 @@ The validation to filter the stored filter is depending on:
7232
7869
  ##### Returns
7233
7870
 
7234
7871
 
7235
- - The index of the uFilter array or the Filter object s
7872
+ - a new filter settings object
7236
7873
 
7237
7874
 
7238
7875
 
7876
+ #### getFilterSettingsByNoScopes(settings)
7239
7877
 
7240
- ### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
7878
+ Gets the filter settings when there is not scope to accept
7241
7879
 
7242
7880
 
7243
- #### getUIFlatFiltersByParams()
7244
7881
 
7245
- Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
7246
- The validation to filter the stored filter is depending on:
7247
- - Column
7248
- - Qrvey ID,
7249
- - Scope type
7250
- - Scope ID
7251
- - Panel ID
7252
- - Validator type
7253
- - Property type
7254
- - Enabled flags
7255
7882
 
7883
+ ##### Parameters
7256
7884
 
7885
+ | Name | Type | Description | |
7886
+ | ---- | ---- | ----------- | -------- |
7887
+ | settings | `IFSettings` | the given filter settings | &nbsp; |
7257
7888
 
7258
7889
 
7259
7890
 
@@ -7261,17 +7892,14 @@ The validation to filter the stored filter is depending on:
7261
7892
  ##### Returns
7262
7893
 
7263
7894
 
7264
- - The index of the uFilter array or the Filter object s
7265
-
7266
-
7267
-
7895
+ - a new filter settings object
7268
7896
 
7269
- ### dist/filters/helpers/ui/getUIValues.js
7270
7897
 
7271
7898
 
7272
- #### getUIValues(filter, settings)
7899
+ #### getFilterSettingsByGeneralOnlyScope(settings)
7273
7900
 
7274
- Gets the UI Values generated depending on the validator
7901
+ Gets the filter settings when a general scope are only permitted
7902
+ The general scopes could be the GLOBAL, PAGE, TAB and PANEL types.
7275
7903
 
7276
7904
 
7277
7905
 
@@ -7280,8 +7908,7 @@ Gets the UI Values generated depending on the validator
7280
7908
 
7281
7909
  | Name | Type | Description | |
7282
7910
  | ---- | ---- | ----------- | -------- |
7283
- | filter | | the filter structure | &nbsp; |
7284
- | settings | | a settings for this function | &nbsp; |
7911
+ | settings | `IFSettings` | the given filter settings | &nbsp; |
7285
7912
 
7286
7913
 
7287
7914
 
@@ -7289,17 +7916,13 @@ Gets the UI Values generated depending on the validator
7289
7916
  ##### Returns
7290
7917
 
7291
7918
 
7292
- - an array of values
7293
-
7294
-
7295
-
7919
+ - a new filter settings object
7296
7920
 
7297
- ### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
7298
7921
 
7299
7922
 
7300
- #### getUIFlatFiltersByScopes(uFilters, scopes)
7923
+ #### getFilterSettingsByNoDefaultScope(settings)
7301
7924
 
7302
- Filters and gets a UI Flatten Filters by the given scopes
7925
+ Gets the filter settings when there is not a default scope type
7303
7926
 
7304
7927
 
7305
7928
 
@@ -7308,8 +7931,7 @@ Filters and gets a UI Flatten Filters by the given scopes
7308
7931
 
7309
7932
  | Name | Type | Description | |
7310
7933
  | ---- | ---- | ----------- | -------- |
7311
- | uFilters | | The Flatten UI Filters | &nbsp; |
7312
- | scopes | | collection of scopes types | &nbsp; |
7934
+ | settings | `IFSettings` | the given filter settings | &nbsp; |
7313
7935
 
7314
7936
 
7315
7937
 
@@ -7317,17 +7939,13 @@ Filters and gets a UI Flatten Filters by the given scopes
7317
7939
  ##### Returns
7318
7940
 
7319
7941
 
7320
- - The new array of UI Flattened filters
7321
-
7322
-
7323
-
7942
+ - a new filter settings object
7324
7943
 
7325
- ### dist/filters/helpers/ui/getUpdatedUIFilters.js
7326
7944
 
7327
7945
 
7328
- #### getUpdatedUIFilters(data, datasets)
7946
+ #### getFilterSettingsByOnlyDefaultScope(settings)
7329
7947
 
7330
- Gets a new UI Filter structure with a datasets/columns info updates
7948
+ Gets the filter settings when there is only a default scope type
7331
7949
 
7332
7950
 
7333
7951
 
@@ -7336,8 +7954,7 @@ Gets a new UI Filter structure with a datasets/columns info updates
7336
7954
 
7337
7955
  | Name | Type | Description | |
7338
7956
  | ---- | ---- | ----------- | -------- |
7339
- | data | | The UI Filter structure | &nbsp; |
7340
- | datasets | | An array of datasets/column info used for updating the data | &nbsp; |
7957
+ | settings | `IFSettings` | the given filter settings | &nbsp; |
7341
7958
 
7342
7959
 
7343
7960
 
@@ -7345,17 +7962,13 @@ Gets a new UI Filter structure with a datasets/columns info updates
7345
7962
  ##### Returns
7346
7963
 
7347
7964
 
7348
- - A new UI FIlter structure
7349
-
7350
-
7351
-
7965
+ - a new filter settings object
7352
7966
 
7353
- ### dist/filters/helpers/ui/resolveUIFlatFilterByParams.js
7354
7967
 
7355
7968
 
7356
- #### resolveUIFlatFilterByParams(filter, params)
7969
+ #### getFilterSettingsByDefaultWithOneAdditionalScope(settings)
7357
7970
 
7358
- Resolves conditions between UI flattened filter and given parameters
7971
+ Gets the filter settings when there are a default scope and other single scope
7359
7972
 
7360
7973
 
7361
7974
 
@@ -7364,8 +7977,7 @@ Resolves conditions between UI flattened filter and given parameters
7364
7977
 
7365
7978
  | Name | Type | Description | |
7366
7979
  | ---- | ---- | ----------- | -------- |
7367
- | filter | | UI Flatten Filter | &nbsp; |
7368
- | params | | Parameters to validate | &nbsp; |
7980
+ | settings | `IFSettings` | the given filter settings | &nbsp; |
7369
7981
 
7370
7982
 
7371
7983
 
@@ -7373,17 +7985,13 @@ Resolves conditions between UI flattened filter and given parameters
7373
7985
  ##### Returns
7374
7986
 
7375
7987
 
7376
- - true: the conditions are satisfied.
7377
-
7378
-
7379
-
7988
+ - a new filter settings object
7380
7989
 
7381
- ### dist/filters/helpers/settings/areMultipleScopesByProperties.js
7382
7990
 
7383
7991
 
7384
- #### areMultipleScopesByProperties(settings, scopeProperties, condition)
7992
+ #### getFilterSettingsByOnlyPanelScope(settings)
7385
7993
 
7386
- Validates if the scope settings is satisfied by properties in multiple scopes
7994
+ Gets the filter settings when there is only the panel scope
7387
7995
 
7388
7996
 
7389
7997
 
@@ -7392,9 +8000,7 @@ Validates if the scope settings is satisfied by properties in multiple scopes
7392
8000
 
7393
8001
  | Name | Type | Description | |
7394
8002
  | ---- | ---- | ----------- | -------- |
7395
- | settings | `IFSettings` | the filter setting | &nbsp; |
7396
- | scopeProperties | `string` | the property or the string path of the scope settings | &nbsp; |
7397
- | condition | `string` | validate with AND or OR condition | &nbsp; |
8003
+ | settings | `IFSettings` | the given filter settings | &nbsp; |
7398
8004
 
7399
8005
 
7400
8006
 
@@ -7402,17 +8008,13 @@ Validates if the scope settings is satisfied by properties in multiple scopes
7402
8008
  ##### Returns
7403
8009
 
7404
8010
 
7405
- - true iif there are scopes to be satisfied; false: one or none scopes to be satisfied
7406
-
7407
-
7408
-
8011
+ - a new filter settings object
7409
8012
 
7410
- ### dist/filters/helpers/settings/areMultipleScopesByProperty.js
7411
8013
 
7412
8014
 
7413
- #### areMultipleScopesByProperty(settings, property)
8015
+ #### getFilterSettingsByOnlyDataScope(settings)
7414
8016
 
7415
- Validates if the scope settings is satisfied the property in multiple scopes
8017
+ Gets the filter settings when there is only the data scope
7416
8018
 
7417
8019
 
7418
8020
 
@@ -7421,8 +8023,7 @@ Validates if the scope settings is satisfied the property in multiple scopes
7421
8023
 
7422
8024
  | Name | Type | Description | |
7423
8025
  | ---- | ---- | ----------- | -------- |
7424
- | settings | `IFSettings` | the filter setting | &nbsp; |
7425
- | property | `string` | the property or the string path of the scope settings | &nbsp; |
8026
+ | settings | `IFSettings` | the given filter settings | &nbsp; |
7426
8027
 
7427
8028
 
7428
8029
 
@@ -7430,20 +8031,14 @@ Validates if the scope settings is satisfied the property in multiple scopes
7430
8031
  ##### Returns
7431
8032
 
7432
8033
 
7433
- - true if there are scopes to be satisfied; false: one or none scopes to be satisfied
7434
-
7435
-
7436
-
8034
+ - a new filter settings object
7437
8035
 
7438
- ### dist/filters/helpers/settings/getFilterSettings.js
7439
8036
 
7440
8037
 
7441
- #### getFilterSettings(filterSettings, allowedScopes, otherSettings)
8038
+ #### getFilterSettingsBySkippingGeneralScopes(settings)
7442
8039
 
7443
- Gets a new filter settings object according to various conditions
7444
- - By allowed scopes. Different implementation could accept some scopes, so the forbidden scopes into the filter settings will be skipped
7445
- - If there is not filter settings provived, a default one is returned
7446
- - The returned filter settings depend on the coexisting scopes
8040
+ Gets the filter settings when there are not general scopes allowed
8041
+ The general scopes could be the GLOBAL, PAGE, TAB and PANEL types.
7447
8042
 
7448
8043
 
7449
8044
 
@@ -7452,9 +8047,7 @@ Gets a new filter settings object according to various conditions
7452
8047
 
7453
8048
  | Name | Type | Description | |
7454
8049
  | ---- | ---- | ----------- | -------- |
7455
- | filterSettings | `IFSettings` | the given filter settings | &nbsp; |
7456
- | allowedScopes | `Array.<IFScope>` | a collection of scope types that are permitted | &nbsp; |
7457
- | otherSettings | `IFSettings` | another filter settings object to be merged with the filterSettings param | &nbsp; |
8050
+ | settings | `IFSettings` | the given filter settings | &nbsp; |
7458
8051
 
7459
8052
 
7460
8053
 
@@ -7466,9 +8059,9 @@ Gets a new filter settings object according to various conditions
7466
8059
 
7467
8060
 
7468
8061
 
7469
- #### getFilterSettingsByMultipleScopes(settings, allowedScopes)
8062
+ #### getFilterSettingsByMultipleNoPanelGlobalScopes(settings)
7470
8063
 
7471
- Gets the filter settings by multiple scopes conditions
8064
+ Gets the filter settings when there are no panel scopes and multiple scopes allowed.
7472
8065
 
7473
8066
 
7474
8067
 
@@ -7478,7 +8071,6 @@ Gets the filter settings by multiple scopes conditions
7478
8071
  | Name | Type | Description | |
7479
8072
  | ---- | ---- | ----------- | -------- |
7480
8073
  | settings | `IFSettings` | the given filter settings | &nbsp; |
7481
- | allowedScopes | `Array.<IFScope>` | a collection of scope types that are permitted | &nbsp; |
7482
8074
 
7483
8075
 
7484
8076
 
@@ -7490,9 +8082,9 @@ Gets the filter settings by multiple scopes conditions
7490
8082
 
7491
8083
 
7492
8084
 
7493
- #### getFilterSettingsByOnlyScope(settings, allowedScopes)
8085
+ #### getFilterSettingsByMultipleNoPanelScopes(settings)
7494
8086
 
7495
- Gets the filter settings when a single scope is permitted
8087
+ Gets the filter settings when there are no panel scopes and multiple scopes allowed.
7496
8088
 
7497
8089
 
7498
8090
 
@@ -7502,7 +8094,6 @@ Gets the filter settings when a single scope is permitted
7502
8094
  | Name | Type | Description | |
7503
8095
  | ---- | ---- | ----------- | -------- |
7504
8096
  | settings | `IFSettings` | the given filter settings | &nbsp; |
7505
- | allowedScopes | `Array.<IFScope>` | a collection of scope types that are permitted | &nbsp; |
7506
8097
 
7507
8098
 
7508
8099
 
@@ -7514,9 +8105,13 @@ Gets the filter settings when a single scope is permitted
7514
8105
 
7515
8106
 
7516
8107
 
7517
- #### getFilterSettingsByNoScopes(settings)
7518
8108
 
7519
- Gets the filter settings when there is not scope to accept
8109
+ ### dist/filters/helpers/settings/getScopeColorSetting.js
8110
+
8111
+
8112
+ #### getScopeColorSetting(settings, scope)
8113
+
8114
+ Gets the color of the scope in the settings object
7520
8115
 
7521
8116
 
7522
8117
 
@@ -7525,7 +8120,8 @@ Gets the filter settings when there is not scope to accept
7525
8120
 
7526
8121
  | Name | Type | Description | |
7527
8122
  | ---- | ---- | ----------- | -------- |
7528
- | settings | `IFSettings` | the given filter settings | &nbsp; |
8123
+ | settings | `IFSettings` | the filter settings | &nbsp; |
8124
+ | scope | `IFScope` | the scope type | &nbsp; |
7529
8125
 
7530
8126
 
7531
8127
 
@@ -7533,14 +8129,17 @@ Gets the filter settings when there is not scope to accept
7533
8129
  ##### Returns
7534
8130
 
7535
8131
 
7536
- - a new filter settings object
8132
+ - an string with the color.
7537
8133
 
7538
8134
 
7539
8135
 
7540
- #### getFilterSettingsByGeneralOnlyScope(settings)
7541
8136
 
7542
- Gets the filter settings when a general scope are only permitted
7543
- The general scopes could be the GLOBAL, PAGE, TAB and PANEL types.
8137
+ ### dist/filters/helpers/settings/getScopeSettings.js
8138
+
8139
+
8140
+ #### getScopeSettings(settings, scope)
8141
+
8142
+ Gets the scope settings by the scope type
7544
8143
 
7545
8144
 
7546
8145
 
@@ -7549,7 +8148,8 @@ The general scopes could be the GLOBAL, PAGE, TAB and PANEL types.
7549
8148
 
7550
8149
  | Name | Type | Description | |
7551
8150
  | ---- | ---- | ----------- | -------- |
7552
- | settings | `IFSettings` | the given filter settings | &nbsp; |
8151
+ | settings | `IFSettings` | the filter settings | &nbsp; |
8152
+ | scope | `IFScope` | the scope type | &nbsp; |
7553
8153
 
7554
8154
 
7555
8155
 
@@ -7557,13 +8157,17 @@ The general scopes could be the GLOBAL, PAGE, TAB and PANEL types.
7557
8157
  ##### Returns
7558
8158
 
7559
8159
 
7560
- - a new filter settings object
8160
+ - the scope settings
7561
8161
 
7562
8162
 
7563
8163
 
7564
- #### getFilterSettingsByNoDefaultScope(settings)
7565
8164
 
7566
- Gets the filter settings when there is not a default scope type
8165
+ ### dist/filters/helpers/settings/getScopesSettings.js
8166
+
8167
+
8168
+ #### getScopesSettings(scopes)
8169
+
8170
+ Gets the scopes settings as array
7567
8171
 
7568
8172
 
7569
8173
 
@@ -7572,7 +8176,7 @@ Gets the filter settings when there is not a default scope type
7572
8176
 
7573
8177
  | Name | Type | Description | |
7574
8178
  | ---- | ---- | ----------- | -------- |
7575
- | settings | `IFSettings` | the given filter settings | &nbsp; |
8179
+ | scopes | `IFSettingsScopes` | the scopes settings | &nbsp; |
7576
8180
 
7577
8181
 
7578
8182
 
@@ -7580,13 +8184,17 @@ Gets the filter settings when there is not a default scope type
7580
8184
  ##### Returns
7581
8185
 
7582
8186
 
7583
- - a new filter settings object
8187
+ - an array of the scopes settings
7584
8188
 
7585
8189
 
7586
8190
 
7587
- #### getFilterSettingsByOnlyDefaultScope(settings)
7588
8191
 
7589
- Gets the filter settings when there is only a default scope type
8192
+ ### dist/filters/helpers/settings/getScopesToDisplay.js
8193
+
8194
+
8195
+ #### getScopesToDisplay(settings)
8196
+
8197
+ Gets the scope allowed to display
7590
8198
 
7591
8199
 
7592
8200
 
@@ -7595,7 +8203,7 @@ Gets the filter settings when there is only a default scope type
7595
8203
 
7596
8204
  | Name | Type | Description | |
7597
8205
  | ---- | ---- | ----------- | -------- |
7598
- | settings | `IFSettings` | the given filter settings | &nbsp; |
8206
+ | settings | `IFSettings` | the filter settings | &nbsp; |
7599
8207
 
7600
8208
 
7601
8209
 
@@ -7603,13 +8211,17 @@ Gets the filter settings when there is only a default scope type
7603
8211
  ##### Returns
7604
8212
 
7605
8213
 
7606
- - a new filter settings object
8214
+ - an array of the scopes settings
7607
8215
 
7608
8216
 
7609
8217
 
7610
- #### getFilterSettingsByDefaultWithOneAdditionalScope(settings)
7611
8218
 
7612
- Gets the filter settings when there are a default scope and other single scope
8219
+ ### dist/filters/helpers/settings/isLeastSingleScopeByProperties.js
8220
+
8221
+
8222
+ #### isLeastSingleScopeByProperties(settings, scopeProperties, condition)
8223
+
8224
+ Validates if the scope settings is satisfied by properties at least in one scope
7613
8225
 
7614
8226
 
7615
8227
 
@@ -7618,7 +8230,9 @@ Gets the filter settings when there are a default scope and other single scope
7618
8230
 
7619
8231
  | Name | Type | Description | |
7620
8232
  | ---- | ---- | ----------- | -------- |
7621
- | settings | `IFSettings` | the given filter settings | &nbsp; |
8233
+ | settings | `IFSettings` | the filter setting | &nbsp; |
8234
+ | scopeProperties | `string` | the property or the string path of the scope settings | &nbsp; |
8235
+ | condition | `string` | validate with AND or OR condition | &nbsp; |
7622
8236
 
7623
8237
 
7624
8238
 
@@ -7626,13 +8240,17 @@ Gets the filter settings when there are a default scope and other single scope
7626
8240
  ##### Returns
7627
8241
 
7628
8242
 
7629
- - a new filter settings object
8243
+ - true if there is one scope to be satisfied; false: none scopes to be satisfied
7630
8244
 
7631
8245
 
7632
8246
 
7633
- #### getFilterSettingsByOnlyPanelScope(settings)
7634
8247
 
7635
- Gets the filter settings when there is only the panel scope
8248
+ ### dist/filters/helpers/settings/isLeastSingleScopeByProperty.js
8249
+
8250
+
8251
+ #### isLeastSingleScopeByProperty(settings, property)
8252
+
8253
+ Validates if the scope settings is satisfied by a property at least in one scope
7636
8254
 
7637
8255
 
7638
8256
 
@@ -7641,7 +8259,8 @@ Gets the filter settings when there is only the panel scope
7641
8259
 
7642
8260
  | Name | Type | Description | |
7643
8261
  | ---- | ---- | ----------- | -------- |
7644
- | settings | `IFSettings` | the given filter settings | &nbsp; |
8262
+ | settings | `IFSettings` | the filter setting | &nbsp; |
8263
+ | property | `string` | the property or the string path of the scope settings | &nbsp; |
7645
8264
 
7646
8265
 
7647
8266
 
@@ -7649,13 +8268,17 @@ Gets the filter settings when there is only the panel scope
7649
8268
  ##### Returns
7650
8269
 
7651
8270
 
7652
- - a new filter settings object
8271
+ - true if there is one scope to be satisfied; false: none scopes to be satisfied
7653
8272
 
7654
8273
 
7655
8274
 
7656
- #### getFilterSettingsByOnlyDataScope(settings)
7657
8275
 
7658
- Gets the filter settings when there is only the data scope
8276
+ ### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
8277
+
8278
+
8279
+ #### excludeUIFiltersByAggregate(uFilters)
8280
+
8281
+ Excludes Aggregate Filters in the Flattened UI Filters array
7659
8282
 
7660
8283
 
7661
8284
 
@@ -7664,7 +8287,7 @@ Gets the filter settings when there is only the data scope
7664
8287
 
7665
8288
  | Name | Type | Description | |
7666
8289
  | ---- | ---- | ----------- | -------- |
7667
- | settings | `IFSettings` | the given filter settings | &nbsp; |
8290
+ | uFilters | | Collection of Flat UI Filters | &nbsp; |
7668
8291
 
7669
8292
 
7670
8293
 
@@ -7672,14 +8295,17 @@ Gets the filter settings when there is only the data scope
7672
8295
  ##### Returns
7673
8296
 
7674
8297
 
7675
- - a new filter settings object
8298
+ - a new Flat UI Filters that were excluded the aggregate filters
7676
8299
 
7677
8300
 
7678
8301
 
7679
- #### getFilterSettingsBySkippingGeneralScopes(settings)
7680
8302
 
7681
- Gets the filter settings when there are not general scopes allowed
7682
- The general scopes could be the GLOBAL, PAGE, TAB and PANEL types.
8303
+ ### dist/filters/helpers/ui/getFilterPropertyLabel.js
8304
+
8305
+
8306
+ #### getFilterPropertyLabel(filter)
8307
+
8308
+ Gets the label of the filter property
7683
8309
 
7684
8310
 
7685
8311
 
@@ -7688,7 +8314,7 @@ The general scopes could be the GLOBAL, PAGE, TAB and PANEL types.
7688
8314
 
7689
8315
  | Name | Type | Description | |
7690
8316
  | ---- | ---- | ----------- | -------- |
7691
- | settings | `IFSettings` | the given filter settings | &nbsp; |
8317
+ | filter | | The UI Filter | &nbsp; |
7692
8318
 
7693
8319
 
7694
8320
 
@@ -7696,13 +8322,17 @@ The general scopes could be the GLOBAL, PAGE, TAB and PANEL types.
7696
8322
  ##### Returns
7697
8323
 
7698
8324
 
7699
- - a new filter settings object
8325
+ - a string of the filter property label
7700
8326
 
7701
8327
 
7702
8328
 
7703
- #### getFilterSettingsByMultipleNoPanelGlobalScopes(settings)
7704
8329
 
7705
- Gets the filter settings when there are no panel scopes and multiple scopes allowed.
8330
+ ### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
8331
+
8332
+
8333
+ #### excludeUIFlatFiltersByScopes(uFilters, scopes)
8334
+
8335
+ Excludes and returns a UI Flat Filters without filters by the given scopes
7706
8336
 
7707
8337
 
7708
8338
 
@@ -7711,7 +8341,8 @@ Gets the filter settings when there are no panel scopes and multiple scopes allo
7711
8341
 
7712
8342
  | Name | Type | Description | |
7713
8343
  | ---- | ---- | ----------- | -------- |
7714
- | settings | `IFSettings` | the given filter settings | &nbsp; |
8344
+ | uFilters | | The Flatten UI Filters | &nbsp; |
8345
+ | scopes | | collection of scopes types | &nbsp; |
7715
8346
 
7716
8347
 
7717
8348
 
@@ -7719,13 +8350,17 @@ Gets the filter settings when there are no panel scopes and multiple scopes allo
7719
8350
  ##### Returns
7720
8351
 
7721
8352
 
7722
- - a new filter settings object
8353
+ - The new array of UI Flattened filters
7723
8354
 
7724
8355
 
7725
8356
 
7726
- #### getFilterSettingsByMultipleNoPanelScopes(settings)
7727
8357
 
7728
- Gets the filter settings when there are no panel scopes and multiple scopes allowed.
8358
+ ### dist/filters/helpers/ui/getOutputFormatByColumn.js
8359
+
8360
+
8361
+ #### getOutputFormatByColumn(column, datasets)
8362
+
8363
+ Gets output format object from Datasets by the given column. Item of the datasets array must have outputformat item in order to be returned
7729
8364
 
7730
8365
 
7731
8366
 
@@ -7734,7 +8369,8 @@ Gets the filter settings when there are no panel scopes and multiple scopes allo
7734
8369
 
7735
8370
  | Name | Type | Description | |
7736
8371
  | ---- | ---- | ----------- | -------- |
7737
- | settings | `IFSettings` | the given filter settings | &nbsp; |
8372
+ | column | | The column | &nbsp; |
8373
+ | datasets | | array of datasets | &nbsp; |
7738
8374
 
7739
8375
 
7740
8376
 
@@ -7742,17 +8378,18 @@ Gets the filter settings when there are no panel scopes and multiple scopes allo
7742
8378
  ##### Returns
7743
8379
 
7744
8380
 
7745
- - a new filter settings object
8381
+ - The output format object
7746
8382
 
7747
8383
 
7748
8384
 
7749
8385
 
7750
- ### dist/filters/helpers/settings/getScopeColorSetting.js
8386
+ ### dist/filters/helpers/ui/getQrveyIdsByUIFilters.js
7751
8387
 
7752
8388
 
7753
- #### getScopeColorSetting(settings, scope)
8389
+ #### getQrveyIdsByUIFilters(uiFilter)
7754
8390
 
7755
- Gets the color of the scope in the settings object
8391
+ Gets a collection of Qrvey IDs in the UI Filter structure.
8392
+ Looks around all filter structure finding the qrveyid propertty in each dataset
7756
8393
 
7757
8394
 
7758
8395
 
@@ -7761,8 +8398,7 @@ Gets the color of the scope in the settings object
7761
8398
 
7762
8399
  | Name | Type | Description | |
7763
8400
  | ---- | ---- | ----------- | -------- |
7764
- | settings | `IFSettings` | the filter settings | &nbsp; |
7765
- | scope | `IFScope` | the scope type | &nbsp; |
8401
+ | uiFilter | | | &nbsp; |
7766
8402
 
7767
8403
 
7768
8404
 
@@ -7770,27 +8406,56 @@ Gets the color of the scope in the settings object
7770
8406
  ##### Returns
7771
8407
 
7772
8408
 
7773
- - an string with the color.
8409
+ - `Void`
7774
8410
 
7775
8411
 
7776
8412
 
7777
8413
 
7778
- ### dist/filters/helpers/settings/getScopeSettings.js
8414
+ ### dist/filters/helpers/ui/getUIFlatFilterByParams.js
7779
8415
 
7780
8416
 
7781
- #### getScopeSettings(settings, scope)
8417
+ #### getUIFlatFilterByParams()
7782
8418
 
7783
- Gets the scope settings by the scope type
8419
+ Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
8420
+ The validation to filter the stored filter is depending on:
8421
+ - Column
8422
+ - Qrvey ID,
8423
+ - Scope type
8424
+ - Scope ID
8425
+ - Panel ID
8426
+ - Validator type
8427
+ - Property type
7784
8428
 
7785
8429
 
7786
8430
 
7787
8431
 
7788
- ##### Parameters
7789
8432
 
7790
- | Name | Type | Description | |
7791
- | ---- | ---- | ----------- | -------- |
7792
- | settings | `IFSettings` | the filter settings | &nbsp; |
7793
- | scope | `IFScope` | the scope type | &nbsp; |
8433
+
8434
+ ##### Returns
8435
+
8436
+
8437
+ - The index of the uFilter array or the Filter object s
8438
+
8439
+
8440
+
8441
+
8442
+ ### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
8443
+
8444
+
8445
+ #### getUIFlatFiltersByParams()
8446
+
8447
+ Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
8448
+ The validation to filter the stored filter is depending on:
8449
+ - Column
8450
+ - Qrvey ID,
8451
+ - Scope type
8452
+ - Scope ID
8453
+ - Panel ID
8454
+ - Validator type
8455
+ - Property type
8456
+ - Enabled flags
8457
+
8458
+
7794
8459
 
7795
8460
 
7796
8461
 
@@ -7798,17 +8463,17 @@ Gets the scope settings by the scope type
7798
8463
  ##### Returns
7799
8464
 
7800
8465
 
7801
- - the scope settings
8466
+ - The index of the uFilter array or the Filter object s
7802
8467
 
7803
8468
 
7804
8469
 
7805
8470
 
7806
- ### dist/filters/helpers/settings/getScopesToDisplay.js
8471
+ ### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
7807
8472
 
7808
8473
 
7809
- #### getScopesToDisplay(settings)
8474
+ #### getUIFlatFiltersByScopes(uFilters, scopes)
7810
8475
 
7811
- Gets the scope allowed to display
8476
+ Filters and gets a UI Flatten Filters by the given scopes
7812
8477
 
7813
8478
 
7814
8479
 
@@ -7817,7 +8482,8 @@ Gets the scope allowed to display
7817
8482
 
7818
8483
  | Name | Type | Description | |
7819
8484
  | ---- | ---- | ----------- | -------- |
7820
- | settings | `IFSettings` | the filter settings | &nbsp; |
8485
+ | uFilters | | The Flatten UI Filters | &nbsp; |
8486
+ | scopes | | collection of scopes types | &nbsp; |
7821
8487
 
7822
8488
 
7823
8489
 
@@ -7825,17 +8491,17 @@ Gets the scope allowed to display
7825
8491
  ##### Returns
7826
8492
 
7827
8493
 
7828
- - an array of the scopes settings
8494
+ - The new array of UI Flattened filters
7829
8495
 
7830
8496
 
7831
8497
 
7832
8498
 
7833
- ### dist/filters/helpers/settings/getScopesSettings.js
8499
+ ### dist/filters/helpers/ui/getUIValues.js
7834
8500
 
7835
8501
 
7836
- #### getScopesSettings(scopes)
8502
+ #### getUIValues(filter, settings)
7837
8503
 
7838
- Gets the scopes settings as array
8504
+ Gets the UI Values generated depending on the validator
7839
8505
 
7840
8506
 
7841
8507
 
@@ -7844,7 +8510,8 @@ Gets the scopes settings as array
7844
8510
 
7845
8511
  | Name | Type | Description | |
7846
8512
  | ---- | ---- | ----------- | -------- |
7847
- | scopes | `IFSettingsScopes` | the scopes settings | &nbsp; |
8513
+ | filter | | the filter structure | &nbsp; |
8514
+ | settings | | a settings for this function | &nbsp; |
7848
8515
 
7849
8516
 
7850
8517
 
@@ -7852,17 +8519,17 @@ Gets the scopes settings as array
7852
8519
  ##### Returns
7853
8520
 
7854
8521
 
7855
- - an array of the scopes settings
8522
+ - an array of values
7856
8523
 
7857
8524
 
7858
8525
 
7859
8526
 
7860
- ### dist/filters/helpers/settings/isLeastSingleScopeByProperties.js
8527
+ ### dist/filters/helpers/ui/getUpdatedUIFilters.js
7861
8528
 
7862
8529
 
7863
- #### isLeastSingleScopeByProperties(settings, scopeProperties, condition)
8530
+ #### getUpdatedUIFilters(data, datasets)
7864
8531
 
7865
- Validates if the scope settings is satisfied by properties at least in one scope
8532
+ Gets a new UI Filter structure with a datasets/columns info updates
7866
8533
 
7867
8534
 
7868
8535
 
@@ -7871,9 +8538,8 @@ Validates if the scope settings is satisfied by properties at least in one scope
7871
8538
 
7872
8539
  | Name | Type | Description | |
7873
8540
  | ---- | ---- | ----------- | -------- |
7874
- | settings | `IFSettings` | the filter setting | &nbsp; |
7875
- | scopeProperties | `string` | the property or the string path of the scope settings | &nbsp; |
7876
- | condition | `string` | validate with AND or OR condition | &nbsp; |
8541
+ | data | | The UI Filter structure | &nbsp; |
8542
+ | datasets | | An array of datasets/column info used for updating the data | &nbsp; |
7877
8543
 
7878
8544
 
7879
8545
 
@@ -7881,17 +8547,17 @@ Validates if the scope settings is satisfied by properties at least in one scope
7881
8547
  ##### Returns
7882
8548
 
7883
8549
 
7884
- - true if there is one scope to be satisfied; false: none scopes to be satisfied
8550
+ - A new UI FIlter structure
7885
8551
 
7886
8552
 
7887
8553
 
7888
8554
 
7889
- ### dist/filters/helpers/settings/isLeastSingleScopeByProperty.js
8555
+ ### dist/filters/helpers/ui/resolveUIFlatFilterByParams.js
7890
8556
 
7891
8557
 
7892
- #### isLeastSingleScopeByProperty(settings, property)
8558
+ #### resolveUIFlatFilterByParams(filter, params)
7893
8559
 
7894
- Validates if the scope settings is satisfied by a property at least in one scope
8560
+ Resolves conditions between UI flattened filter and given parameters
7895
8561
 
7896
8562
 
7897
8563
 
@@ -7900,8 +8566,8 @@ Validates if the scope settings is satisfied by a property at least in one scope
7900
8566
 
7901
8567
  | Name | Type | Description | |
7902
8568
  | ---- | ---- | ----------- | -------- |
7903
- | settings | `IFSettings` | the filter setting | &nbsp; |
7904
- | property | `string` | the property or the string path of the scope settings | &nbsp; |
8569
+ | filter | | UI Flatten Filter | &nbsp; |
8570
+ | params | | Parameters to validate | &nbsp; |
7905
8571
 
7906
8572
 
7907
8573
 
@@ -7909,7 +8575,7 @@ Validates if the scope settings is satisfied by a property at least in one scope
7909
8575
  ##### Returns
7910
8576
 
7911
8577
 
7912
- - true if there is one scope to be satisfied; false: none scopes to be satisfied
8578
+ - true: the conditions are satisfied.
7913
8579
 
7914
8580
 
7915
8581