@qrvey/utils 1.2.8 → 1.2.9-3

package/README.md

@@ -1,4 +1,4 @@
-# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.8*
+# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-3*
 
 > Helper, Utils for all Qrvey Projects
 
@@ -688,26 +688,6 @@ Output:
 
 
 
-### dist/filters/classes/FilterInputErrorHandler.js
-
-
-#### new FilterInputErrorHandler() 
-
-
-
-
-
-
-
-
-##### Returns
-
-
-- `Void`
-
-
-
-
 ### dist/filters/adapters/FDToFlatUI.js
 
 
@@ -1023,34 +1003,6 @@ Checks and adapts the v2.0 Filter Data Structure to the v2.1
 
 
 
-### dist/filters/adapters/adaptFilterValues.js
-
-
-#### adaptFilterValues(filter) 
-
-[TODO: For 2022, eliminate this adapter]
-Gets an adapted filter value array. Validates the enabled property and sets
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filter |  | The filter |   |
-
-
-
-
-##### Returns
-
-
--  A new value array with the filled properties.
-
-
-
-
 ### dist/filters/adapters/flatUIToFD.js
 
 
@@ -1172,6 +1124,34 @@ Gets an filter structure for the filter data
 
 
 
+### dist/filters/adapters/adaptFilterValues.js
+
+
+#### adaptFilterValues(filter) 
+
+[TODO: For 2022, eliminate this adapter]
+Gets an adapted filter value array. Validates the enabled property and sets
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| filter |  | The filter |   |
+
+
+
+
+##### Returns
+
+
+-  A new value array with the filled properties.
+
+
+
+
 ### dist/filters/adapters/flatUIToLogic.js
 
 
@@ -1558,6 +1538,26 @@ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
 
 
 
+### dist/filters/classes/FilterInputErrorHandler.js
+
+
+#### new FilterInputErrorHandler() 
+
+
+
+
+
+
+
+
+##### Returns
+
+
+- `Void`
+
+
+
+
 ### dist/filters/helpers/applyHierarchyForAggFilters.js
 
 
@@ -2619,69 +2619,67 @@ Get an string of the properties of the given column.
 
 
 
-### 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(qrveyids) 
 
+Get a dataset list from a collection of Qrvey IDs
 
 
 
 
+##### Parameters
 
-##### Examples
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| qrveyids |  | Collection of Qrvey IDs |   |
 
-```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
 
 
-#### createRef() 
+#### getAllQrveys(config, params) 
 
-lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
+POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
 
 
 
 
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| config |  | Configuration |   |
+| params |  | Object for getting precise data |   |
+
+
 
 
 ##### 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
 
 
 
@@ -2690,7 +2688,7 @@ try to find this string as a variable on Windows object
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| cfg |  |  |   |
+| qrveyid |  | The Qrvey ID |   |
 
 
 
@@ -2698,54 +2696,52 @@ try to find this string as a variable on Windows object
 ##### Returns
 
 
-- `Void`
-
-
+-  a promise
 
 
-### dist/services/api/getAllDatasets.api.js
 
 
-#### getAllDatasets(qrveyids) 
+### 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 |  |
-| ---- | ---- | ----------- | -------- |
-| qrveyids |  | Collection of Qrvey IDs |   |
 
 
 
+##### 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 |   |
 
 
 
@@ -2753,17 +2749,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
 
 
 
@@ -2772,7 +2772,7 @@ Get a dataset by Qrvey ID
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| qrveyid |  | The Qrvey ID |   |
+| cfg |  |  |   |
 
 
 
@@ -2780,7 +2780,7 @@ Get a dataset by Qrvey ID
 ##### Returns
 
 
--  a promise
+- `Void`
 
 
 
@@ -2948,12 +2948,13 @@ Returns a filter builder config object by a any given config
 
 
 
-### dist/filters/helpers/common/areFiltersEquals.js
+### dist/filters/helpers/backend/buildExpression.js
 
 
-#### areFiltersEquals(filter1, filter2) 
+#### buildExpression(filter) 
 
-Validates if both filters are the same
+Builds filter expression by the filter data.
+- If the resulting value array is empty the enabled property will be false.
 
 
 
@@ -2962,8 +2963,7 @@ Validates if both filters are the same
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter1 |  | filter 1 |   |
-| filter2 |  | filter 2 |   |
+| filter |  | The filter to transform |   |
 
 
 
@@ -2971,17 +2971,17 @@ Validates if both filters are the same
 ##### Returns
 
 
--  true: the filters are equal; false: the filters are NOT equal
+-  a filter expression
 
 
 
 
-### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
+### dist/filters/helpers/backend/buildUserFilters.js
 
 
-#### excludeFiltersByAggregateColumn(filterData) 
+#### buildUserFilters(userFilters) 
 
-Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
+Transform user Filters array into Filter Logic structure
 
 
 
@@ -2990,7 +2990,7 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object |   |
+| userFilters |  | The filters that the user defined. |   |
 
 
 
@@ -2998,26 +2998,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 filter logic for the given user filters. if No a given object is recieved, it will return an empty array.
 
 
 
 
-### dist/filters/helpers/common/excludeFiltersByParams.js
+### dist/filters/helpers/backend/getAggFiltersBySummaryIndex.js
 
 
-#### excludeFiltersByParams(filterData, params) 
+#### getAggFiltersBySummaryIndex(aggFilters, summaryIndex) 
+
 
-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
 
 
 
@@ -3026,8 +3017,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 |   |
+| aggFilters |  |  |   |
+| summaryIndex |  |  |   |
 
 
 
@@ -3035,17 +3026,17 @@ The validation to filter the stored filter is depending on:
 ##### Returns
 
 
--  a new Filter object structure
+-  
 
 
 
 
-### dist/filters/helpers/common/excludeFiltersByScopes.js
+### dist/filters/helpers/backend/getBackendGroupValue.js
 
 
-#### excludeFiltersByScopes(filterData, scopes) 
+#### getBackendGroupValue(filter) 
 
-Excludes and returns a filter data without filters by the given scopes
+Gets a group value for the backend logic structure
 
 
 
@@ -3054,8 +3045,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 |   |
+| filter |  | The filter |   |
 
 
 
@@ -3063,17 +3053,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 property
 
 
 
 
-### dist/filters/helpers/common/getFilterColumnLabel.js
+### dist/filters/helpers/backend/getBackendProperty.js
 
 
-#### getFilterColumnLabel(column) 
+#### getBackendProperty(filter) 
 
-Get an string of the properties of the given filter column.
+Gets a property for the logic structure
 
 
 
@@ -3082,7 +3072,7 @@ Get an string of the properties of the given filter column.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| column |  | The filter column |   |
+| filter |  | The filter |   |
 
 
 
@@ -3090,17 +3080,17 @@ Get an string of the properties of the given filter column.
 ##### Returns
 
 
--  an string with the property, aggregate or calculation label.
+-  a property
 
 
 
 
-### dist/filters/helpers/common/getFilterLabel.js
+### dist/filters/helpers/backend/getBackendValidator.js
 
 
-#### getFilterLabel(filter) 
+#### getBackendValidator(validator) 
 
-Gets the Filter Label + Column label
+Gets the Validator that is used in requests
 
 
 
@@ -3109,7 +3099,7 @@ Gets the Filter Label + Column label
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | the UI filter |   |
+| validator |  | Filter Validator used in UI |   |
 
 
 
@@ -3117,28 +3107,17 @@ Gets the Filter Label + Column label
 ##### Returns
 
 
--  a sring label
+-  Filter Validator used in Backend
 
 
 
 
-### dist/filters/helpers/common/getFilterid.js
+### dist/filters/helpers/backend/getBackendValues.js
 
 
-#### getFilterid(filter) 
+#### getBackendValues(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
+Gets the expresion values in the logic format
 
 
 
@@ -3147,7 +3126,7 @@ The order of the epression ID is:
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | the filter structure |   |
+| filter |  | The filter structure |   |
 
 
 
@@ -3155,17 +3134,13 @@ The order of the epression ID is:
 ##### Returns
 
 
--  a text to identify the filter
-
-
-
+-  A collection of backend expression value
 
-### dist/filters/helpers/common/getFiltersByAggregateColumn.js
 
 
-#### getFiltersByAggregateColumn(filterData) 
+#### getResultValues(values, filter) 
 
-Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
+Gets the expression values. Depending on the column type
 
 
 
@@ -3174,7 +3149,8 @@ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggr
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object |   |
+| values |  | a collection of filter values |   |
+| filter |  | The filter structure |   |
 
 
 
@@ -3182,26 +3158,13 @@ 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
-
-
+-  
 
 
-### dist/filters/helpers/common/getFiltersByParams.js
 
+#### getRankingValues(values, rankingGroupIndex) 
 
-#### getFiltersByParams(filterData, params) 
-
-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
+Gets the Ranking values.
 
 
 
@@ -3210,8 +3173,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 |   |
+| values |  | a collection of filter values in the ranking structure |   |
+| rankingGroupIndex |  | determine the value by this index to build and return it |   |
 
 
 
@@ -3219,17 +3182,17 @@ The validation to filter the stored filter is depending on:
 ##### Returns
 
 
--  a new Filter object structure
+-  Expression values for ranking
 
 
 
 
-### dist/filters/helpers/common/getFiltersByScopes.js
+### dist/filters/helpers/backend/getLogicByScopes.js
 
 
-#### getFiltersByScopes(filterData, scopes) 
+#### getLogicByScopes(logics, scopes) 
 
-Filters and gets a Filter Data by the given scopes
+Gets the filters from logic data by Scopes/Scope IDs.
 
 
 
@@ -3238,8 +3201,8 @@ Filters and gets a Filter Data by the given scopes
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The Filter Data |   |
-| scopes |  | collection of scopes types |   |
+| logics |  | The logic array |   |
+| scopes |  | The collection of Scopes/Scope IDs |   |
 
 
 
@@ -3247,17 +3210,17 @@ Filters and gets a Filter Data by the given scopes
 ##### Returns
 
 
--  The new Filter Data
+-  a new Logic array
 
 
 
 
-### dist/filters/helpers/common/getFiltersByScopesIds.js
+### dist/filters/helpers/backend/getLogicByScopesHierarchy.js
 
 
-#### getFiltersByScopesIds(filterData, scopes) 
+#### getLogicByScopesHierarchy(filterData, scopes, currentScope) 
 
-Gets filters from Filter Data by Scopes/Scope IDs.
+Gets filters from the logic by the scopes hierarchy.
 
 
 
@@ -3266,8 +3229,9 @@ Gets filters from Filter Data by Scopes/Scope IDs.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data |   |
-| scopes |  | The collection of Scopes/Scope IDs |   |
+| filterData |  |  |   |
+| scopes |  |  |   |
+| currentScope |  |  |   |
 
 
 
@@ -3275,17 +3239,17 @@ Gets filters from Filter Data by Scopes/Scope IDs.
 ##### Returns
 
 
--  a new Filter Data
+-  a new array of Logic
 
 
 
 
-### dist/filters/helpers/common/getFiltersByVisibility.js
+### dist/filters/helpers/common/areFiltersEquals.js
 
 
-#### getFiltersByVisibility(filterData, scopes) 
+#### areFiltersEquals(filter1, filter2) 
 
-Get a new Filter Data by filtering scopes/scope IDs and enabled flags
+Validates if both filters are the same
 
 
 
@@ -3294,8 +3258,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 |   |
+| filter1 |  | filter 1 |   |
+| filter2 |  | filter 2 |   |
 
 
 
@@ -3303,17 +3267,17 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
 ##### Returns
 
 
--  a new Filter Data
+-  true: the filters are equal; false: the filters are NOT equal
 
 
 
 
-### dist/filters/helpers/common/getMergeFiltersSettings.js
+### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
 
 
-#### getMergeFiltersSettings(settings) 
+#### excludeFiltersByAggregateColumn(filterData) 
 
-Transforms the given MergeFilters 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.
 
 
 
@@ -3322,7 +3286,7 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| settings |  | an object to the MergeFilters settings |   |
+| filterData |  | The filter data object |   |
 
 
 
@@ -3330,17 +3294,26 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
 ##### Returns
 
 
--  a new MergeFilters settings object.
+-  The new filter data object that were excluded the aggregate filters
 
 
 
 
-### dist/filters/helpers/common/getParamsToGetFilterSettings.js
+### dist/filters/helpers/common/excludeFiltersByParams.js
 
 
-#### getParamsToGetFilterSettings(settings) 
+#### excludeFiltersByParams(filterData, params) 
 
-Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
+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
 
 
 
@@ -3349,7 +3322,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 |   |
+| params |  | given parameters to validate the filter data |   |
 
 
 
@@ -3357,17 +3331,17 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
 ##### Returns
 
 
--  a new ParamsToGetFilter settings object.
+-  a new Filter object structure
 
 
 
 
-### dist/filters/helpers/common/haveFiltersByDataset.js
+### dist/filters/helpers/common/excludeFiltersByScopes.js
 
 
-#### haveFiltersByDataset(filterData, qrveyid) 
+#### excludeFiltersByScopes(filterData, scopes) 
 
-Validates if the filter data has filters by a dataset ID (Qrvey ID).
+Excludes and returns a filter data without filters by the given scopes
 
 
 
@@ -3376,8 +3350,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 |   |
+| scopes |  | collection of scopes to be as filtering parameters |   |
 
 
 
@@ -3385,17 +3359,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
+-  The new Filter Data without filters by the given scopes.
 
 
 
 
-### dist/filters/helpers/common/isBetweenValidator.js
+### dist/filters/helpers/common/getFilterColumnLabel.js
 
 
-#### isBetweenValidator(validator) 
+#### getFilterColumnLabel(column) 
 
-Validates if the given validator is a Between type
+Get an string of the properties of the given filter column.
 
 
 
@@ -3404,7 +3378,7 @@ Validates if the given validator is a Between type
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The validator |   |
+| column |  | The filter column |   |
 
 
 
@@ -3412,17 +3386,17 @@ Validates if the given validator is a Between type
 ##### Returns
 
 
--  true: it is a between validator; false: it is not a between validator
+-  an string with the property, aggregate or calculation label.
 
 
 
 
-### dist/filters/helpers/common/isDateDistinctProperty.js
+### dist/filters/helpers/common/getFilterLabel.js
 
 
-#### isDateDistinctProperty(column, property) 
+#### getFilterLabel(filter) 
 
-Determines if the filter column and property is a distinct group dates type
+Gets the Filter Label + Column label
 
 
 
@@ -3431,8 +3405,7 @@ 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 UI filter |   |
 
 
 
@@ -3440,17 +3413,28 @@ 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
+-  a sring label
 
 
 
 
-### dist/filters/helpers/common/isInValidator.js
+### dist/filters/helpers/common/getFilterid.js
 
 
-#### isInValidator(validator) 
+#### getFilterid(filter) 
 
-Validates if the given validator is a In type
+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
 
 
 
@@ -3459,7 +3443,7 @@ Validates if the given validator is a In type
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The validator |   |
+| filter |  | the filter structure |   |
 
 
 
@@ -3467,17 +3451,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 text to identify the filter
 
 
 
 
-### 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.
 
 
 
@@ -3486,7 +3470,7 @@ Checks if the given validator is a Null type.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The Filter Validator |   |
+| filterData |  | The filter data object |   |
 
 
 
@@ -3494,17 +3478,26 @@ 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/getFiltersByParams.js
 
 
-#### isRangeValidator(validator) 
+#### getFiltersByParams(filterData, params) 
 
-Validates if the given validator is a Range type. Range type means the value has min and max values 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
 
 
 
@@ -3513,7 +3506,8 @@ Validates if the given validator is a Range type. Range type means the value has
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The filter validator |   |
+| filterData |  | The Filter Data or the UI Filter Data |   |
+| params |  | given parameters to validate the dataset |   |
 
 
 
@@ -3521,17 +3515,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 Filter object structure
 
 
 
 
-### dist/filters/helpers/common/isRegularValidator.js
+### dist/filters/helpers/common/getFiltersByScopes.js
 
 
-#### isRegularValidator(validator) 
+#### getFiltersByScopes(filterData, scopes) 
 
-Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
+Filters and gets a Filter Data by the given scopes
 
 
 
@@ -3540,7 +3534,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 |   |
+| scopes |  | collection of scopes types |   |
 
 
 
@@ -3548,17 +3543,17 @@ Validates if the given validator is a regular type. Regular type means the filte
 ##### Returns
 
 
--  true: it is a range validator
+-  The new Filter Data
 
 
 
 
-### dist/filters/helpers/common/mergeFilters.js
+### dist/filters/helpers/common/getFiltersByScopesIds.js
 
 
-#### mergeFilters(filterData1, filterData2, overwriteValues) 
+#### getFiltersByScopesIds(filterData, scopes) 
 
-Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
+Gets filters from Filter Data by Scopes/Scope IDs.
 
 
 
@@ -3567,9 +3562,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 |  | The collection of Scopes/Scope IDs |   |
 
 
 
@@ -3577,13 +3571,17 @@ Merge filter data structures in a new one. The first Filter Data passed in the a
 ##### Returns
 
 
--  a new filter data structure
+-  a new Filter Data
 
 
 
-#### mergeScopes(scopes1, scopes2, overwriteValues) 
 
-Gets a new scope structure array by merging two scope structures
+### dist/filters/helpers/common/getFiltersByVisibility.js
+
+
+#### getFiltersByVisibility(filterData, scopes) 
+
+Get a new Filter Data by filtering scopes/scope IDs and enabled flags
 
 
 
@@ -3592,9 +3590,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 |  | a Filter Data or UI Filter Data |   |
+| scopes |  | a Scopes/Scope IDs array |   |
 
 
 
@@ -3602,13 +3599,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/getMergeFiltersSettings.js
+
+
+#### getMergeFiltersSettings(settings) 
+
+Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
 
 
 
@@ -3617,9 +3618,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 |   |
+| settings |  | an object to the MergeFilters settings |   |
 
 
 
@@ -3627,13 +3626,17 @@ Gets a new dataset structure array by merging two dataset structures
 ##### Returns
 
 
--  a new dataset structure array
+-  a new MergeFilters settings object.
 
 
 
-#### 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.
 
 
 
@@ -3642,9 +3645,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 |   |
 
 
 
@@ -3652,13 +3653,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).
 
 
 
@@ -3667,9 +3672,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 |   |
 
 
 
@@ -3677,17 +3681,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
 
 
 
@@ -3696,10 +3700,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 |   |
 
 
 
@@ -3707,17 +3708,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
 
 
 
@@ -3726,10 +3727,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 |   |
 
 
 
@@ -3737,17 +3736,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/isInValidator.js
 
 
-#### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
+#### isInValidator(validator) 
 
-Resolves the conditions by given params
+Validates if the given validator is a In type
 
 
 
@@ -3756,10 +3755,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. |   |
+| validator |  | The validator |   |
 
 
 
@@ -3767,18 +3763,17 @@ Resolves the conditions by given params
 ##### Returns
 
 
--  true: the condition is satisfied
+-  true: it is a In validator; false: it is not a In validator
 
 
 
 
-### dist/filters/helpers/backend/buildExpression.js
+### dist/filters/helpers/common/isNullValidator.js
 
 
-#### buildExpression(filter) 
+#### isNullValidator(validator) 
 
-Builds filter expression by the filter data.
-- If the resulting value array is empty the enabled property will be false.
+Checks if the given validator is a Null type.
 
 
 
@@ -3787,7 +3782,7 @@ Builds filter expression by the filter data.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The filter to transform |   |
+| validator |  | The Filter Validator |   |
 
 
 
@@ -3795,17 +3790,17 @@ Builds filter expression by the filter data.
 ##### Returns
 
 
--  a filter expression
+-  True: It is a Null Validator; False: It is not a Null Validator.
 
 
 
 
-### dist/filters/helpers/backend/buildUserFilters.js
+### dist/filters/helpers/common/isRangeValidator.js
 
 
-#### buildUserFilters(userFilters) 
+#### isRangeValidator(validator) 
 
-Transform user Filters array into Filter Logic structure
+Validates if the given validator is a Range type. Range type means the value has min and max values to filter
 
 
 
@@ -3814,7 +3809,7 @@ Transform user Filters array into Filter Logic structure
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| userFilters |  | The filters that the user defined. |   |
+| validator |  | The filter validator |   |
 
 
 
@@ -3822,17 +3817,17 @@ Transform user Filters array into Filter Logic structure
 ##### Returns
 
 
--  The filter logic for the given user filters. if No a given object is recieved, it will return an empty array.
-
+-  true: it is a range validator
 
 
 
-### dist/filters/helpers/backend/getAggFiltersBySummaryIndex.js
 
+### dist/filters/helpers/common/isRegularValidator.js
 
-#### getAggFiltersBySummaryIndex(aggFilters, summaryIndex) 
 
+#### isRegularValidator(validator) 
 
+Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
 
 
 
@@ -3841,8 +3836,7 @@ Transform user Filters array into Filter Logic structure
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| aggFilters |  |  |   |
-| summaryIndex |  |  |   |
+| validator |  | The filter validator |   |
 
 
 
@@ -3850,17 +3844,17 @@ Transform user Filters array into Filter Logic structure
 ##### Returns
 
 
--  
+-  true: it is a range validator
 
 
 
 
-### dist/filters/helpers/backend/getBackendGroupValue.js
+### dist/filters/helpers/common/mergeFilters.js
 
 
-#### getBackendGroupValue(filter) 
+#### mergeFilters(filterData1, filterData2, overwriteValues) 
 
-Gets a group value for the backend logic structure
+Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
 
 
 
@@ -3869,7 +3863,9 @@ Gets a group value for the backend logic structure
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The filter |   |
+| filterData1 |  | The target filter data |   |
+| filterData2 |  | the filter data to be merged |   |
+| overwriteValues |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -3877,17 +3873,13 @@ Gets a group value for the backend logic structure
 ##### Returns
 
 
--  a property
-
-
-
+-  a new filter data structure
 
-### dist/filters/helpers/backend/getBackendProperty.js
 
 
-#### getBackendProperty(filter) 
+#### mergeScopes(scopes1, scopes2, overwriteValues) 
 
-Gets a property for the logic structure
+Gets a new scope structure array by merging two scope structures
 
 
 
@@ -3896,7 +3888,9 @@ Gets a property for the logic structure
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The filter |   |
+| scopes1 |  | the target scope structure |   |
+| scopes2 |  | the scope to be merged |   |
+| overwriteValues |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -3904,17 +3898,13 @@ Gets a property for the logic structure
 ##### Returns
 
 
--  a property
-
-
-
+-  a new scope structure array
 
-### dist/filters/helpers/backend/getBackendValidator.js
 
 
-#### getBackendValidator(validator) 
+#### mergeDatasets(datasets1, datasets2, overwriteValues) 
 
-Gets the Validator that is used in requests
+Gets a new dataset structure array by merging two dataset structures
 
 
 
@@ -3923,7 +3913,9 @@ Gets the Validator that is used in requests
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | Filter Validator used in UI |   |
+| datasets1 |  | the target dataset structure |   |
+| datasets2 |  | the dataset to be merged |   |
+| overwriteValues |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -3931,17 +3923,13 @@ Gets the Validator that is used in requests
 ##### Returns
 
 
--  Filter Validator used in Backend
-
-
-
+-  a new dataset structure array
 
-### dist/filters/helpers/backend/getBackendValues.js
 
 
-#### getBackendValues(filter) 
+#### mergeFilterss(filters1, filters2, overwriteValues) 
 
-Gets the expresion values in the logic format
+Gets a new filter structure array by merging two filter structures
 
 
 
@@ -3950,7 +3938,9 @@ Gets the expresion values in the logic format
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The filter structure |   |
+| filters1 |  | the target filter structure |   |
+| filters2 |  | the filter to be merged |   |
+| overwriteValues |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -3958,13 +3948,13 @@ Gets the expresion values in the logic format
 ##### Returns
 
 
--  A collection of backend expression value
+-  a new filter structure array
 
 
 
-#### getResultValues(values, filter) 
+#### mergeValues(filter1, filter2, overwrite) 
 
-Gets the expression values. Depending on the column type
+Gets a new value structure array by merging two value structures
 
 
 
@@ -3973,8 +3963,9 @@ Gets the expression values. Depending on the column type
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| values |  | a collection of filter values |   |
-| filter |  | The filter structure |   |
+| filter1 |  | the target filter structure |   |
+| filter2 |  | the filter to be used to merge the values |   |
+| overwrite |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -3982,13 +3973,17 @@ Gets the expression values. Depending on the column type
 ##### Returns
 
 
--  
+-  a new value structure array
 
 
 
-#### getRankingValues(values, rankingGroupIndex) 
 
-Gets the Ranking values.
+### dist/filters/helpers/common/resolveDatasetConditions.js
+
+
+#### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
+
+Resolves the conditions by given params
 
 
 
@@ -3997,8 +3992,10 @@ Gets the Ranking values.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| values |  | a collection of filter values in the ranking structure |   |
-| rankingGroupIndex |  | determine the value by this index to build and return it |   |
+| 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. |   |
 
 
 
@@ -4006,17 +4003,17 @@ Gets the Ranking values.
 ##### Returns
 
 
--  Expression values for ranking
+-  true: the condition is satisfied
 
 
 
 
-### dist/filters/helpers/backend/getLogicByScopes.js
+### dist/filters/helpers/common/resolveFilterConditions.js
 
 
-#### getLogicByScopes(logics, scopes) 
+#### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
 
-Gets the filters from logic data by Scopes/Scope IDs.
+Resolves the conditions by given params
 
 
 
@@ -4025,8 +4022,10 @@ Gets the filters from logic data by Scopes/Scope IDs.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| logics |  | The logic array |   |
-| scopes |  | The collection of Scopes/Scope IDs |   |
+| 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. |   |
 
 
 
@@ -4034,17 +4033,17 @@ Gets the filters from logic data by Scopes/Scope IDs.
 ##### Returns
 
 
--  a new Logic array
+-  true: the condition is satisfied
 
 
 
 
-### dist/filters/helpers/backend/getLogicByScopesHierarchy.js
+### dist/filters/helpers/common/resolveScopeConditions.js
 
 
-#### getLogicByScopesHierarchy(filterData, scopes, currentScope) 
+#### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
 
-Gets filters from the logic by the scopes hierarchy.
+Resolves the conditions by given params
 
 
 
@@ -4053,9 +4052,10 @@ Gets filters from the logic by the scopes hierarchy.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  |  |   |
-| scopes |  |  |   |
-| currentScope |  |  |   |
+| 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. |   |
 
 
 
@@ -4063,7 +4063,7 @@ Gets filters from the logic by the scopes hierarchy.
 ##### Returns
 
 
--  a new array of Logic
+-  true: the condition is satisfied