@qrvey/utils 1.2.9-15 → 1.2.9-16

package/README.md

@@ -1,4 +1,4 @@
-# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-15*
+# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-16*
 
 > Helper, Utils for all Qrvey Projects
 
@@ -1538,26 +1538,6 @@ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
 
 
 
-### dist/filters/classes/FilterInputErrorHandler.js
-
-
-#### new FilterInputErrorHandler() 
-
-
-
-
-
-
-
-
-##### Returns
-
-
-- `Void`
-
-
-
-
 ### dist/filters/helpers/applyHierarchyForAggFilters.js
 
 
@@ -1669,6 +1649,26 @@ Gets the Scopes IDS for the Available Scope function by any config
 
 
 
+### dist/filters/classes/FilterInputErrorHandler.js
+
+
+#### new FilterInputErrorHandler() 
+
+
+
+
+
+
+
+
+##### Returns
+
+
+- `Void`
+
+
+
+
 ### dist/general/array/delete.js
 
 
@@ -1868,6 +1868,33 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
 
 
 
+### dist/general/string/capitalize.js
+
+
+#### capitalize(text) 
+
+Upper case the first letter of a given text
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| text | `String`  |  |   |
+
+
+
+
+##### Returns
+
+
+- `String`  a capitalized text
+
+
+
+
 ### dist/general/mix/compareDeep.js
 
 
@@ -2565,12 +2592,12 @@ serialize object to url param
 
 
 
-### dist/general/string/capitalize.js
+### dist/qrvey/helpers/getColumnsLabel.js
 
 
-#### capitalize(text) 
+#### getColumnLabels(column) 
 
-Upper case the first letter of a given text
+Get an string of the properties of the given column.
 
 
 
@@ -2579,7 +2606,7 @@ Upper case the first letter of a given text
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| text | `String`  |  |   |
+| column |  | The column |   |
 
 
 
@@ -2587,17 +2614,18 @@ Upper case the first letter of a given text
 ##### Returns
 
 
-- `String`  a capitalized text
+-  an string with the property, aggregate or calculation label.
 
 
 
 
-### dist/qrvey/helpers/getColumnsLabel.js
+### dist/qrvey/helpers/getValueWithSuffixes.js
 
 
-#### getColumnLabels(column) 
+#### getValueWithSuffixes(value, suffixes) 
 
-Get an string of the properties of the given column.
+Get a string value with suffixes if available.
+Add suffix into the value string. Prioritized for numeric values.
 
 
 
@@ -2606,7 +2634,8 @@ Get an string of the properties of the given column.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| column |  | The column |   |
+| value |  | a number or string |   |
+| suffixes |  | An object with singular or plural suffix string. |   |
 
 
 
@@ -2614,17 +2643,17 @@ Get an string of the properties of the given column.
 ##### Returns
 
 
--  an string with the property, aggregate or calculation label.
+-  a string value with suffix
 
 
 
 
-### dist/services/api/getAllDatasets.api.js
+### dist/qrvey/helpers/transformValue.js
 
 
-#### getAllDatasets(config, pickDatasets) 
+#### transformValue(value, settings) 
 
-Get a dataset list from a collection of Qrvey IDs
+Transforms a value depending of localization/globalization and extras settings.
 
 
 
@@ -2633,8 +2662,8 @@ Get a dataset list from a collection of Qrvey IDs
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| config |  | the widget config. Includes the appid and others configuration properties |   |
-| pickDatasets |  | Collection of Qrvey IDs for filtering the request |   |
+| value |  | A value to transform |   |
+| settings |  | The settings of the transformValue function |   |
 
 
 
@@ -2642,17 +2671,36 @@ Get a dataset list from a collection of Qrvey IDs
 ##### Returns
 
 
--  a promise
+-  A transformed value
 
 
 
+#### getOutputFormat(settings) 
 
-### dist/services/api/getAllQrveys.api.js
+Gets the outputformat settings
 
 
-#### getAllQrveys(config, params) 
 
-POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| settings |  | The settings of the transformValue function |   |
+
+
+
+
+##### Returns
+
+
+-  the outputformat settings
+
+
+
+#### getFormatConfig(settings) 
+
+Gets the format config
 
 
 
@@ -2661,8 +2709,7 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| config |  | Configuration |   |
-| params |  | Object for getting precise data |   |
+| settings |  | The settings of the transformValue function |   |
 
 
 
@@ -2670,17 +2717,17 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
 ##### Returns
 
 
-- `Void`
+-  the format config
 
 
 
 
-### dist/services/api/getDatasetColumns.api.js
+### dist/services/api/getAllDatasets.api.js
 
 
-#### getDatasetColumns(qrveyid) 
+#### getAllDatasets(config, pickDatasets) 
 
-Get a dataset by Qrvey ID
+Get a dataset list from a collection of Qrvey IDs
 
 
 
@@ -2689,7 +2736,8 @@ Get a dataset by Qrvey ID
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| qrveyid |  | The Qrvey ID |   |
+| config |  | the widget config. Includes the appid and others configuration properties |   |
+| pickDatasets |  | Collection of Qrvey IDs for filtering the request |   |
 
 
 
@@ -2702,12 +2750,12 @@ Get a dataset by Qrvey ID
 
 
 
-### dist/typescript/decorators/Throttled.js
+### dist/services/api/getAllQrveys.api.js
 
 
-#### Throttled(time) 
+#### getAllQrveys(config, params) 
 
-(Method Decorator) Throttled Class Method
+POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
 
 
 
@@ -2716,7 +2764,8 @@ Get a dataset by Qrvey ID
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| time |  | (optional) deafult 500 |   |
+| config |  | Configuration |   |
+| params |  | Object for getting precise data |   |
 
 
 
@@ -2729,12 +2778,12 @@ Get a dataset by Qrvey ID
 
 
 
-### dist/typescript/decorators/Debounce.js
+### dist/services/api/getDatasetColumns.api.js
 
 
-#### Debounce(time) 
+#### getDatasetColumns(qrveyid) 
 
-(Method Decorator) Debounce Class Method
+Get a dataset by Qrvey ID
 
 
 
@@ -2743,7 +2792,7 @@ Get a dataset by Qrvey ID
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| time |  | (optional) deafult 500 |   |
+| qrveyid |  | The Qrvey ID |   |
 
 
 
@@ -2751,7 +2800,7 @@ Get a dataset by Qrvey ID
 ##### Returns
 
 
-- `Void`
+-  a promise
 
 
 
@@ -2840,6 +2889,60 @@ try to find this string as a variable on Windows object
 
 
 
+### dist/typescript/decorators/Debounce.js
+
+
+#### Debounce(time) 
+
+(Method Decorator) Debounce Class Method
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| time |  | (optional) deafult 500 |   |
+
+
+
+
+##### Returns
+
+
+- `Void`
+
+
+
+
+### dist/typescript/decorators/Throttled.js
+
+
+#### Throttled(time) 
+
+(Method Decorator) Throttled Class Method
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| time |  | (optional) deafult 500 |   |
+
+
+
+
+##### Returns
+
+
+- `Void`
+
+
+
+
 ### dist/dates/relative/helpers/formatStatement.js
 
 
@@ -3245,12 +3348,21 @@ Returns a filter builder config object by a any given config
 
 
 
-### dist/filters/helpers/common/areFiltersEquals.js
+### dist/filters/helpers/common/excludeFiltersByParams.js
 
 
-#### areFiltersEquals(filter1, filter2) 
+#### excludeFiltersByParams(filterData, params) 
 
-Validates if both filters are the same
+Excludes filters from the given Filters.
+The validation to filter the stored filter is depending on:
+- Column
+- Qrvey ID
+- Scope type
+- Scope ID
+- Panel ID
+- Validator type
+- Property type
+- Enabled flags
 
 
 
@@ -3259,8 +3371,8 @@ Validates if both filters are the same
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter1 |  | filter 1 |   |
-| filter2 |  | filter 2 |   |
+| filterData |  | The Filter Data or the UI Filter Data |   |
+| params |  | given parameters to validate the filter data |   |
 
 
 
@@ -3268,7 +3380,7 @@ Validates if both filters are the same
 ##### Returns
 
 
--  true: the filters are equal; false: the filters are NOT equal
+-  a new Filter object structure
 
 
 
@@ -3300,21 +3412,12 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
 
 
 
-### dist/filters/helpers/common/excludeFiltersByParams.js
+### dist/filters/helpers/common/excludeFiltersByScopes.js
 
 
-#### excludeFiltersByParams(filterData, params) 
+#### excludeFiltersByScopes(filterData, scopes) 
 
-Excludes filters from the given Filters.
-The validation to filter the stored filter is depending on:
-- Column
-- Qrvey ID
-- Scope type
-- Scope ID
-- Panel ID
-- Validator type
-- Property type
-- Enabled flags
+Excludes and returns a filter data without filters by the given scopes
 
 
 
@@ -3323,8 +3426,8 @@ The validation to filter the stored filter is depending on:
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The Filter Data or the UI Filter Data |   |
-| params |  | given parameters to validate the filter data |   |
+| filterData |  | The Filter Data |   |
+| scopes |  | collection of scopes to be as filtering parameters |   |
 
 
 
@@ -3332,17 +3435,17 @@ The validation to filter the stored filter is depending on:
 ##### Returns
 
 
--  a new Filter object structure
+-  The new Filter Data without filters by the given scopes.
 
 
 
 
-### dist/filters/helpers/common/excludeFiltersByScopes.js
+### dist/filters/helpers/common/getFilterColumnLabel.js
 
 
-#### excludeFiltersByScopes(filterData, scopes) 
+#### getFilterColumnLabel(column) 
 
-Excludes and returns a filter data without filters by the given scopes
+Get an string of the properties of the given filter column.
 
 
 
@@ -3351,8 +3454,7 @@ Excludes and returns a filter data without filters by the given scopes
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The Filter Data |   |
-| scopes |  | collection of scopes to be as filtering parameters |   |
+| column |  | The filter column |   |
 
 
 
@@ -3360,7 +3462,7 @@ Excludes and returns a filter data without filters by the given scopes
 ##### Returns
 
 
--  The new Filter Data without filters by the given scopes.
+-  an string with the property, aggregate or calculation label.
 
 
 
@@ -3392,12 +3494,12 @@ Gets the Filter Label + Column label
 
 
 
-### dist/filters/helpers/common/getFilterColumnLabel.js
+### dist/filters/helpers/common/areFiltersEquals.js
 
 
-#### getFilterColumnLabel(column) 
+#### areFiltersEquals(filter1, filter2) 
 
-Get an string of the properties of the given filter column.
+Validates if both filters are the same
 
 
 
@@ -3406,7 +3508,8 @@ Get an string of the properties of the given filter column.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| column |  | The filter column |   |
+| filter1 |  | filter 1 |   |
+| filter2 |  | filter 2 |   |
 
 
 
@@ -3414,7 +3517,7 @@ Get an string of the properties of the given filter column.
 ##### Returns
 
 
--  an string with the property, aggregate or calculation label.
+-  true: the filters are equal; false: the filters are NOT equal
 
 
 
@@ -3632,12 +3735,12 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
 
 
 
-### dist/filters/helpers/common/haveFiltersByDataset.js
+### dist/filters/helpers/common/getParamsToGetFilterSettings.js
 
 
-#### haveFiltersByDataset(filterData, qrveyid) 
+#### getParamsToGetFilterSettings(settings) 
 
-Validates if the filter data has filters by a dataset ID (Qrvey ID).
+Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
 
 
 
@@ -3646,8 +3749,7 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | the filter data or the UI filter data. |   |
-| qrveyid |  | The Qrvey ID |   |
+| settings |  | an object to the ParamsToGetFilter settings |   |
 
 
 
@@ -3655,17 +3757,17 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
 ##### Returns
 
 
--  true: the filter data has filters by the Qrvey ID
+-  a new ParamsToGetFilter settings object.
 
 
 
 
-### dist/filters/helpers/common/getParamsToGetFilterSettings.js
+### dist/filters/helpers/common/haveFiltersByDataset.js
 
 
-#### getParamsToGetFilterSettings(settings) 
+#### haveFiltersByDataset(filterData, qrveyid) 
 
-Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
+Validates if the filter data has filters by a dataset ID (Qrvey ID).
 
 
 
@@ -3674,7 +3776,8 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| settings |  | an object to the ParamsToGetFilter settings |   |
+| filterData |  | the filter data or the UI filter data. |   |
+| qrveyid |  | The Qrvey ID |   |
 
 
 
@@ -3682,7 +3785,7 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
 ##### Returns
 
 
--  a new ParamsToGetFilter settings object.
+-  true: the filter data has filters by the Qrvey ID
 
 
 
@@ -3742,12 +3845,12 @@ Determines if the filter column and property is a distinct group dates type
 
 
 
-### dist/filters/helpers/common/isNullValidator.js
+### dist/filters/helpers/common/isInValidator.js
 
 
-#### isNullValidator(validator) 
+#### isInValidator(validator) 
 
-Checks if the given validator is a Null type.
+Validates if the given validator is a In type
 
 
 
@@ -3756,7 +3859,7 @@ Checks if the given validator is a Null type.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The Filter Validator |   |
+| validator |  | The validator |   |
 
 
 
@@ -3764,17 +3867,17 @@ Checks if the given validator is a Null type.
 ##### Returns
 
 
--  True: It is a Null Validator; False: It is not a Null Validator.
+-  true: it is a In validator; false: it is not a In validator
 
 
 
 
-### dist/filters/helpers/common/isInValidator.js
+### dist/filters/helpers/common/isNullValidator.js
 
 
-#### isInValidator(validator) 
+#### isNullValidator(validator) 
 
-Validates if the given validator is a In type
+Checks if the given validator is a Null type.
 
 
 
@@ -3783,7 +3886,7 @@ Validates if the given validator is a In type
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The validator |   |
+| validator |  | The Filter Validator |   |
 
 
 
@@ -3791,7 +3894,7 @@ Validates if the given validator is a In type
 ##### Returns
 
 
--  true: it is a In validator; false: it is not a In validator
+-  True: It is a Null Validator; False: It is not a Null Validator.
 
 
 
@@ -4096,12 +4199,12 @@ Excludes Aggregate Filters in the Flattened UI Filters array
 
 
 
-### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
+### dist/filters/helpers/ui/getFilterPropertyLabel.js
 
 
-#### excludeUIFlatFiltersByScopes(uFilters, scopes) 
+#### getFilterPropertyLabel(filter) 
 
-Excludes and returns a UI Flat Filters without filters by the given scopes
+Gets the label of the filter property
 
 
 
@@ -4110,8 +4213,7 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilters |  | The Flatten UI Filters |   |
-| scopes |  | collection of scopes types |   |
+| filter |  | The UI Filter |   |
 
 
 
@@ -4119,17 +4221,17 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
 ##### Returns
 
 
--  The new array of UI Flattened filters
+-  a string of the filter property label
 
 
 
 
-### dist/filters/helpers/ui/getFilterPropertyLabel.js
+### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
 
 
-#### getFilterPropertyLabel(filter) 
+#### excludeUIFlatFiltersByScopes(uFilters, scopes) 
 
-Gets the label of the filter property
+Excludes and returns a UI Flat Filters without filters by the given scopes
 
 
 
@@ -4138,35 +4240,8 @@ Gets the label of the filter property
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The UI Filter |   |
-
-
-
-
-##### Returns
-
-
--  a string of the filter property label
-
-
-
-
-### dist/filters/helpers/ui/getUIFlatFilterByParams.js
-
-
-#### getUIFlatFilterByParams() 
-
-Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
-The validation to filter the stored filter is depending on:
-- Column
-- Qrvey ID,
-- Scope type
-- Scope ID
-- Panel ID
-- Validator type
-- Property type
-
-
+| uFilters |  | The Flatten UI Filters |   |
+| scopes |  | collection of scopes types |   |
 
 
 
@@ -4174,7 +4249,7 @@ The validation to filter the stored filter is depending on:
 ##### Returns
 
 
--  The index of the uFilter array or the Filter object s
+-  The new array of UI Flattened filters
 
 
 
@@ -4235,6 +4310,34 @@ Looks around all filter structure finding the qrveyid propertty in each dataset
 
 
 
+### dist/filters/helpers/ui/getUIFlatFilterByParams.js
+
+
+#### getUIFlatFilterByParams() 
+
+Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
+The validation to filter the stored filter is depending on:
+- Column
+- Qrvey ID,
+- Scope type
+- Scope ID
+- Panel ID
+- Validator type
+- Property type
+
+
+
+
+
+
+##### Returns
+
+
+-  The index of the uFilter array or the Filter object s
+
+
+
+
 ### dist/filters/helpers/ui/getUIFlatFiltersByParams.js