@qrvey/utils 1.2.9-23 → 1.2.9-24

package/README.md

@@ -1,4 +1,4 @@
-# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-23*
+# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-24*
 
 > Helper, Utils for all Qrvey Projects
 
@@ -2722,47 +2722,50 @@ Gets the format config
 
 
 
-### dist/stencil/decorators/Config.js
-
+### dist/services/api/getAllDatasets.api.js
 
-#### Config() 
 
-Stencil.js - Prop Decorator
-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
-But for this, is required ask for a property in `snake_case` style
+#### getAllDatasets(config, pickDatasets) 
 
+Get a dataset list from a collection of Qrvey IDs
 
 
 
 
+##### Parameters
 
-##### Examples
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| config |  | the widget config. Includes the appid and others configuration properties |   |
+| pickDatasets |  | Collection of Qrvey IDs for filtering the request |   |
 
-```javascript
-\ @Config() @Prop() settings;
 
-someMethod() {
- this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
-}
-```
 
 
 ##### Returns
 
 
-- `Void`
+-  a promise
 
 
 
 
-### dist/stencil/util/createRef.js
+### dist/services/api/getAllQrveys.api.js
+
+
+#### getAllQrveys(config, params) 
+
+POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
 
 
-#### createRef() 
 
-lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
 
+##### Parameters
 
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| config |  | Configuration |   |
+| params |  | Object for getting precise data |   |
 
 
 
@@ -2770,21 +2773,17 @@ lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom
 ##### Returns
 
 
--  function - Function to use in ref prop in html elements
+- `Void`
 
 
 
 
-### dist/stencil/util/getConfig.js
+### dist/services/api/getDatasetColumns.api.js
 
 
-#### getConfig(cfg) 
+#### getDatasetColumns(qrveyid) 
 
-verify the Config object type and try to return a parsed Object
-- In case _cfg_ is a string, first try to make a JSON parse in other case
-try to find this string as a variable on Windows object
-- If _cfg_ is a fuction, tis is invoked and parsed
-- Finally, if is an object, _cfg_ is inmediatly returned
+Get a dataset by Qrvey ID
 
 
 
@@ -2793,7 +2792,7 @@ try to find this string as a variable on Windows object
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| cfg |  |  |   |
+| qrveyid |  | The Qrvey ID |   |
 
 
 
@@ -2801,55 +2800,52 @@ try to find this string as a variable on Windows object
 ##### Returns
 
 
-- `Void`
-
-
+-  a promise
 
 
-### dist/services/api/getAllDatasets.api.js
 
 
-#### getAllDatasets(config, pickDatasets) 
+### dist/stencil/decorators/Config.js
 
-Get a dataset list from a collection of Qrvey IDs
 
+#### Config() 
 
+Stencil.js - Prop Decorator
+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
+But for this, is required ask for a property in `snake_case` style
 
 
-##### Parameters
 
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| config |  | the widget config. Includes the appid and others configuration properties |   |
-| pickDatasets |  | Collection of Qrvey IDs for filtering the request |   |
 
 
 
+##### Examples
 
-##### Returns
+```javascript
+\ @Config() @Prop() settings;
 
+someMethod() {
+ this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
+}
+```
 
--  a promise
 
+##### Returns
 
 
+- `Void`
 
-### dist/services/api/getAllQrveys.api.js
 
 
-#### getAllQrveys(config, params) 
 
-POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
+### dist/stencil/util/createRef.js
 
 
+#### createRef() 
 
+lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
 
-##### Parameters
 
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| config |  | Configuration |   |
-| params |  | Object for getting precise data |   |
 
 
 
@@ -2857,17 +2853,21 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
 ##### Returns
 
 
-- `Void`
+-  function - Function to use in ref prop in html elements
 
 
 
 
-### dist/services/api/getDatasetColumns.api.js
+### dist/stencil/util/getConfig.js
 
 
-#### getDatasetColumns(qrveyid) 
+#### getConfig(cfg) 
 
-Get a dataset by Qrvey ID
+verify the Config object type and try to return a parsed Object
+- In case _cfg_ is a string, first try to make a JSON parse in other case
+try to find this string as a variable on Windows object
+- If _cfg_ is a fuction, tis is invoked and parsed
+- Finally, if is an object, _cfg_ is inmediatly returned
 
 
 
@@ -2876,7 +2876,7 @@ Get a dataset by Qrvey ID
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| qrveyid |  | The Qrvey ID |   |
+| cfg |  |  |   |
 
 
 
@@ -2884,7 +2884,7 @@ Get a dataset by Qrvey ID
 ##### Returns
 
 
--  a promise
+- `Void`
 
 
 
@@ -3348,12 +3348,12 @@ Returns a filter builder config object by a any given config
 
 
 
-### dist/filters/helpers/common/areFiltersEquals.js
+### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
 
 
-#### areFiltersEquals(filter1, filter2) 
+#### excludeUIFiltersByAggregate(uFilters) 
 
-Validates if both filters are the same
+Excludes Aggregate Filters in the Flattened UI Filters array
 
 
 
@@ -3362,8 +3362,7 @@ Validates if both filters are the same
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter1 |  | filter 1 |   |
-| filter2 |  | filter 2 |   |
+| uFilters |  | Collection of Flat UI Filters |   |
 
 
 
@@ -3371,17 +3370,17 @@ Validates if both filters are the same
 ##### Returns
 
 
--  true: the filters are equal; false: the filters are NOT equal
+-  a new Flat UI Filters that were excluded the aggregate filters
 
 
 
 
-### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
+### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
 
 
-#### excludeFiltersByAggregateColumn(filterData) 
+#### excludeUIFlatFiltersByScopes(uFilters, scopes) 
 
-Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
+Excludes and returns a UI Flat Filters without filters by the given scopes
 
 
 
@@ -3390,7 +3389,8 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object |   |
+| uFilters |  | The Flatten UI Filters |   |
+| scopes |  | collection of scopes types |   |
 
 
 
@@ -3398,26 +3398,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 array of UI Flattened filters
 
 
 
 
-### dist/filters/helpers/common/excludeFiltersByParams.js
+### dist/filters/helpers/ui/getFilterPropertyLabel.js
 
 
-#### excludeFiltersByParams(filterData, params) 
+#### getFilterPropertyLabel(filter) 
 
-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 the label of the filter property
 
 
 
@@ -3426,8 +3417,7 @@ 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 |   |
+| filter |  | The UI Filter |   |
 
 
 
@@ -3435,17 +3425,17 @@ The validation to filter the stored filter is depending on:
 ##### Returns
 
 
--  a new Filter object structure
+-  a string of the filter property label
 
 
 
 
-### dist/filters/helpers/common/excludeFiltersByScopes.js
+### dist/filters/helpers/ui/getOutputFormatByColumn.js
 
 
-#### excludeFiltersByScopes(filterData, scopes) 
+#### getOutputFormatByColumn(column, datasets) 
 
-Excludes and returns a filter data without filters by the given scopes
+Gets output format object from Datasets by the given column. Item of the datasets array must have outputformat item in order to be returned
 
 
 
@@ -3454,8 +3444,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 |   |
+| column |  | The column |   |
+| datasets |  | array of datasets |   |
 
 
 
@@ -3463,17 +3453,18 @@ Excludes and returns a filter data without filters by the given scopes
 ##### Returns
 
 
--  The new Filter Data without filters by the given scopes.
+-  The output format object
 
 
 
 
-### dist/filters/helpers/common/getFilterLabel.js
+### dist/filters/helpers/ui/getQrveyIdsByUIFilters.js
 
 
-#### getFilterLabel(filter) 
+#### getQrveyIdsByUIFilters(uiFilter) 
 
-Gets the Filter Label + Column label
+Gets a collection of Qrvey IDs in the UI Filter structure.
+Looks around all filter structure finding the qrveyid propertty in each dataset
 
 
 
@@ -3482,7 +3473,7 @@ Gets the Filter Label + Column label
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | the UI filter |   |
+| uiFilter |  |  |   |
 
 
 
@@ -3490,37 +3481,27 @@ Gets the Filter Label + Column label
 ##### Returns
 
 
--  a sring label
-
-
-
+- `Void`
 
-### dist/filters/helpers/common/getFilterid.js
 
 
-#### 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
+### 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 |  |
-| ---- | ---- | ----------- | -------- |
-| filter |  | the filter structure |   |
 
 
 
@@ -3528,26 +3509,28 @@ The order of the epression ID is:
 ##### Returns
 
 
--  a text to identify the filter
-
-
-
+-  The index of the uFilter array or the Filter object s
 
-### dist/filters/helpers/common/getFiltersByAggregateColumn.js
 
 
-#### getFiltersByAggregateColumn(filterData) 
 
-Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
+### 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
 
-##### Parameters
 
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object |   |
 
 
 
@@ -3555,26 +3538,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
+-  The index of the uFilter array or the Filter object s
 
 
 
 
-### dist/filters/helpers/common/getFiltersByParams.js
+### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
 
 
-#### getFiltersByParams(filterData, params) 
+#### getUIFlatFiltersByScopes(uFilters, scopes) 
 
-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
+Filters and gets a UI Flatten Filters by the given scopes
 
 
 
@@ -3583,8 +3557,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 |   |
+| uFilters |  | The Flatten UI Filters |   |
+| scopes |  | collection of scopes types |   |
 
 
 
@@ -3592,17 +3566,17 @@ The validation to filter the stored filter is depending on:
 ##### Returns
 
 
--  a new Filter object structure
+-  The new array of UI Flattened filters
 
 
 
 
-### dist/filters/helpers/common/getFiltersByScopes.js
+### dist/filters/helpers/ui/getUIValues.js
 
 
-#### getFiltersByScopes(filterData, scopes) 
+#### getUIValues(filter, addEnableds, rankingGroupIndex) 
+
 
-Filters and gets a Filter Data by the given scopes
 
 
 
@@ -3611,8 +3585,9 @@ Filters and gets a Filter Data by the given scopes
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The Filter Data |   |
-| scopes |  | collection of scopes types |   |
+| filter |  |  |   |
+| addEnableds |  |  |   |
+| rankingGroupIndex |  |  |   |
 
 
 
@@ -3620,17 +3595,17 @@ Filters and gets a Filter Data by the given scopes
 ##### Returns
 
 
--  The new Filter Data
+-  
 
 
 
 
-### dist/filters/helpers/common/getFiltersByScopesIds.js
+### dist/filters/helpers/ui/getUpdatedUIFilters.js
 
 
-#### getFiltersByScopesIds(filterData, scopes) 
+#### getUpdatedUIFilters(data, datasets) 
 
-Gets filters from Filter Data by Scopes/Scope IDs.
+Gets a new UI Filter structure with a datasets/columns info updates
 
 
 
@@ -3639,8 +3614,8 @@ Gets filters from Filter Data by Scopes/Scope IDs.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data |   |
-| scopes |  | The collection of Scopes/Scope IDs |   |
+| data |  | The UI Filter structure |   |
+| datasets |  | An array of datasets/column info used for updating the data |   |
 
 
 
@@ -3648,17 +3623,17 @@ Gets filters from Filter Data by Scopes/Scope IDs.
 ##### Returns
 
 
--  a new Filter Data
+-  A new UI FIlter structure
 
 
 
 
-### dist/filters/helpers/common/getFiltersByVisibility.js
+### dist/filters/helpers/ui/resolveUIFlatFiltersByParams.js
 
 
-#### getFiltersByVisibility(filterData, scopes) 
+#### resolveUIFlatFilterByParams(filter, params) 
 
-Get a new Filter Data by filtering scopes/scope IDs and enabled flags
+Resolves conditions between UI flattened filter and given parameters
 
 
 
@@ -3667,8 +3642,8 @@ 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 |   |
+| filter |  | UI Flatten Filter |   |
+| params |  | Parameters to validate |   |
 
 
 
@@ -3676,17 +3651,17 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
 ##### Returns
 
 
--  a new Filter Data
+-  true: the conditions are satisfied.
 
 
 
 
-### dist/filters/helpers/common/getMergeFiltersSettings.js
+### dist/filters/helpers/common/areFiltersEquals.js
 
 
-#### getMergeFiltersSettings(settings) 
+#### areFiltersEquals(filter1, filter2) 
 
-Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
+Validates if both filters are the same
 
 
 
@@ -3695,7 +3670,8 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| settings |  | an object to the MergeFilters settings |   |
+| filter1 |  | filter 1 |   |
+| filter2 |  | filter 2 |   |
 
 
 
@@ -3703,17 +3679,17 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
 ##### Returns
 
 
--  a new MergeFilters settings object.
+-  true: the filters are equal; false: the filters are NOT equal
 
 
 
 
-### dist/filters/helpers/common/getParamsToGetFilterSettings.js
+### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
 
 
-#### getParamsToGetFilterSettings(settings) 
+#### excludeFiltersByAggregateColumn(filterData) 
 
-Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
+Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
 
 
 
@@ -3722,7 +3698,7 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| settings |  | an object to the ParamsToGetFilter settings |   |
+| filterData |  | The filter data object |   |
 
 
 
@@ -3730,17 +3706,26 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
 ##### Returns
 
 
--  a new ParamsToGetFilter settings object.
+-  The new filter data object that were excluded the aggregate filters
 
 
 
 
-### dist/filters/helpers/common/haveFiltersByDataset.js
+### dist/filters/helpers/common/excludeFiltersByParams.js
 
 
-#### haveFiltersByDataset(filterData, qrveyid) 
+#### excludeFiltersByParams(filterData, params) 
 
-Validates if the filter data has filters by a dataset ID (Qrvey ID).
+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
 
 
 
@@ -3749,8 +3734,8 @@ 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 |   |
+| filterData |  | The Filter Data or the UI Filter Data |   |
+| params |  | given parameters to validate the filter data |   |
 
 
 
@@ -3758,17 +3743,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 Filter object structure
 
 
 
 
-### dist/filters/helpers/common/isBetweenValidator.js
+### dist/filters/helpers/common/excludeFiltersByScopes.js
 
 
-#### isBetweenValidator(validator) 
+#### excludeFiltersByScopes(filterData, scopes) 
 
-Validates if the given validator is a Between type
+Excludes and returns a filter data without filters by the given scopes
 
 
 
@@ -3777,7 +3762,8 @@ Validates if the given validator is a Between type
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The validator |   |
+| filterData |  | The Filter Data |   |
+| scopes |  | collection of scopes to be as filtering parameters |   |
 
 
 
@@ -3785,17 +3771,17 @@ Validates if the given validator is a Between type
 ##### Returns
 
 
--  true: it is a between validator; false: it is not a between validator
+-  The new Filter Data without filters by the given scopes.
 
 
 
 
-### dist/filters/helpers/common/isDateDistinctProperty.js
+### dist/filters/helpers/common/getFilterColumnLabel.js
 
 
-#### isDateDistinctProperty(column, property) 
+#### getFilterColumnLabel(column) 
 
-Determines if the filter column and property is a distinct group dates type
+Get an string of the properties of the given filter column.
 
 
 
@@ -3805,7 +3791,6 @@ Determines if the filter column and property is a distinct group dates type
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
 | column |  | The filter column |   |
-| property |  | The filter property |   |
 
 
 
@@ -3813,17 +3798,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
+-  an string with the property, aggregate or calculation label.
 
 
 
 
-### dist/filters/helpers/common/isInValidator.js
+### dist/filters/helpers/common/getFilterLabel.js
 
 
-#### isInValidator(validator) 
+#### getFilterLabel(filter) 
 
-Validates if the given validator is a In type
+Gets the Filter Label + Column label
 
 
 
@@ -3832,7 +3817,7 @@ Validates if the given validator is a In type
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The validator |   |
+| filter |  | the UI filter |   |
 
 
 
@@ -3840,17 +3825,17 @@ Validates if the given validator is a In type
 ##### Returns
 
 
--  true: it is a In validator; false: it is not a In validator
+-  a sring label
 
 
 
 
-### dist/filters/helpers/common/isNullValidator.js
+### dist/filters/helpers/common/getFiltersByAggregateColumn.js
 
 
-#### isNullValidator(validator) 
+#### getFiltersByAggregateColumn(filterData) 
 
-Checks if the given validator is a Null type.
+Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
 
 
 
@@ -3859,7 +3844,7 @@ Checks if the given validator is a Null type.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The Filter Validator |   |
+| filterData |  | The filter data object |   |
 
 
 
@@ -3867,17 +3852,28 @@ Checks if the given validator is a Null type.
 ##### Returns
 
 
--  True: It is a Null Validator; False: It is not a Null Validator.
+-  The new filter data object that were get the aggregate filters
 
 
 
 
-### dist/filters/helpers/common/isRangeValidator.js
+### dist/filters/helpers/common/getFilterid.js
 
 
-#### isRangeValidator(validator) 
+#### getFilterid(filter) 
 
-Validates if the given validator is a Range type. Range type means the value has min and max values to 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
 
 
 
@@ -3886,7 +3882,7 @@ Validates if the given validator is a Range type. Range type means the value has
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The filter validator |   |
+| filter |  | the filter structure |   |
 
 
 
@@ -3894,17 +3890,26 @@ Validates if the given validator is a Range type. Range type means the value has
 ##### Returns
 
 
--  true: it is a range validator
+-  a text to identify the filter
 
 
 
 
-### dist/filters/helpers/common/isRegularValidator.js
+### dist/filters/helpers/common/getFiltersByParams.js
 
 
-#### isRegularValidator(validator) 
+#### getFiltersByParams(filterData, params) 
 
-Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
+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
 
 
 
@@ -3913,7 +3918,8 @@ Validates if the given validator is a regular type. Regular type means the filte
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The filter validator |   |
+| filterData |  | The Filter Data or the UI Filter Data |   |
+| params |  | given parameters to validate the dataset |   |
 
 
 
@@ -3921,17 +3927,17 @@ Validates if the given validator is a regular type. Regular type means the filte
 ##### Returns
 
 
--  true: it is a range validator
+-  a new Filter object structure
 
 
 
 
-### dist/filters/helpers/common/mergeFilters.js
+### dist/filters/helpers/common/getFiltersByScopes.js
 
 
-#### mergeFilters(filterData1, filterData2, overwriteValues) 
+#### getFiltersByScopes(filterData, scopes) 
 
-Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
+Filters and gets a Filter Data by the given scopes
 
 
 
@@ -3940,9 +3946,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 |   |
+| filterData |  | The Filter Data |   |
+| scopes |  | collection of scopes types |   |
 
 
 
@@ -3950,13 +3955,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 Filter Data
 
 
 
-#### mergeScopes(scopes1, scopes2, overwriteValues) 
 
-Gets a new scope structure array by merging two scope structures
+### dist/filters/helpers/common/getFiltersByScopesIds.js
+
+
+#### getFiltersByScopesIds(filterData, scopes) 
+
+Gets filters from Filter Data by Scopes/Scope IDs.
 
 
 
@@ -3965,9 +3974,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 |   |
+| filterData |  | The filter data |   |
+| scopes |  | The collection of Scopes/Scope IDs |   |
 
 
 
@@ -3975,13 +3983,17 @@ Gets a new scope structure array by merging two scope structures
 ##### Returns
 
 
--  a new scope structure array
+-  a new Filter Data
 
 
 
-#### mergeDatasets(datasets1, datasets2, overwriteValues) 
 
-Gets a new dataset structure array by merging two dataset structures
+### dist/filters/helpers/common/getFiltersByVisibility.js
+
+
+#### getFiltersByVisibility(filterData, scopes) 
+
+Get a new Filter Data by filtering scopes/scope IDs and enabled flags
 
 
 
@@ -3990,9 +4002,8 @@ 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 |   |
+| filterData |  | a Filter Data or UI Filter Data |   |
+| scopes |  | a Scopes/Scope IDs array |   |
 
 
 
@@ -4000,13 +4011,17 @@ Gets a new dataset structure array by merging two dataset structures
 ##### Returns
 
 
--  a new dataset structure array
+-  a new Filter Data
 
 
 
-#### mergeFilterss(filters1, filters2, overwriteValues) 
 
-Gets a new filter structure array by merging two filter structures
+### dist/filters/helpers/common/getParamsToGetFilterSettings.js
+
+
+#### getParamsToGetFilterSettings(settings) 
+
+Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
 
 
 
@@ -4015,9 +4030,7 @@ Gets a new filter structure array by merging two filter structures
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filters1 |  | the target filter structure |   |
-| filters2 |  | the filter to be merged |   |
-| overwriteValues |  | Flag to overwrite or not the filter values |   |
+| settings |  | an object to the ParamsToGetFilter settings |   |
 
 
 
@@ -4025,13 +4038,17 @@ Gets a new filter structure array by merging two filter structures
 ##### Returns
 
 
--  a new filter structure array
+-  a new ParamsToGetFilter settings object.
 
 
 
-#### mergeValues(filter1, filter2, overwrite) 
 
-Gets a new value structure array by merging two value structures
+### dist/filters/helpers/common/haveFiltersByDataset.js
+
+
+#### haveFiltersByDataset(filterData, qrveyid) 
+
+Validates if the filter data has filters by a dataset ID (Qrvey ID).
 
 
 
@@ -4040,9 +4057,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 |   |
+| filterData |  | the filter data or the UI filter data. |   |
+| qrveyid |  | The Qrvey ID |   |
 
 
 
@@ -4050,17 +4066,17 @@ Gets a new value structure array by merging two value structures
 ##### Returns
 
 
--  a new value structure array
+-  true: the filter data has filters by the Qrvey ID
 
 
 
 
-### dist/filters/helpers/common/resolveDatasetConditions.js
+### dist/filters/helpers/common/isBetweenValidator.js
 
 
-#### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
+#### isBetweenValidator(validator) 
 
-Resolves the conditions by given params
+Validates if the given validator is a Between type
 
 
 
@@ -4069,10 +4085,7 @@ 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. |   |
+| validator |  | The validator |   |
 
 
 
@@ -4080,17 +4093,17 @@ Resolves the conditions by given params
 ##### Returns
 
 
--  true: the condition is satisfied
+-  true: it is a between validator; false: it is not a between validator
 
 
 
 
-### dist/filters/helpers/common/resolveFilterConditions.js
+### dist/filters/helpers/common/isDateDistinctProperty.js
 
 
-#### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
+#### isDateDistinctProperty(column, property) 
 
-Resolves the conditions by given params
+Determines if the filter column and property is a distinct group dates type
 
 
 
@@ -4099,10 +4112,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. |   |
+| column |  | The filter column |   |
+| property |  | The filter property |   |
 
 
 
@@ -4110,17 +4121,17 @@ Resolves the conditions by given params
 ##### Returns
 
 
--  true: the condition is satisfied
+-  True if the given property is included from distinct group dates type
 
 
 
 
-### dist/filters/helpers/common/resolveScopeConditions.js
+### dist/filters/helpers/common/getMergeFiltersSettings.js
 
 
-#### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
+#### getMergeFiltersSettings(settings) 
 
-Resolves the conditions by given params
+Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
 
 
 
@@ -4129,10 +4140,7 @@ 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. |   |
+| settings |  | an object to the MergeFilters settings |   |
 
 
 
@@ -4140,17 +4148,17 @@ Resolves the conditions by given params
 ##### Returns
 
 
--  true: the condition is satisfied
+-  a new MergeFilters settings object.
 
 
 
 
-### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
+### dist/filters/helpers/common/isInValidator.js
 
 
-#### excludeUIFiltersByAggregate(uFilters) 
+#### isInValidator(validator) 
 
-Excludes Aggregate Filters in the Flattened UI Filters array
+Validates if the given validator is a In type
 
 
 
@@ -4159,7 +4167,7 @@ Excludes Aggregate Filters in the Flattened UI Filters array
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilters |  | Collection of Flat UI Filters |   |
+| validator |  | The validator |   |
 
 
 
@@ -4167,17 +4175,17 @@ Excludes Aggregate Filters in the Flattened UI Filters array
 ##### Returns
 
 
--  a new Flat UI Filters that were excluded the aggregate filters
+-  true: it is a In validator; false: it is not a In validator
 
 
 
 
-### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
+### dist/filters/helpers/common/isNullValidator.js
 
 
-#### excludeUIFlatFiltersByScopes(uFilters, scopes) 
+#### isNullValidator(validator) 
 
-Excludes and returns a UI Flat Filters without filters by the given scopes
+Checks if the given validator is a Null type.
 
 
 
@@ -4186,8 +4194,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 |   |
+| validator |  | The Filter Validator |   |
 
 
 
@@ -4195,17 +4202,17 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
 ##### Returns
 
 
--  The new array of UI Flattened filters
+-  True: It is a Null Validator; False: It is not a Null Validator.
 
 
 
 
-### dist/filters/helpers/ui/getFilterPropertyLabel.js
+### dist/filters/helpers/common/isRangeValidator.js
 
 
-#### getFilterPropertyLabel(filter) 
+#### isRangeValidator(validator) 
 
-Gets the label of the filter property
+Validates if the given validator is a Range type. Range type means the value has min and max values to filter
 
 
 
@@ -4214,7 +4221,7 @@ Gets the label of the filter property
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The UI Filter |   |
+| validator |  | The filter validator |   |
 
 
 
@@ -4222,17 +4229,17 @@ Gets the label of the filter property
 ##### Returns
 
 
--  a string of the filter property label
+-  true: it is a range validator
 
 
 
 
-### dist/filters/helpers/ui/getOutputFormatByColumn.js
+### dist/filters/helpers/common/isRegularValidator.js
 
 
-#### getOutputFormatByColumn(column, datasets) 
+#### isRegularValidator(validator) 
 
-Gets output format object from Datasets by the given column. Item of the datasets array must have outputformat item in order to be returned
+Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
 
 
 
@@ -4241,8 +4248,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 |   |
+| validator |  | The filter validator |   |
 
 
 
@@ -4250,18 +4256,17 @@ Gets output format object from Datasets by the given column. Item of the dataset
 ##### Returns
 
 
--  The output format object
+-  true: it is a range validator
 
 
 
 
-### dist/filters/helpers/ui/getQrveyIdsByUIFilters.js
+### dist/filters/helpers/common/mergeFilters.js
 
 
-#### getQrveyIdsByUIFilters(uiFilter) 
+#### mergeFilters(filterData1, filterData2, overwriteValues) 
 
-Gets a collection of Qrvey IDs in the UI Filter structure.
-Looks around all filter structure finding the qrveyid propertty in each dataset
+Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
 
 
 
@@ -4270,7 +4275,9 @@ Looks around all filter structure finding the qrveyid propertty in each dataset
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uiFilter |  |  |   |
+| filterData1 |  | The target filter data |   |
+| filterData2 |  | the filter data to be merged |   |
+| overwriteValues |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -4278,27 +4285,24 @@ Looks around all filter structure finding the qrveyid propertty in each dataset
 ##### Returns
 
 
-- `Void`
+-  a new filter data structure
 
 
 
+#### mergeScopes(scopes1, scopes2, overwriteValues) 
 
-### dist/filters/helpers/ui/getUIFlatFilterByParams.js
+Gets a new scope structure array by merging two scope structures
 
 
-#### 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 |  |
+| ---- | ---- | ----------- | -------- |
+| scopes1 |  | the target scope structure |   |
+| scopes2 |  | the scope to be merged |   |
+| overwriteValues |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -4306,28 +4310,24 @@ The validation to filter the stored filter is depending on:
 ##### Returns
 
 
--  The index of the uFilter array or the Filter object s
+-  a new scope structure array
 
 
 
+#### mergeDatasets(datasets1, datasets2, overwriteValues) 
 
-### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
+Gets a new dataset structure array by merging two dataset structures
 
 
-#### 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 |  |
+| ---- | ---- | ----------- | -------- |
+| datasets1 |  | the target dataset structure |   |
+| datasets2 |  | the dataset to be merged |   |
+| overwriteValues |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -4335,17 +4335,13 @@ The validation to filter the stored filter is depending on:
 ##### Returns
 
 
--  The index of the uFilter array or the Filter object s
-
-
-
+-  a new dataset structure array
 
-### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
 
 
-#### getUIFlatFiltersByScopes(uFilters, scopes) 
+#### mergeFilterss(filters1, filters2, overwriteValues) 
 
-Filters and gets a UI Flatten Filters by the given scopes
+Gets a new filter structure array by merging two filter structures
 
 
 
@@ -4354,8 +4350,9 @@ Filters and gets a UI Flatten Filters by the given scopes
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilters |  | The Flatten UI Filters |   |
-| scopes |  | collection of scopes types |   |
+| filters1 |  | the target filter structure |   |
+| filters2 |  | the filter to be merged |   |
+| overwriteValues |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -4363,17 +4360,13 @@ Filters and gets a UI Flatten Filters by the given scopes
 ##### Returns
 
 
--  The new array of UI Flattened filters
-
-
-
-
-### dist/filters/helpers/ui/getUIValues.js
+-  a new filter structure array
 
 
-#### getUIValues(filter, addEnableds, rankingGroupIndex) 
 
+#### mergeValues(filter1, filter2, overwrite) 
 
+Gets a new value structure array by merging two value structures
 
 
 
@@ -4382,9 +4375,9 @@ Filters and gets a UI Flatten Filters by the given scopes
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  |  |   |
-| addEnableds |  |  |   |
-| rankingGroupIndex |  |  |   |
+| filter1 |  | the target filter structure |   |
+| filter2 |  | the filter to be used to merge the values |   |
+| overwrite |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -4392,17 +4385,17 @@ Filters and gets a UI Flatten Filters by the given scopes
 ##### Returns
 
 
--  
+-  a new value structure array
 
 
 
 
-### dist/filters/helpers/ui/getUpdatedUIFilters.js
+### dist/filters/helpers/common/resolveDatasetConditions.js
 
 
-#### getUpdatedUIFilters(data, datasets) 
+#### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
 
-Gets a new UI Filter structure with a datasets/columns info updates
+Resolves the conditions by given params
 
 
 
@@ -4411,8 +4404,10 @@ Gets a new UI Filter structure with a datasets/columns info updates
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| data |  | The UI Filter structure |   |
-| datasets |  | An array of datasets/column info used for updating the data |   |
+| 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. |   |
 
 
 
@@ -4420,17 +4415,17 @@ Gets a new UI Filter structure with a datasets/columns info updates
 ##### Returns
 
 
--  A new UI FIlter structure
+-  true: the condition is satisfied
 
 
 
 
-### dist/filters/helpers/ui/resolveUIFlatFiltersByParams.js
+### dist/filters/helpers/common/resolveFilterConditions.js
 
 
-#### resolveUIFlatFilterByParams(filter, params) 
+#### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
 
-Resolves conditions between UI flattened filter and given parameters
+Resolves the conditions by given params
 
 
 
@@ -4439,8 +4434,10 @@ Resolves conditions between UI flattened filter and given parameters
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | UI Flatten Filter |   |
-| params |  | Parameters to validate |   |
+| 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. |   |
 
 
 
@@ -4448,17 +4445,17 @@ Resolves conditions between UI flattened filter and given parameters
 ##### Returns
 
 
--  true: the conditions are satisfied.
+-  true: the condition is satisfied
 
 
 
 
-### dist/filters/helpers/common/getFilterColumnLabel.js
+### dist/filters/helpers/common/resolveScopeConditions.js
 
 
-#### getFilterColumnLabel(column) 
+#### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
 
-Get an string of the properties of the given filter column.
+Resolves the conditions by given params
 
 
 
@@ -4467,7 +4464,10 @@ Get an string of the properties of the given filter column.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| column |  | The filter column |   |
+| 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. |   |
 
 
 
@@ -4475,7 +4475,7 @@ Get an string of the properties of the given filter column.
 ##### Returns
 
 
--  an string with the property, aggregate or calculation label.
+-  true: the condition is satisfied