@qrvey/utils 1.2.9-0 → 1.2.9-12

package/README.md

@@ -1,4 +1,4 @@
-# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-0*
+# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-12*
 
 > Helper, Utils for all Qrvey Projects
 
@@ -2153,33 +2153,6 @@ Gets the length of the given array.
 
 
 
-### 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/object/cloneDeep.js
 
 
@@ -2592,12 +2565,12 @@ serialize object to url param
 
 
 
-### dist/qrvey/helpers/getColumnsLabel.js
+### dist/general/string/capitalize.js
 
 
-#### getColumnLabels(column) 
+#### capitalize(text) 
 
-Get an string of the properties of the given column.
+Upper case the first letter of a given text
 
 
 
@@ -2606,7 +2579,7 @@ Get an string of the properties of the given column.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| column |  | The column |   |
+| text | `String`  |  |   |
 
 
 
@@ -2614,52 +2587,53 @@ Get an string of the properties of the given column.
 ##### Returns
 
 
--  an string with the property, aggregate or calculation label.
-
+- `String`  a capitalized text
 
 
 
-### dist/stencil/decorators/Config.js
 
+### dist/qrvey/helpers/getColumnsLabel.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
+#### getColumnLabels(column) 
 
+Get an string of the properties of the given column.
 
 
 
 
+##### Parameters
 
-##### Examples
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| column |  | The column |   |
 
-```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`
+-  an string with the property, aggregate or calculation label.
 
 
 
 
-### dist/stencil/util/createRef.js
+### dist/services/api/getAllDatasets.api.js
+
+
+#### getAllDatasets(qrveyids) 
+
+Get a dataset list from a collection of Qrvey IDs
 
 
-#### createRef() 
 
-lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
 
+##### Parameters
 
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| qrveyids |  | Collection of Qrvey IDs |   |
 
 
 
@@ -2667,21 +2641,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
+-  a promise
 
 
 
 
-### dist/stencil/util/getConfig.js
+### dist/services/api/getAllQrveys.api.js
 
 
-#### getConfig(cfg) 
+#### getAllQrveys(config, params) 
 
-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
+POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
 
 
 
@@ -2690,7 +2660,8 @@ try to find this string as a variable on Windows object
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| cfg |  |  |   |
+| config |  | Configuration |   |
+| params |  | Object for getting precise data |   |
 
 
 
@@ -2703,12 +2674,12 @@ try to find this string as a variable on Windows object
 
 
 
-### dist/services/api/getAllDatasets.api.js
+### dist/services/api/getDatasetColumns.api.js
 
 
-#### getAllDatasets(qrveyids) 
+#### getDatasetColumns(qrveyid) 
 
-Get a dataset list from a collection of Qrvey IDs
+Get a dataset by Qrvey ID
 
 
 
@@ -2717,7 +2688,7 @@ Get a dataset list from a collection of Qrvey IDs
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| qrveyids |  | Collection of Qrvey IDs |   |
+| qrveyid |  | The Qrvey ID |   |
 
 
 
@@ -2730,24 +2701,29 @@ Get a dataset list from a collection of Qrvey IDs
 
 
 
-### dist/services/api/getAllQrveys.api.js
+### dist/stencil/decorators/Config.js
 
 
-#### getAllQrveys(config, params) 
+#### Config() 
 
-POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
+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 |  | Configuration |   |
-| params |  | Object for getting precise data |   |
 
+##### Examples
+
+```javascript
+\ @Config() @Prop() settings;
 
+someMethod() {
+ this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
+}
+```
 
 
 ##### Returns
@@ -2758,12 +2734,36 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
 
 
 
-### dist/services/api/getDatasetColumns.api.js
+### dist/stencil/util/createRef.js
 
 
-#### getDatasetColumns(qrveyid) 
+#### createRef() 
 
-Get a dataset by Qrvey ID
+lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
+
+
+
+
+
+
+##### Returns
+
+
+-  function - Function to use in ref prop in html elements
+
+
+
+
+### dist/stencil/util/getConfig.js
+
+
+#### getConfig(cfg) 
+
+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`
 
 
 
@@ -3244,12 +3244,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
 
 
 
@@ -3258,8 +3258,7 @@ Validates if both filters are the same
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter1 |  | filter 1 |   |
-| filter2 |  | filter 2 |   |
+| uFilters |  | Collection of Flat UI Filters |   |
 
 
 
@@ -3267,17 +3266,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
 
 
 
@@ -3286,7 +3285,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 |   |
 
 
 
@@ -3294,26 +3294,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
 
 
 
@@ -3322,8 +3313,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 |   |
 
 
 
@@ -3331,17 +3321,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
 
 
 
@@ -3350,8 +3340,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 |   |
 
 
 
@@ -3359,91 +3349,84 @@ 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/getFilterColumnLabel.js
 
+### dist/filters/helpers/ui/getUIFlatFilterByParams.js
 
-#### getFilterColumnLabel(column) 
 
-Get an string of the properties of the given filter column.
+#### 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 |  |
-| ---- | ---- | ----------- | -------- |
-| column |  | The filter column |   |
 
 
+##### Returns
 
 
-##### Returns
+-  The index of the uFilter array or the Filter object s
 
 
--  an string with the property, aggregate or calculation label.
 
 
+### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
 
 
-### dist/filters/helpers/common/getFilterLabel.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
 
-#### getFilterLabel(filter) 
 
-Gets the Filter Label + Column label
 
 
 
 
-##### Parameters
+##### Returns
 
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filter |  | the UI filter |   |
 
+-  The index of the uFilter array or the Filter object s
 
 
 
-##### Returns
 
+### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
 
--  a sring label
 
+#### getUIFlatFiltersByScopes(uFilters, scopes) 
 
+Filters and gets a UI Flatten Filters by the given scopes
 
 
-### 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
-
-
-
-
-##### Parameters
+##### Parameters
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | the filter structure |   |
+| uFilters |  | The Flatten UI Filters |   |
+| scopes |  | collection of scopes types |   |
 
 
 
@@ -3451,17 +3434,17 @@ The order of the epression ID is:
 ##### Returns
 
 
--  a text to identify the filter
+-  The new array of UI Flattened filters
 
 
 
 
-### dist/filters/helpers/common/getFiltersByAggregateColumn.js
+### dist/filters/helpers/ui/getUIValues.js
 
 
-#### getFiltersByAggregateColumn(filterData) 
+#### getUIValues(filter, addEnableds, rankingGroupIndex) 
+
 
-Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
 
 
 
@@ -3470,7 +3453,9 @@ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggr
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object |   |
+| filter |  |  |   |
+| addEnableds |  |  |   |
+| rankingGroupIndex |  |  |   |
 
 
 
@@ -3478,26 +3463,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
+-  
 
 
 
 
-### dist/filters/helpers/common/getFiltersByParams.js
+### dist/filters/helpers/ui/resolveUIFlatFiltersByParams.js
 
 
-#### getFiltersByParams(filterData, params) 
+#### resolveUIFlatFilterByParams(filter, 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
+Resolves conditions between UI flattened filter and given parameters
 
 
 
@@ -3506,8 +3482,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 |   |
+| filter |  | UI Flatten Filter |   |
+| params |  | Parameters to validate |   |
 
 
 
@@ -3515,17 +3491,17 @@ The validation to filter the stored filter is depending on:
 ##### Returns
 
 
--  a new Filter object structure
+-  true: the conditions are satisfied.
 
 
 
 
-### dist/filters/helpers/common/getFiltersByScopes.js
+### dist/filters/helpers/common/areFiltersEquals.js
 
 
-#### getFiltersByScopes(filterData, scopes) 
+#### areFiltersEquals(filter1, filter2) 
 
-Filters and gets a Filter Data by the given scopes
+Validates if both filters are the same
 
 
 
@@ -3534,8 +3510,8 @@ Filters and gets a Filter Data by the given scopes
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The Filter Data |   |
-| scopes |  | collection of scopes types |   |
+| filter1 |  | filter 1 |   |
+| filter2 |  | filter 2 |   |
 
 
 
@@ -3543,17 +3519,17 @@ Filters and gets a Filter Data by the given scopes
 ##### Returns
 
 
--  The new Filter Data
+-  true: the filters are equal; false: the filters are NOT equal
 
 
 
 
-### dist/filters/helpers/common/getFiltersByScopesIds.js
+### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
 
 
-#### getFiltersByScopesIds(filterData, scopes) 
+#### excludeFiltersByAggregateColumn(filterData) 
 
-Gets filters from Filter Data by Scopes/Scope IDs.
+Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
 
 
 
@@ -3562,8 +3538,7 @@ Gets filters from Filter Data by Scopes/Scope IDs.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data |   |
-| scopes |  | The collection of Scopes/Scope IDs |   |
+| filterData |  | The filter data object |   |
 
 
 
@@ -3571,17 +3546,26 @@ Gets filters from Filter Data by Scopes/Scope IDs.
 ##### Returns
 
 
--  a new Filter Data
+-  The new filter data object that were excluded the aggregate filters
 
 
 
 
-### dist/filters/helpers/common/getFiltersByVisibility.js
+### dist/filters/helpers/common/excludeFiltersByParams.js
 
 
-#### getFiltersByVisibility(filterData, scopes) 
+#### excludeFiltersByParams(filterData, params) 
 
-Get a new Filter Data by filtering scopes/scope IDs and enabled flags
+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
 
 
 
@@ -3590,8 +3574,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 |   |
+| filterData |  | The Filter Data or the UI Filter Data |   |
+| params |  | given parameters to validate the filter data |   |
 
 
 
@@ -3599,17 +3583,17 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
 ##### Returns
 
 
--  a new Filter Data
+-  a new Filter object structure
 
 
 
 
-### dist/filters/helpers/common/getMergeFiltersSettings.js
+### dist/filters/helpers/common/excludeFiltersByScopes.js
 
 
-#### getMergeFiltersSettings(settings) 
+#### excludeFiltersByScopes(filterData, scopes) 
 
-Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
+Excludes and returns a filter data without filters by the given scopes
 
 
 
@@ -3618,7 +3602,8 @@ 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 |   |
+| scopes |  | collection of scopes to be as filtering parameters |   |
 
 
 
@@ -3626,17 +3611,17 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
 ##### Returns
 
 
--  a new MergeFilters settings object.
+-  The new Filter Data without filters by the given scopes.
 
 
 
 
-### dist/filters/helpers/common/getParamsToGetFilterSettings.js
+### dist/filters/helpers/common/getFilterColumnLabel.js
 
 
-#### getParamsToGetFilterSettings(settings) 
+#### getFilterColumnLabel(column) 
 
-Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
+Get an string of the properties of the given filter column.
 
 
 
@@ -3645,7 +3630,7 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| settings |  | an object to the ParamsToGetFilter settings |   |
+| column |  | The filter column |   |
 
 
 
@@ -3653,17 +3638,17 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
 ##### Returns
 
 
--  a new ParamsToGetFilter settings object.
+-  an string with the property, aggregate or calculation label.
 
 
 
 
-### dist/filters/helpers/common/haveFiltersByDataset.js
+### dist/filters/helpers/common/getFilterLabel.js
 
 
-#### haveFiltersByDataset(filterData, qrveyid) 
+#### getFilterLabel(filter) 
 
-Validates if the filter data has filters by a dataset ID (Qrvey ID).
+Gets the Filter Label + Column label
 
 
 
@@ -3672,8 +3657,7 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | the filter data or the UI filter data. |   |
-| qrveyid |  | The Qrvey ID |   |
+| filter |  | the UI filter |   |
 
 
 
@@ -3681,17 +3665,28 @@ 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 sring label
 
 
 
 
-### dist/filters/helpers/common/isBetweenValidator.js
+### dist/filters/helpers/common/getFilterid.js
 
 
-#### isBetweenValidator(validator) 
+#### getFilterid(filter) 
 
-Validates if the given validator is a Between 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
 
 
 
@@ -3700,7 +3695,7 @@ Validates if the given validator is a Between type
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The validator |   |
+| filter |  | the filter structure |   |
 
 
 
@@ -3708,17 +3703,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 text to identify the filter
 
 
 
 
-### dist/filters/helpers/common/isDateDistinctProperty.js
+### dist/filters/helpers/common/getFiltersByAggregateColumn.js
 
 
-#### isDateDistinctProperty(column, property) 
+#### getFiltersByAggregateColumn(filterData) 
 
-Determines if the filter column and property is a distinct group dates type
+Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
 
 
 
@@ -3727,8 +3722,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 |   |
+| filterData |  | The filter data object |   |
 
 
 
@@ -3736,17 +3730,26 @@ 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
+-  The new filter data object that were get the aggregate filters
 
 
 
 
-### dist/filters/helpers/common/isInValidator.js
+### dist/filters/helpers/common/getFiltersByParams.js
 
 
-#### isInValidator(validator) 
+#### getFiltersByParams(filterData, params) 
 
-Validates if the given validator is a In type
+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
 
 
 
@@ -3755,7 +3758,8 @@ Validates if the given validator is a In type
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The validator |   |
+| filterData |  | The Filter Data or the UI Filter Data |   |
+| params |  | given parameters to validate the dataset |   |
 
 
 
@@ -3763,17 +3767,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 new Filter object structure
 
 
 
 
-### dist/filters/helpers/common/isNullValidator.js
+### dist/filters/helpers/common/getFiltersByScopes.js
 
 
-#### isNullValidator(validator) 
+#### getFiltersByScopes(filterData, scopes) 
 
-Checks if the given validator is a Null type.
+Filters and gets a Filter Data by the given scopes
 
 
 
@@ -3782,7 +3786,8 @@ Checks if the given validator is a Null type.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The Filter Validator |   |
+| filterData |  | The Filter Data |   |
+| scopes |  | collection of scopes types |   |
 
 
 
@@ -3790,17 +3795,17 @@ 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
 
 
 
 
-### dist/filters/helpers/common/isRangeValidator.js
+### dist/filters/helpers/common/getFiltersByScopesIds.js
 
 
-#### isRangeValidator(validator) 
+#### getFiltersByScopesIds(filterData, scopes) 
 
-Validates if the given validator is a Range type. Range type means the value has min and max values to filter
+Gets filters from Filter Data by Scopes/Scope IDs.
 
 
 
@@ -3809,7 +3814,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 |   |
+| scopes |  | The collection of Scopes/Scope IDs |   |
 
 
 
@@ -3817,17 +3823,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 Data
 
 
 
 
-### dist/filters/helpers/common/isRegularValidator.js
+### dist/filters/helpers/common/getFiltersByVisibility.js
 
 
-#### isRegularValidator(validator) 
+#### getFiltersByVisibility(filterData, scopes) 
 
-Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
+Get a new Filter Data by filtering scopes/scope IDs and enabled flags
 
 
 
@@ -3836,7 +3842,8 @@ Validates if the given validator is a regular type. Regular type means the filte
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The filter validator |   |
+| filterData |  | a Filter Data or UI Filter Data |   |
+| scopes |  | a Scopes/Scope IDs array |   |
 
 
 
@@ -3844,17 +3851,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 Data
 
 
 
 
-### dist/filters/helpers/common/mergeFilters.js
+### dist/filters/helpers/common/getMergeFiltersSettings.js
 
 
-#### mergeFilters(filterData1, filterData2, overwriteValues) 
+#### getMergeFiltersSettings(settings) 
 
-Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
+Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
 
 
 
@@ -3863,9 +3870,7 @@ 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 |   |
+| settings |  | an object to the MergeFilters settings |   |
 
 
 
@@ -3873,13 +3878,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 MergeFilters settings object.
 
 
 
-#### mergeScopes(scopes1, scopes2, overwriteValues) 
 
-Gets a new scope structure array by merging two scope structures
+### dist/filters/helpers/common/getParamsToGetFilterSettings.js
+
+
+#### getParamsToGetFilterSettings(settings) 
+
+Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
 
 
 
@@ -3888,9 +3897,7 @@ 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 |   |
+| settings |  | an object to the ParamsToGetFilter settings |   |
 
 
 
@@ -3898,13 +3905,17 @@ Gets a new scope structure array by merging two scope structures
 ##### Returns
 
 
--  a new scope structure array
+-  a new ParamsToGetFilter settings object.
 
 
 
-#### mergeDatasets(datasets1, datasets2, overwriteValues) 
 
-Gets a new dataset structure array by merging two dataset structures
+### dist/filters/helpers/common/haveFiltersByDataset.js
+
+
+#### haveFiltersByDataset(filterData, qrveyid) 
+
+Validates if the filter data has filters by a dataset ID (Qrvey ID).
 
 
 
@@ -3913,9 +3924,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 |  | the filter data or the UI filter data. |   |
+| qrveyid |  | The Qrvey ID |   |
 
 
 
@@ -3923,13 +3933,17 @@ Gets a new dataset structure array by merging two dataset structures
 ##### Returns
 
 
--  a new dataset structure array
+-  true: the filter data has filters by the Qrvey ID
 
 
 
-#### mergeFilterss(filters1, filters2, overwriteValues) 
 
-Gets a new filter structure array by merging two filter structures
+### dist/filters/helpers/common/isBetweenValidator.js
+
+
+#### isBetweenValidator(validator) 
+
+Validates if the given validator is a Between type
 
 
 
@@ -3938,9 +3952,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 |   |
+| validator |  | The validator |   |
 
 
 
@@ -3948,13 +3960,17 @@ Gets a new filter structure array by merging two filter structures
 ##### Returns
 
 
--  a new filter structure array
+-  true: it is a between validator; false: it is not a between validator
 
 
 
-#### mergeValues(filter1, filter2, overwrite) 
 
-Gets a new value structure array by merging two value structures
+### dist/filters/helpers/common/isDateDistinctProperty.js
+
+
+#### isDateDistinctProperty(column, property) 
+
+Determines if the filter column and property is a distinct group dates type
 
 
 
@@ -3963,9 +3979,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 |   |
+| column |  | The filter column |   |
+| property |  | The filter property |   |
 
 
 
@@ -3973,17 +3988,17 @@ Gets a new value structure array by merging two value structures
 ##### Returns
 
 
--  a new value structure array
+-  True if the given property is included from distinct group dates type
 
 
 
 
-### dist/filters/helpers/common/resolveDatasetConditions.js
+### dist/filters/helpers/common/isInValidator.js
 
 
-#### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
+#### isInValidator(validator) 
 
-Resolves the conditions by given params
+Validates if the given validator is a In type
 
 
 
@@ -3992,10 +4007,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 |   |
 
 
 
@@ -4003,17 +4015,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/common/resolveFilterConditions.js
+### dist/filters/helpers/common/isNullValidator.js
 
 
-#### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
+#### isNullValidator(validator) 
 
-Resolves the conditions by given params
+Checks if the given validator is a Null type.
 
 
 
@@ -4022,10 +4034,7 @@ 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. |   |
+| validator |  | The Filter Validator |   |
 
 
 
@@ -4033,17 +4042,17 @@ Resolves the conditions by given params
 ##### Returns
 
 
--  true: the condition is satisfied
+-  True: It is a Null Validator; False: It is not a Null Validator.
 
 
 
 
-### dist/filters/helpers/common/resolveScopeConditions.js
+### dist/filters/helpers/common/isRangeValidator.js
 
 
-#### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
+#### isRangeValidator(validator) 
 
-Resolves the conditions by given params
+Validates if the given validator is a Range type. Range type means the value has min and max values to filter
 
 
 
@@ -4052,10 +4061,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 filter validator |   |
 
 
 
@@ -4063,17 +4069,17 @@ Resolves the conditions by given params
 ##### Returns
 
 
--  true: the condition is satisfied
+-  true: it is a range validator
 
 
 
 
-### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
+### dist/filters/helpers/common/isRegularValidator.js
 
 
-#### excludeUIFiltersByAggregate(uFilters) 
+#### isRegularValidator(validator) 
 
-Excludes Aggregate Filters in the Flattened UI Filters array
+Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
 
 
 
@@ -4082,7 +4088,7 @@ Excludes Aggregate Filters in the Flattened UI Filters array
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilters |  | Collection of Flat UI Filters |   |
+| validator |  | The filter validator |   |
 
 
 
@@ -4090,17 +4096,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 range validator
 
 
 
 
-### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
+### dist/filters/helpers/common/mergeFilters.js
 
 
-#### excludeUIFlatFiltersByScopes(uFilters, scopes) 
+#### mergeFilters(filterData1, filterData2, overwriteValues) 
 
-Excludes and returns a UI Flat Filters without filters by the given scopes
+Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
 
 
 
@@ -4109,8 +4115,9 @@ 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 |   |
+| filterData1 |  | The target filter data |   |
+| filterData2 |  | the filter data to be merged |   |
+| overwriteValues |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -4118,17 +4125,13 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
 ##### Returns
 
 
--  The new array of UI Flattened filters
-
-
-
+-  a new filter data structure
 
-### dist/filters/helpers/ui/getFilterPropertyLabel.js
 
 
-#### getFilterPropertyLabel(filter) 
+#### mergeScopes(scopes1, scopes2, overwriteValues) 
 
-Gets the label of the filter property
+Gets a new scope structure array by merging two scope structures
 
 
 
@@ -4137,7 +4140,9 @@ Gets the label of the filter property
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The UI Filter |   |
+| scopes1 |  | the target scope structure |   |
+| scopes2 |  | the scope to be merged |   |
+| overwriteValues |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -4145,17 +4150,13 @@ Gets the label of the filter property
 ##### Returns
 
 
--  a string of the filter property label
-
-
-
+-  a new scope structure array
 
-### dist/filters/helpers/ui/getOutputFormatByColumn.js
 
 
-#### getOutputFormatByColumn(column, datasets) 
+#### mergeDatasets(datasets1, datasets2, overwriteValues) 
 
-Gets output format object from Datasets by the given column. Item of the datasets array must have outputformat item in order to be returned
+Gets a new dataset structure array by merging two dataset structures
 
 
 
@@ -4164,8 +4165,9 @@ Gets output format object from Datasets by the given column. Item of the dataset
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| column |  | The column |   |
-| datasets |  | array of datasets |   |
+| datasets1 |  | the target dataset structure |   |
+| datasets2 |  | the dataset to be merged |   |
+| overwriteValues |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -4173,27 +4175,24 @@ Gets output format object from Datasets by the given column. Item of the dataset
 ##### Returns
 
 
--  The output format object
+-  a new dataset structure array
 
 
 
+#### mergeFilterss(filters1, filters2, overwriteValues) 
 
-### dist/filters/helpers/ui/getUIFlatFilterByParams.js
+Gets a new filter structure array by merging two filter 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 |  |
+| ---- | ---- | ----------- | -------- |
+| filters1 |  | the target filter structure |   |
+| filters2 |  | the filter to be merged |   |
+| overwriteValues |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -4201,28 +4200,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 filter structure array
 
 
 
+#### mergeValues(filter1, filter2, overwrite) 
 
-### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
+Gets a new value structure array by merging two value 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 |  |
+| ---- | ---- | ----------- | -------- |
+| filter1 |  | the target filter structure |   |
+| filter2 |  | the filter to be used to merge the values |   |
+| overwrite |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -4230,17 +4225,17 @@ The validation to filter the stored filter is depending on:
 ##### Returns
 
 
--  The index of the uFilter array or the Filter object s
+-  a new value structure array
 
 
 
 
-### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
+### dist/filters/helpers/common/resolveDatasetConditions.js
 
 
-#### getUIFlatFiltersByScopes(uFilters, scopes) 
+#### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
 
-Filters and gets a UI Flatten Filters by the given scopes
+Resolves the conditions by given params
 
 
 
@@ -4249,8 +4244,10 @@ Filters and gets a UI Flatten Filters by the given scopes
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilters |  | The Flatten UI Filters |   |
-| scopes |  | collection of scopes types |   |
+| 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. |   |
 
 
 
@@ -4258,17 +4255,17 @@ Filters and gets a UI Flatten Filters by the given scopes
 ##### Returns
 
 
--  The new array of UI Flattened filters
-
+-  true: the condition is satisfied
 
 
 
-### dist/filters/helpers/ui/getUIValues.js
 
+### dist/filters/helpers/common/resolveFilterConditions.js
 
-#### getUIValues(filter, addEnableds, rankingGroupIndex) 
 
+#### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
 
+Resolves the conditions by given params
 
 
 
@@ -4277,9 +4274,10 @@ Filters and gets a UI Flatten Filters by the given scopes
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  |  |   |
-| addEnableds |  |  |   |
-| rankingGroupIndex |  |  |   |
+| 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. |   |
 
 
 
@@ -4287,17 +4285,17 @@ Filters and gets a UI Flatten Filters by the given scopes
 ##### Returns
 
 
--  
+-  true: the condition is satisfied
 
 
 
 
-### dist/filters/helpers/ui/resolveUIFlatFiltersByParams.js
+### dist/filters/helpers/common/resolveScopeConditions.js
 
 
-#### resolveUIFlatFilterByParams(filter, params) 
+#### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
 
-Resolves conditions between UI flattened filter and given parameters
+Resolves the conditions by given params
 
 
 
@@ -4306,8 +4304,10 @@ Resolves conditions between UI flattened filter and given parameters
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | UI Flatten Filter |   |
-| params |  | Parameters to validate |   |
+| 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. |   |
 
 
 
@@ -4315,7 +4315,7 @@ Resolves conditions between UI flattened filter and given parameters
 ##### Returns
 
 
--  true: the conditions are satisfied.
+-  true: the condition is satisfied