@qrvey/utils 1.2.9-12 → 1.2.9-16

package/README.md

@@ -1,4 +1,4 @@
-# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-12*
+# [@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,7 +2643,81 @@ 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/qrvey/helpers/transformValue.js
+
+
+#### transformValue(value, settings) 
+
+Transforms a value depending of localization/globalization and extras settings.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| value |  | A value to transform |   |
+| settings |  | The settings of the transformValue function |   |
+
+
+
+
+##### Returns
+
+
+-  A transformed value
+
+
+
+#### getOutputFormat(settings) 
+
+Gets the outputformat settings
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| settings |  | The settings of the transformValue function |   |
+
+
+
+
+##### Returns
+
+
+-  the outputformat settings
+
+
+
+#### getFormatConfig(settings) 
+
+Gets the format config
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| settings |  | The settings of the transformValue function |   |
+
+
+
+
+##### Returns
+
+
+-  the format config
 
 
 
@@ -2622,7 +2725,7 @@ Get an string of the properties of the given column.
 ### dist/services/api/getAllDatasets.api.js
 
 
-#### getAllDatasets(qrveyids) 
+#### getAllDatasets(config, pickDatasets) 
 
 Get a dataset list from a collection of Qrvey IDs
 
@@ -2633,7 +2736,8 @@ Get a dataset list from a collection of Qrvey IDs
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| qrveyids |  | Collection of Qrvey IDs |   |
+| config |  | the widget config. Includes the appid and others configuration properties |   |
+| pickDatasets |  | Collection of Qrvey IDs for filtering the request |   |
 
 
 
@@ -3244,12 +3348,21 @@ Returns a filter builder config object by a any given config
 
 
 
-### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
+### dist/filters/helpers/common/excludeFiltersByParams.js
 
 
-#### excludeUIFiltersByAggregate(uFilters) 
+#### excludeFiltersByParams(filterData, params) 
 
-Excludes Aggregate Filters in the Flattened UI Filters array
+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
 
 
 
@@ -3258,7 +3371,8 @@ Excludes Aggregate Filters in the Flattened UI Filters array
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilters |  | Collection of Flat UI Filters |   |
+| filterData |  | The Filter Data or the UI Filter Data |   |
+| params |  | given parameters to validate the filter data |   |
 
 
 
@@ -3266,17 +3380,17 @@ Excludes Aggregate Filters in the Flattened UI Filters array
 ##### Returns
 
 
--  a new Flat UI Filters that were excluded the aggregate filters
+-  a new Filter object structure
 
 
 
 
-### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
+### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
 
 
-#### excludeUIFlatFiltersByScopes(uFilters, scopes) 
+#### excludeFiltersByAggregateColumn(filterData) 
 
-Excludes and returns a UI Flat Filters without filters by the given scopes
+Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
 
 
 
@@ -3285,8 +3399,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 |   |
+| filterData |  | The filter data object |   |
 
 
 
@@ -3294,17 +3407,17 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
 ##### Returns
 
 
--  The new array of UI Flattened filters
+-  The new filter data object that were excluded the aggregate filters
 
 
 
 
-### dist/filters/helpers/ui/getFilterPropertyLabel.js
+### dist/filters/helpers/common/excludeFiltersByScopes.js
 
 
-#### getFilterPropertyLabel(filter) 
+#### excludeFiltersByScopes(filterData, scopes) 
 
-Gets the label of the filter property
+Excludes and returns a filter data without filters by the given scopes
 
 
 
@@ -3313,7 +3426,8 @@ Gets the label of the filter property
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The UI Filter |   |
+| filterData |  | The Filter Data |   |
+| scopes |  | collection of scopes to be as filtering parameters |   |
 
 
 
@@ -3321,17 +3435,17 @@ Gets the label of the filter property
 ##### Returns
 
 
--  a string of the filter property label
+-  The new Filter Data without filters by the given scopes.
 
 
 
 
-### dist/filters/helpers/ui/getOutputFormatByColumn.js
+### dist/filters/helpers/common/getFilterColumnLabel.js
 
 
-#### getOutputFormatByColumn(column, datasets) 
+#### getFilterColumnLabel(column) 
 
-Gets output format object from Datasets by the given column. Item of the datasets array must have outputformat item in order to be returned
+Get an string of the properties of the given filter column.
 
 
 
@@ -3340,8 +3454,7 @@ Gets output format object from Datasets by the given column. Item of the dataset
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| column |  | The column |   |
-| datasets |  | array of datasets |   |
+| column |  | The filter column |   |
 
 
 
@@ -3349,56 +3462,26 @@ Gets output format object from Datasets by the given column. Item of the dataset
 ##### Returns
 
 
--  The output format object
-
-
-
-
-### 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
-
-
-
-
-
+-  an string with the property, aggregate or calculation label.
 
-##### Returns
 
 
--  The index of the uFilter array or the Filter object s
 
+### dist/filters/helpers/common/getFilterLabel.js
 
 
+#### getFilterLabel(filter) 
 
-### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
+Gets the Filter Label + Column label
 
 
-#### getUIFlatFiltersByParams() 
 
-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
-- Enabled flags
 
+##### Parameters
 
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| filter |  | the UI filter |   |
 
 
 
@@ -3406,17 +3489,17 @@ The validation to filter the stored filter is depending on:
 ##### Returns
 
 
--  The index of the uFilter array or the Filter object s
+-  a sring label
 
 
 
 
-### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
+### dist/filters/helpers/common/areFiltersEquals.js
 
 
-#### getUIFlatFiltersByScopes(uFilters, scopes) 
+#### areFiltersEquals(filter1, filter2) 
 
-Filters and gets a UI Flatten Filters by the given scopes
+Validates if both filters are the same
 
 
 
@@ -3425,8 +3508,8 @@ Filters and gets a UI Flatten Filters by the given scopes
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilters |  | The Flatten UI Filters |   |
-| scopes |  | collection of scopes types |   |
+| filter1 |  | filter 1 |   |
+| filter2 |  | filter 2 |   |
 
 
 
@@ -3434,17 +3517,28 @@ Filters and gets a UI Flatten Filters by the given scopes
 ##### Returns
 
 
--  The new array of UI Flattened filters
+-  true: the filters are equal; false: the filters are NOT equal
 
 
 
 
-### dist/filters/helpers/ui/getUIValues.js
+### dist/filters/helpers/common/getFilterid.js
 
 
-#### getUIValues(filter, addEnableds, rankingGroupIndex) 
-
+#### getFilterid(filter) 
 
+Get the Filter ID by the filter structure
+The order of the epression ID is:
+- Scope Type
+- scopeid
+- qrveyid
+- panelid
+- columnid
+- validator
+- property
+- Column Aggregate
+- Column Calculation
+- Optional Index
 
 
 
@@ -3453,9 +3547,7 @@ Filters and gets a UI Flatten Filters by the given scopes
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  |  |   |
-| addEnableds |  |  |   |
-| rankingGroupIndex |  |  |   |
+| filter |  | the filter structure |   |
 
 
 
@@ -3463,17 +3555,17 @@ Filters and gets a UI Flatten Filters by the given scopes
 ##### Returns
 
 
--  
+-  a text to identify the filter
 
 
 
 
-### dist/filters/helpers/ui/resolveUIFlatFiltersByParams.js
+### dist/filters/helpers/common/getFiltersByAggregateColumn.js
 
 
-#### resolveUIFlatFilterByParams(filter, params) 
+#### getFiltersByAggregateColumn(filterData) 
 
-Resolves conditions between UI flattened filter and given parameters
+Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
 
 
 
@@ -3482,8 +3574,7 @@ Resolves conditions between UI flattened filter and given parameters
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | UI Flatten Filter |   |
-| params |  | Parameters to validate |   |
+| filterData |  | The filter data object |   |
 
 
 
@@ -3491,17 +3582,26 @@ Resolves conditions between UI flattened filter and given parameters
 ##### Returns
 
 
--  true: the conditions are satisfied.
+-  The new filter data object that were get the aggregate filters
 
 
 
 
-### dist/filters/helpers/common/areFiltersEquals.js
+### dist/filters/helpers/common/getFiltersByParams.js
 
 
-#### areFiltersEquals(filter1, filter2) 
+#### getFiltersByParams(filterData, params) 
 
-Validates if both filters are the same
+Gets filters from the given params.
+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
 
 
 
@@ -3510,8 +3610,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 dataset |   |
 
 
 
@@ -3519,17 +3619,17 @@ Validates if both filters are the same
 ##### Returns
 
 
--  true: the filters are equal; false: the filters are NOT equal
+-  a new Filter object structure
 
 
 
 
-### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
+### dist/filters/helpers/common/getFiltersByScopes.js
 
 
-#### excludeFiltersByAggregateColumn(filterData) 
+#### getFiltersByScopes(filterData, scopes) 
 
-Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
+Filters and gets a Filter Data by the given scopes
 
 
 
@@ -3538,7 +3638,8 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object |   |
+| filterData |  | The Filter Data |   |
+| scopes |  | collection of scopes types |   |
 
 
 
@@ -3546,26 +3647,17 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
 ##### Returns
 
 
--  The new filter data object that were excluded the aggregate filters
+-  The new Filter Data
 
 
 
 
-### dist/filters/helpers/common/excludeFiltersByParams.js
+### dist/filters/helpers/common/getFiltersByScopesIds.js
 
 
-#### excludeFiltersByParams(filterData, params) 
+#### getFiltersByScopesIds(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
+Gets filters from Filter Data by Scopes/Scope IDs.
 
 
 
@@ -3574,8 +3666,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 |  | The collection of Scopes/Scope IDs |   |
 
 
 
@@ -3583,17 +3675,17 @@ The validation to filter the stored filter is depending on:
 ##### Returns
 
 
--  a new Filter object structure
+-  a new Filter Data
 
 
 
 
-### dist/filters/helpers/common/excludeFiltersByScopes.js
+### dist/filters/helpers/common/getFiltersByVisibility.js
 
 
-#### excludeFiltersByScopes(filterData, scopes) 
+#### getFiltersByVisibility(filterData, scopes) 
 
-Excludes and returns a filter data without filters by the given scopes
+Get a new Filter Data by filtering scopes/scope IDs and enabled flags
 
 
 
@@ -3602,8 +3694,8 @@ 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 |   |
+| filterData |  | a Filter Data or UI Filter Data |   |
+| scopes |  | a Scopes/Scope IDs array |   |
 
 
 
@@ -3611,17 +3703,17 @@ Excludes and returns a filter data without filters by the given scopes
 ##### Returns
 
 
--  The new Filter Data without filters by the given scopes.
+-  a new Filter Data
 
 
 
 
-### dist/filters/helpers/common/getFilterColumnLabel.js
+### dist/filters/helpers/common/getMergeFiltersSettings.js
 
 
-#### getFilterColumnLabel(column) 
+#### getMergeFiltersSettings(settings) 
 
-Get an string of the properties of the given filter column.
+Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
 
 
 
@@ -3630,7 +3722,7 @@ Get an string of the properties of the given filter column.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| column |  | The filter column |   |
+| settings |  | an object to the MergeFilters settings |   |
 
 
 
@@ -3638,17 +3730,17 @@ Get an string of the properties of the given filter column.
 ##### Returns
 
 
--  an string with the property, aggregate or calculation label.
+-  a new MergeFilters settings object.
 
 
 
 
-### dist/filters/helpers/common/getFilterLabel.js
+### dist/filters/helpers/common/getParamsToGetFilterSettings.js
 
 
-#### getFilterLabel(filter) 
+#### getParamsToGetFilterSettings(settings) 
 
-Gets the Filter Label + Column label
+Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
 
 
 
@@ -3657,7 +3749,7 @@ Gets the Filter Label + Column label
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | the UI filter |   |
+| settings |  | an object to the ParamsToGetFilter settings |   |
 
 
 
@@ -3665,28 +3757,17 @@ Gets the Filter Label + Column label
 ##### Returns
 
 
--  a sring label
+-  a new ParamsToGetFilter settings object.
 
 
 
 
-### dist/filters/helpers/common/getFilterid.js
+### dist/filters/helpers/common/haveFiltersByDataset.js
 
 
-#### getFilterid(filter) 
+#### haveFiltersByDataset(filterData, qrveyid) 
 
-Get the Filter ID by the filter structure
-The order of the epression ID is:
-- Scope Type
-- scopeid
-- qrveyid
-- panelid
-- columnid
-- validator
-- property
-- Column Aggregate
-- Column Calculation
-- Optional Index
+Validates if the filter data has filters by a dataset ID (Qrvey ID).
 
 
 
@@ -3695,7 +3776,8 @@ The order of the epression ID is:
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | the filter structure |   |
+| filterData |  | the filter data or the UI filter data. |   |
+| qrveyid |  | The Qrvey ID |   |
 
 
 
@@ -3703,17 +3785,17 @@ The order of the epression ID is:
 ##### Returns
 
 
--  a text to identify the filter
+-  true: the filter data has filters by the Qrvey ID
 
 
 
 
-### dist/filters/helpers/common/getFiltersByAggregateColumn.js
+### dist/filters/helpers/common/isBetweenValidator.js
 
 
-#### getFiltersByAggregateColumn(filterData) 
+#### isBetweenValidator(validator) 
 
-Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
+Validates if the given validator is a Between type
 
 
 
@@ -3722,7 +3804,7 @@ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggr
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object |   |
+| validator |  | The validator |   |
 
 
 
@@ -3730,26 +3812,17 @@ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggr
 ##### Returns
 
 
--  The new filter data object that were get the aggregate filters
+-  true: it is a between validator; false: it is not a between validator
 
 
 
 
-### dist/filters/helpers/common/getFiltersByParams.js
+### dist/filters/helpers/common/isDateDistinctProperty.js
 
 
-#### getFiltersByParams(filterData, params) 
+#### isDateDistinctProperty(column, property) 
 
-Gets filters from the given params.
-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
+Determines if the filter column and property is a distinct group dates type
 
 
 
@@ -3758,8 +3831,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 dataset |   |
+| column |  | The filter column |   |
+| property |  | The filter property |   |
 
 
 
@@ -3767,17 +3840,17 @@ The validation to filter the stored filter is depending on:
 ##### Returns
 
 
--  a new Filter object structure
+-  True if the given property is included from distinct group dates type
 
 
 
 
-### dist/filters/helpers/common/getFiltersByScopes.js
+### dist/filters/helpers/common/isInValidator.js
 
 
-#### getFiltersByScopes(filterData, scopes) 
+#### isInValidator(validator) 
 
-Filters and gets a Filter Data by the given scopes
+Validates if the given validator is a In type
 
 
 
@@ -3786,8 +3859,7 @@ Filters and gets a Filter Data by the given scopes
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The Filter Data |   |
-| scopes |  | collection of scopes types |   |
+| validator |  | The validator |   |
 
 
 
@@ -3795,17 +3867,17 @@ Filters and gets a Filter Data by the given scopes
 ##### Returns
 
 
--  The new Filter Data
+-  true: it is a In validator; false: it is not a In validator
 
 
 
 
-### dist/filters/helpers/common/getFiltersByScopesIds.js
+### dist/filters/helpers/common/isNullValidator.js
 
 
-#### getFiltersByScopesIds(filterData, scopes) 
+#### isNullValidator(validator) 
 
-Gets filters from Filter Data by Scopes/Scope IDs.
+Checks if the given validator is a Null type.
 
 
 
@@ -3814,8 +3886,7 @@ Gets filters from Filter Data by Scopes/Scope IDs.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data |   |
-| scopes |  | The collection of Scopes/Scope IDs |   |
+| validator |  | The Filter Validator |   |
 
 
 
@@ -3823,17 +3894,17 @@ Gets filters from Filter Data by Scopes/Scope IDs.
 ##### Returns
 
 
--  a new Filter Data
+-  True: It is a Null Validator; False: It is not a Null Validator.
 
 
 
 
-### dist/filters/helpers/common/getFiltersByVisibility.js
+### dist/filters/helpers/common/isRangeValidator.js
 
 
-#### getFiltersByVisibility(filterData, scopes) 
+#### isRangeValidator(validator) 
 
-Get a new Filter Data by filtering scopes/scope IDs and enabled flags
+Validates if the given validator is a Range type. Range type means the value has min and max values to filter
 
 
 
@@ -3842,8 +3913,7 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | a Filter Data or UI Filter Data |   |
-| scopes |  | a Scopes/Scope IDs array |   |
+| validator |  | The filter validator |   |
 
 
 
@@ -3851,17 +3921,17 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
 ##### Returns
 
 
--  a new Filter Data
+-  true: it is a range validator
 
 
 
 
-### dist/filters/helpers/common/getMergeFiltersSettings.js
+### dist/filters/helpers/common/isRegularValidator.js
 
 
-#### getMergeFiltersSettings(settings) 
+#### isRegularValidator(validator) 
 
-Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
+Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
 
 
 
@@ -3870,7 +3940,7 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| settings |  | an object to the MergeFilters settings |   |
+| validator |  | The filter validator |   |
 
 
 
@@ -3878,17 +3948,17 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
 ##### Returns
 
 
--  a new MergeFilters settings object.
+-  true: it is a range validator
 
 
 
 
-### dist/filters/helpers/common/getParamsToGetFilterSettings.js
+### dist/filters/helpers/common/mergeFilters.js
 
 
-#### getParamsToGetFilterSettings(settings) 
+#### mergeFilters(filterData1, filterData2, overwriteValues) 
 
-Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
+Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
 
 
 
@@ -3897,7 +3967,9 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| settings |  | an object to the ParamsToGetFilter settings |   |
+| filterData1 |  | The target filter data |   |
+| filterData2 |  | the filter data to be merged |   |
+| overwriteValues |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -3905,17 +3977,38 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
 ##### Returns
 
 
--  a new ParamsToGetFilter settings object.
+-  a new filter data structure
 
 
 
+#### mergeScopes(scopes1, scopes2, overwriteValues) 
 
-### dist/filters/helpers/common/haveFiltersByDataset.js
+Gets a new scope structure array by merging two scope structures
 
 
-#### haveFiltersByDataset(filterData, qrveyid) 
 
-Validates if the filter data has filters by a dataset ID (Qrvey ID).
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| scopes1 |  | the target scope structure |   |
+| scopes2 |  | the scope to be merged |   |
+| overwriteValues |  | Flag to overwrite or not the filter values |   |
+
+
+
+
+##### Returns
+
+
+-  a new scope structure array
+
+
+
+#### mergeDatasets(datasets1, datasets2, overwriteValues) 
+
+Gets a new dataset structure array by merging two dataset structures
 
 
 
@@ -3924,8 +4017,9 @@ 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 |   |
+| datasets1 |  | the target dataset structure |   |
+| datasets2 |  | the dataset to be merged |   |
+| overwriteValues |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -3933,17 +4027,38 @@ 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 dataset structure array
 
 
 
+#### mergeFilterss(filters1, filters2, overwriteValues) 
 
-### dist/filters/helpers/common/isBetweenValidator.js
+Gets a new filter structure array by merging two filter structures
 
 
-#### isBetweenValidator(validator) 
 
-Validates if the given validator is a Between type
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| filters1 |  | the target filter structure |   |
+| filters2 |  | the filter to be merged |   |
+| overwriteValues |  | Flag to overwrite or not the filter values |   |
+
+
+
+
+##### Returns
+
+
+-  a new filter structure array
+
+
+
+#### mergeValues(filter1, filter2, overwrite) 
+
+Gets a new value structure array by merging two value structures
 
 
 
@@ -3952,7 +4067,9 @@ Validates if the given validator is a Between type
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The validator |   |
+| filter1 |  | the target filter structure |   |
+| filter2 |  | the filter to be used to merge the values |   |
+| overwrite |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -3960,17 +4077,17 @@ Validates if the given validator is a Between type
 ##### Returns
 
 
--  true: it is a between validator; false: it is not a between validator
+-  a new value structure array
 
 
 
 
-### dist/filters/helpers/common/isDateDistinctProperty.js
+### dist/filters/helpers/common/resolveDatasetConditions.js
 
 
-#### isDateDistinctProperty(column, property) 
+#### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
 
-Determines if the filter column and property is a distinct group dates type
+Resolves the conditions by given params
 
 
 
@@ -3979,8 +4096,10 @@ Determines if the filter column and property is a distinct group dates type
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| column |  | The filter column |   |
-| property |  | The filter property |   |
+| filter |  | The dataset structure |   |
+| params |  | given parameters to validate the dataset |   |
+| letPassUndefinedProperties |  | Flag to avoid applying the condition when the filter properties are undefined |   |
+| letPassUndefinedParams |  | Flag to avoid applying the condition when the param properties are explicit undefined. |   |
 
 
 
@@ -3988,17 +4107,17 @@ Determines if the filter column and property is a distinct group dates type
 ##### Returns
 
 
--  True if the given property is included from distinct group dates type
+-  true: the condition is satisfied
 
 
 
 
-### dist/filters/helpers/common/isInValidator.js
+### dist/filters/helpers/common/resolveFilterConditions.js
 
 
-#### isInValidator(validator) 
+#### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
 
-Validates if the given validator is a In type
+Resolves the conditions by given params
 
 
 
@@ -4007,7 +4126,10 @@ Validates if the given validator is a In type
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The validator |   |
+| filter |  | The filter |   |
+| params |  | given parameters to validate the filter |   |
+| letPassUndefinedProperties |  | Flag to avoid applying the condition when the filter properties are undefined |   |
+| letPassUndefinedParams |  | Flag to avoid applying the condition when the param properties are explicit undefined. |   |
 
 
 
@@ -4015,17 +4137,17 @@ Validates if the given validator is a In type
 ##### Returns
 
 
--  true: it is a In validator; false: it is not a In validator
+-  true: the condition is satisfied
 
 
 
 
-### dist/filters/helpers/common/isNullValidator.js
+### dist/filters/helpers/common/resolveScopeConditions.js
 
 
-#### isNullValidator(validator) 
+#### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
 
-Checks if the given validator is a Null type.
+Resolves the conditions by given params
 
 
 
@@ -4034,7 +4156,10 @@ Checks if the given validator is a Null type.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The Filter Validator |   |
+| filter |  | The filter scope structure |   |
+| params |  | given parameters to validate the filter |   |
+| letPassUndefinedProperties |  | Flag to avoid applying the condition when the filter properties are undefined |   |
+| letPassUndefinedParams |  | Flag to avoid applying the condition when the param properties are explicit undefined. |   |
 
 
 
@@ -4042,17 +4167,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: the condition is satisfied
 
 
 
 
-### dist/filters/helpers/common/isRangeValidator.js
+### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
 
 
-#### isRangeValidator(validator) 
+#### excludeUIFiltersByAggregate(uFilters) 
 
-Validates if the given validator is a Range type. Range type means the value has min and max values to filter
+Excludes Aggregate Filters in the Flattened UI Filters array
 
 
 
@@ -4061,7 +4186,7 @@ Validates if the given validator is a Range type. Range type means the value has
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The filter validator |   |
+| uFilters |  | Collection of Flat UI Filters |   |
 
 
 
@@ -4069,17 +4194,17 @@ Validates if the given validator is a Range type. Range type means the value has
 ##### Returns
 
 
--  true: it is a range validator
+-  a new Flat UI Filters that were excluded the aggregate filters
 
 
 
 
-### dist/filters/helpers/common/isRegularValidator.js
+### dist/filters/helpers/ui/getFilterPropertyLabel.js
 
 
-#### isRegularValidator(validator) 
+#### getFilterPropertyLabel(filter) 
 
-Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
+Gets the label of the filter property
 
 
 
@@ -4088,7 +4213,7 @@ Validates if the given validator is a regular type. Regular type means the filte
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The filter validator |   |
+| filter |  | The UI Filter |   |
 
 
 
@@ -4096,17 +4221,17 @@ Validates if the given validator is a regular type. Regular type means the filte
 ##### Returns
 
 
--  true: it is a range validator
+-  a string of the filter property label
 
 
 
 
-### dist/filters/helpers/common/mergeFilters.js
+### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
 
 
-#### mergeFilters(filterData1, filterData2, overwriteValues) 
+#### excludeUIFlatFiltersByScopes(uFilters, scopes) 
 
-Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
+Excludes and returns a UI Flat Filters without filters by the given scopes
 
 
 
@@ -4115,9 +4240,8 @@ Merge filter data structures in a new one. The first Filter Data passed in the a
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData1 |  | The target filter data |   |
-| filterData2 |  | the filter data to be merged |   |
-| overwriteValues |  | Flag to overwrite or not the filter values |   |
+| uFilters |  | The Flatten UI Filters |   |
+| scopes |  | collection of scopes types |   |
 
 
 
@@ -4125,13 +4249,17 @@ Merge filter data structures in a new one. The first Filter Data passed in the a
 ##### Returns
 
 
--  a new filter data structure
+-  The new array of UI Flattened filters
 
 
 
-#### mergeScopes(scopes1, scopes2, overwriteValues) 
 
-Gets a new scope structure array by merging two scope structures
+### dist/filters/helpers/ui/getOutputFormatByColumn.js
+
+
+#### getOutputFormatByColumn(column, datasets) 
+
+Gets output format object from Datasets by the given column. Item of the datasets array must have outputformat item in order to be returned
 
 
 
@@ -4140,9 +4268,8 @@ Gets a new scope structure array by merging two scope structures
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| scopes1 |  | the target scope structure |   |
-| scopes2 |  | the scope to be merged |   |
-| overwriteValues |  | Flag to overwrite or not the filter values |   |
+| column |  | The column |   |
+| datasets |  | array of datasets |   |
 
 
 
@@ -4150,13 +4277,18 @@ Gets a new scope structure array by merging two scope structures
 ##### Returns
 
 
--  a new scope structure array
+-  The output format object
 
 
 
-#### mergeDatasets(datasets1, datasets2, overwriteValues) 
 
-Gets a new dataset structure array by merging two dataset structures
+### dist/filters/helpers/ui/getQrveyIdsByUIFilters.js
+
+
+#### getQrveyIdsByUIFilters(uiFilter) 
+
+Gets a collection of Qrvey IDs in the UI Filter structure.
+Looks around all filter structure finding the qrveyid propertty in each dataset
 
 
 
@@ -4165,9 +4297,7 @@ Gets a new dataset structure array by merging two dataset structures
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| datasets1 |  | the target dataset structure |   |
-| datasets2 |  | the dataset to be merged |   |
-| overwriteValues |  | Flag to overwrite or not the filter values |   |
+| uiFilter |  |  |   |
 
 
 
@@ -4175,24 +4305,27 @@ Gets a new dataset structure array by merging two dataset structures
 ##### Returns
 
 
--  a new dataset structure array
+- `Void`
 
 
 
-#### mergeFilterss(filters1, filters2, overwriteValues) 
 
-Gets a new filter structure array by merging two filter structures
+### 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
 
-##### Parameters
 
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filters1 |  | the target filter structure |   |
-| filters2 |  | the filter to be merged |   |
-| overwriteValues |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -4200,13 +4333,46 @@ Gets a new filter structure array by merging two filter structures
 ##### Returns
 
 
--  a new filter structure array
+-  The index of the uFilter array or the Filter object s
 
 
 
-#### mergeValues(filter1, filter2, overwrite) 
 
-Gets a new value structure array by merging two value structures
+### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
+
+
+#### getUIFlatFiltersByParams() 
+
+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
+- Enabled flags
+
+
+
+
+
+
+##### Returns
+
+
+-  The index of the uFilter array or the Filter object s
+
+
+
+
+### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
+
+
+#### getUIFlatFiltersByScopes(uFilters, scopes) 
+
+Filters and gets a UI Flatten Filters by the given scopes
 
 
 
@@ -4215,9 +4381,8 @@ Gets a new value structure array by merging two value structures
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter1 |  | the target filter structure |   |
-| filter2 |  | the filter to be used to merge the values |   |
-| overwrite |  | Flag to overwrite or not the filter values |   |
+| uFilters |  | The Flatten UI Filters |   |
+| scopes |  | collection of scopes types |   |
 
 
 
@@ -4225,17 +4390,17 @@ Gets a new value structure array by merging two value structures
 ##### Returns
 
 
--  a new value structure array
+-  The new array of UI Flattened filters
 
 
 
 
-### dist/filters/helpers/common/resolveDatasetConditions.js
+### dist/filters/helpers/ui/getUIValues.js
 
 
-#### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
+#### getUIValues(filter, addEnableds, rankingGroupIndex) 
+
 
-Resolves the conditions by given params
 
 
 
@@ -4244,10 +4409,9 @@ Resolves the conditions by given params
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The dataset structure |   |
-| params |  | given parameters to validate the dataset |   |
-| letPassUndefinedProperties |  | Flag to avoid applying the condition when the filter properties are undefined |   |
-| letPassUndefinedParams |  | Flag to avoid applying the condition when the param properties are explicit undefined. |   |
+| filter |  |  |   |
+| addEnableds |  |  |   |
+| rankingGroupIndex |  |  |   |
 
 
 
@@ -4255,17 +4419,17 @@ Resolves the conditions by given params
 ##### Returns
 
 
--  true: the condition is satisfied
+-  
 
 
 
 
-### dist/filters/helpers/common/resolveFilterConditions.js
+### dist/filters/helpers/ui/getUpdatedUIFilters.js
 
 
-#### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
+#### getUpdatedUIFilters(data, datasets) 
 
-Resolves the conditions by given params
+Gets a new UI Filter structure with a datasets/columns info updates
 
 
 
@@ -4274,10 +4438,8 @@ Resolves the conditions by given params
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The filter |   |
-| params |  | given parameters to validate the filter |   |
-| letPassUndefinedProperties |  | Flag to avoid applying the condition when the filter properties are undefined |   |
-| letPassUndefinedParams |  | Flag to avoid applying the condition when the param properties are explicit undefined. |   |
+| data |  | The UI Filter structure |   |
+| datasets |  | An array of datasets/column info used for updating the data |   |
 
 
 
@@ -4285,17 +4447,17 @@ Resolves the conditions by given params
 ##### Returns
 
 
--  true: the condition is satisfied
+-  A new UI FIlter structure
 
 
 
 
-### dist/filters/helpers/common/resolveScopeConditions.js
+### dist/filters/helpers/ui/resolveUIFlatFiltersByParams.js
 
 
-#### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
+#### resolveUIFlatFilterByParams(filter, params) 
 
-Resolves the conditions by given params
+Resolves conditions between UI flattened filter and given parameters
 
 
 
@@ -4304,10 +4466,8 @@ Resolves the conditions by given params
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The filter scope structure |   |
-| params |  | given parameters to validate the filter |   |
-| letPassUndefinedProperties |  | Flag to avoid applying the condition when the filter properties are undefined |   |
-| letPassUndefinedParams |  | Flag to avoid applying the condition when the param properties are explicit undefined. |   |
+| filter |  | UI Flatten Filter |   |
+| params |  | Parameters to validate |   |
 
 
 
@@ -4315,7 +4475,7 @@ Resolves the conditions by given params
 ##### Returns
 
 
--  true: the condition is satisfied
+-  true: the conditions are satisfied.