@qrvey/utils 1.2.9-22 → 1.2.9-25

package/README.md

@@ -1,4 +1,4 @@
-# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-22*
+# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-25*
 
 > Helper, Utils for all Qrvey Projects
 
@@ -688,12 +688,12 @@ Output:
 
 
 
-### dist/filters/adapters/FDToLogic.js
+### dist/filters/adapters/FDToFlatUI.js
 
 
-#### FDToLogic(filterData) 
+#### FDToFlatUI(filterData, datasetsInfo) 
 
-Generates a Filter Logic structure from Filter Data structure.
+Generates a Flattened UI filter structure from Filter Data structure.
 
 
 
@@ -703,6 +703,7 @@ Generates a Filter Logic structure from Filter Data structure.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
 | filterData |  | The filter data object. |   |
+| datasetsInfo |  | Collection of datasets information |   |
 
 
 
@@ -710,13 +711,13 @@ Generates a Filter Logic structure from Filter Data structure.
 ##### Returns
 
 
--  a filter logic array
+-  a flattened UI filters array
 
 
 
-#### getLogicBodyFromFD21(filterData) 
+#### FD21ToFlatUI(scopes, datasetsInfo) 
 
-Gets the logic body
+Generates a Filter Builder Structure from the Filter Data structure v2.1
 
 
 
@@ -725,7 +726,8 @@ Gets the logic body
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object |   |
+| scopes |  | The filter scope section |   |
+| datasetsInfo |  | Collection of datasets information |   |
 
 
 
@@ -733,17 +735,17 @@ Gets the logic body
 ##### Returns
 
 
--  a filter logic array
+-  a flattened UI filters array
 
 
 
 
-### dist/filters/adapters/FDToFlatUI.js
+### dist/filters/adapters/FDToLogic.js
 
 
-#### FDToFlatUI(filterData, datasetsInfo) 
+#### FDToLogic(filterData) 
 
-Generates a Flattened UI filter structure from Filter Data structure.
+Generates a Filter Logic structure from Filter Data structure.
 
 
 
@@ -753,7 +755,6 @@ Generates a Flattened UI filter structure from Filter Data structure.
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
 | filterData |  | The filter data object. |   |
-| datasetsInfo |  | Collection of datasets information |   |
 
 
 
@@ -761,13 +762,13 @@ Generates a Flattened UI filter structure from Filter Data structure.
 ##### Returns
 
 
--  a flattened UI filters array
+-  a filter logic array
 
 
 
-#### FD21ToFlatUI(scopes, datasetsInfo) 
+#### getLogicBodyFromFD21(filterData) 
 
-Generates a Filter Builder Structure from the Filter Data structure v2.1
+Gets the logic body
 
 
 
@@ -776,8 +777,7 @@ Generates a Filter Builder Structure from the Filter Data structure v2.1
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| scopes |  | The filter scope section |   |
-| datasetsInfo |  | Collection of datasets information |   |
+| filterData |  | The filter data object |   |
 
 
 
@@ -785,7 +785,7 @@ Generates a Filter Builder Structure from the Filter Data structure v2.1
 ##### Returns
 
 
--  a flattened UI filters array
+-  a filter logic array
 
 
 
@@ -2889,12 +2889,12 @@ try to find this string as a variable on Windows object
 
 
 
-### dist/typescript/decorators/Throttled.js
+### dist/typescript/decorators/Debounce.js
 
 
-#### Throttled(time) 
+#### Debounce(time) 
 
-(Method Decorator) Throttled Class Method
+(Method Decorator) Debounce Class Method
 
 
 
@@ -2916,12 +2916,12 @@ try to find this string as a variable on Windows object
 
 
 
-### dist/typescript/decorators/Debounce.js
+### dist/typescript/decorators/Throttled.js
 
 
-#### Debounce(time) 
+#### Throttled(time) 
 
-(Method Decorator) Debounce Class Method
+(Method Decorator) Throttled Class Method
 
 
 
@@ -2943,12 +2943,12 @@ try to find this string as a variable on Windows object
 
 
 
-### dist/dates/relative/helpers/getStatementCase.js
+### dist/dates/relative/helpers/formatStatement.js
 
 
-#### getStatementCase(includeCurrent, isCalendarDate) 
+#### formatStatement(statement) 
 
-Returns a number/constant that identifies a relative date case
+Build a proper relative date statement type
 
 
 
@@ -2957,8 +2957,7 @@ Returns a number/constant that identifies a relative date case
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| includeCurrent | `boolean`  |  |   |
-| isCalendarDate | `boolean`  |  |   |
+| statement | `RelativeStatement`  |  |   |
 
 
 
@@ -2966,17 +2965,17 @@ Returns a number/constant that identifies a relative date case
 ##### Returns
 
 
-- `number`  
+- `RelativeStatement`  
 
 
 
 
-### dist/dates/relative/helpers/formatStatement.js
+### dist/dates/relative/helpers/getStatementCase.js
 
 
-#### formatStatement(statement) 
+#### getStatementCase(includeCurrent, isCalendarDate) 
 
-Build a proper relative date statement type
+Returns a number/constant that identifies a relative date case
 
 
 
@@ -2985,7 +2984,8 @@ Build a proper relative date statement type
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| statement | `RelativeStatement`  |  |   |
+| includeCurrent | `boolean`  |  |   |
+| isCalendarDate | `boolean`  |  |   |
 
 
 
@@ -2993,7 +2993,7 @@ Build a proper relative date statement type
 ##### Returns
 
 
-- `RelativeStatement`  
+- `number`  
 
 
 
@@ -3052,13 +3052,12 @@ Returns a filter builder config object by a any given config
 
 
 
-### dist/filters/helpers/backend/buildExpression.js
+### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
 
 
-#### buildExpression(filter) 
+#### excludeFiltersByAggregateColumn(filterData) 
 
-Builds filter expression by the filter data.
-- If the resulting value array is empty the enabled property will be false.
+Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
 
 
 
@@ -3067,7 +3066,7 @@ Builds filter expression by the filter data.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The filter to transform |   |
+| filterData |  | The filter data object |   |
 
 
 
@@ -3075,17 +3074,17 @@ Builds filter expression by the filter data.
 ##### Returns
 
 
--  a filter expression
+-  The new filter data object that were excluded the aggregate filters
 
 
 
 
-### dist/filters/helpers/backend/buildUserFilters.js
+### dist/filters/helpers/common/areFiltersEquals.js
 
 
-#### buildUserFilters(userFilters) 
+#### areFiltersEquals(filter1, filter2) 
 
-Transform user Filters array into Filter Logic structure
+Validates if both filters are the same
 
 
 
@@ -3094,7 +3093,8 @@ Transform user Filters array into Filter Logic structure
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| userFilters |  | The filters that the user defined. |   |
+| filter1 |  | filter 1 |   |
+| filter2 |  | filter 2 |   |
 
 
 
@@ -3102,17 +3102,26 @@ 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: the filters are equal; false: the filters are NOT equal
 
 
 
-### dist/filters/helpers/backend/getAggFiltersBySummaryIndex.js
 
+### dist/filters/helpers/common/excludeFiltersByParams.js
 
-#### getAggFiltersBySummaryIndex(aggFilters, summaryIndex) 
 
+#### excludeFiltersByParams(filterData, params) 
 
+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
 
 
 
@@ -3121,8 +3130,8 @@ Transform user Filters array into Filter Logic structure
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| aggFilters |  |  |   |
-| summaryIndex |  |  |   |
+| filterData |  | The Filter Data or the UI Filter Data |   |
+| params |  | given parameters to validate the filter data |   |
 
 
 
@@ -3130,17 +3139,17 @@ Transform user Filters array into Filter Logic structure
 ##### Returns
 
 
--  
+-  a new Filter object structure
 
 
 
 
-### dist/filters/helpers/backend/getBackendGroupValue.js
+### dist/filters/helpers/common/excludeFiltersByScopes.js
 
 
-#### getBackendGroupValue(filter) 
+#### excludeFiltersByScopes(filterData, scopes) 
 
-Gets a group value for the backend logic structure
+Excludes and returns a filter data without filters by the given scopes
 
 
 
@@ -3149,7 +3158,8 @@ Gets a group value for the backend logic structure
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The filter |   |
+| filterData |  | The Filter Data |   |
+| scopes |  | collection of scopes to be as filtering parameters |   |
 
 
 
@@ -3157,17 +3167,17 @@ Gets a group value for the backend logic structure
 ##### Returns
 
 
--  a property
+-  The new Filter Data without filters by the given scopes.
 
 
 
 
-### dist/filters/helpers/backend/getBackendProperty.js
+### dist/filters/helpers/common/getFilterColumnLabel.js
 
 
-#### getBackendProperty(filter) 
+#### getFilterColumnLabel(column) 
 
-Gets a property for the logic structure
+Get an string of the properties of the given filter column.
 
 
 
@@ -3176,7 +3186,7 @@ Gets a property for the logic structure
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The filter |   |
+| column |  | The filter column |   |
 
 
 
@@ -3184,17 +3194,17 @@ Gets a property for the logic structure
 ##### Returns
 
 
--  a property
+-  an string with the property, aggregate or calculation label.
 
 
 
 
-### dist/filters/helpers/backend/getBackendValidator.js
+### dist/filters/helpers/common/getFilterLabel.js
 
 
-#### getBackendValidator(validator) 
+#### getFilterLabel(filter) 
 
-Gets the Validator that is used in requests
+Gets the Filter Label + Column label
 
 
 
@@ -3203,7 +3213,7 @@ Gets the Validator that is used in requests
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | Filter Validator used in UI |   |
+| filter |  | the UI filter |   |
 
 
 
@@ -3211,17 +3221,28 @@ Gets the Validator that is used in requests
 ##### Returns
 
 
--  Filter Validator used in Backend
+-  a sring label
 
 
 
 
-### dist/filters/helpers/backend/getBackendValues.js
+### dist/filters/helpers/common/getFilterid.js
 
 
-#### getBackendValues(filter) 
+#### getFilterid(filter) 
 
-Gets the expresion values in the logic format
+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
 
 
 
@@ -3230,7 +3251,7 @@ Gets the expresion values in the logic format
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | The filter structure |   |
+| filter |  | the filter structure |   |
 
 
 
@@ -3238,13 +3259,17 @@ Gets the expresion values in the logic format
 ##### Returns
 
 
--  A collection of backend expression value
+-  a text to identify the filter
 
 
 
-#### getResultValues(values, filter) 
 
-Gets the expression values. Depending on the column type
+### dist/filters/helpers/common/getFiltersByAggregateColumn.js
+
+
+#### getFiltersByAggregateColumn(filterData) 
+
+Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
 
 
 
@@ -3253,8 +3278,7 @@ Gets the expression values. Depending on the column type
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| values |  | a collection of filter values |   |
-| filter |  | The filter structure |   |
+| filterData |  | The filter data object |   |
 
 
 
@@ -3262,13 +3286,26 @@ Gets the expression values. Depending on the column type
 ##### Returns
 
 
--  
+-  The new filter data object that were get the aggregate filters
 
 
 
-#### getRankingValues(values, rankingGroupIndex) 
 
-Gets the Ranking values.
+### dist/filters/helpers/common/getFiltersByParams.js
+
+
+#### 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
 
 
 
@@ -3277,8 +3314,8 @@ 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 |   |
+| filterData |  | The Filter Data or the UI Filter Data |   |
+| params |  | given parameters to validate the dataset |   |
 
 
 
@@ -3286,17 +3323,17 @@ Gets the Ranking values.
 ##### Returns
 
 
--  Expression values for ranking
+-  a new Filter object structure
 
 
 
 
-### dist/filters/helpers/backend/getLogicByScopes.js
+### dist/filters/helpers/common/getFiltersByScopes.js
 
 
-#### getLogicByScopes(logics, scopes) 
+#### getFiltersByScopes(filterData, scopes) 
 
-Gets the filters from logic data by Scopes/Scope IDs.
+Filters and gets a Filter Data by the given scopes
 
 
 
@@ -3305,8 +3342,8 @@ Gets the filters from logic data by Scopes/Scope IDs.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| logics |  | The logic array |   |
-| scopes |  | The collection of Scopes/Scope IDs |   |
+| filterData |  | The Filter Data |   |
+| scopes |  | collection of scopes types |   |
 
 
 
@@ -3314,17 +3351,17 @@ Gets the filters from logic data by Scopes/Scope IDs.
 ##### Returns
 
 
--  a new Logic array
+-  The new Filter Data
 
 
 
 
-### dist/filters/helpers/backend/getLogicByScopesHierarchy.js
+### dist/filters/helpers/common/getFiltersByScopesIds.js
 
 
-#### getLogicByScopesHierarchy(filterData, scopes, currentScope) 
+#### getFiltersByScopesIds(filterData, scopes) 
 
-Gets filters from the logic by the scopes hierarchy.
+Gets filters from Filter Data by Scopes/Scope IDs.
 
 
 
@@ -3333,9 +3370,8 @@ Gets filters from the logic by the scopes hierarchy.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  |  |   |
-| scopes |  |  |   |
-| currentScope |  |  |   |
+| filterData |  | The filter data |   |
+| scopes |  | The collection of Scopes/Scope IDs |   |
 
 
 
@@ -3343,17 +3379,17 @@ Gets filters from the logic by the scopes hierarchy.
 ##### Returns
 
 
--  a new array of Logic
+-  a new Filter Data
 
 
 
 
-### dist/filters/helpers/common/areFiltersEquals.js
+### dist/filters/helpers/common/getFiltersByVisibility.js
 
 
-#### areFiltersEquals(filter1, filter2) 
+#### getFiltersByVisibility(filterData, scopes) 
 
-Validates if both filters are the same
+Get a new Filter Data by filtering scopes/scope IDs and enabled flags
 
 
 
@@ -3362,8 +3398,8 @@ Validates if both filters are the same
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter1 |  | filter 1 |   |
-| filter2 |  | filter 2 |   |
+| filterData |  | a Filter Data or UI Filter Data |   |
+| scopes |  | a Scopes/Scope IDs array |   |
 
 
 
@@ -3371,17 +3407,17 @@ Validates if both filters are the same
 ##### Returns
 
 
--  true: the filters are equal; false: the filters are NOT equal
+-  a new Filter Data
 
 
 
 
-### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
+### dist/filters/helpers/common/getMergeFiltersSettings.js
 
 
-#### excludeFiltersByAggregateColumn(filterData) 
+#### getMergeFiltersSettings(settings) 
 
-Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
+Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
 
 
 
@@ -3390,7 +3426,7 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object |   |
+| settings |  | an object to the MergeFilters settings |   |
 
 
 
@@ -3398,17 +3434,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
+-  a new MergeFilters settings object.
 
 
 
 
-### dist/filters/helpers/common/excludeFiltersByScopes.js
+### dist/filters/helpers/common/getParamsToGetFilterSettings.js
 
 
-#### excludeFiltersByScopes(filterData, scopes) 
+#### getParamsToGetFilterSettings(settings) 
 
-Excludes and returns a filter data without filters by the given scopes
+Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
 
 
 
@@ -3417,8 +3453,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 |   |
+| settings |  | an object to the ParamsToGetFilter settings |   |
 
 
 
@@ -3426,26 +3461,17 @@ Excludes and returns a filter data without filters by the given scopes
 ##### Returns
 
 
--  The new Filter Data without filters by the given scopes.
+-  a new ParamsToGetFilter settings object.
 
 
 
 
-### dist/filters/helpers/common/excludeFiltersByParams.js
+### dist/filters/helpers/common/haveFiltersByDataset.js
 
 
-#### excludeFiltersByParams(filterData, params) 
+#### haveFiltersByDataset(filterData, qrveyid) 
 
-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
+Validates if the filter data has filters by a dataset ID (Qrvey ID).
 
 
 
@@ -3454,8 +3480,8 @@ The validation to filter the stored filter is depending on:
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The Filter Data or the UI Filter Data |   |
-| params |  | given parameters to validate the filter data |   |
+| filterData |  | the filter data or the UI filter data. |   |
+| qrveyid |  | The Qrvey ID |   |
 
 
 
@@ -3463,17 +3489,17 @@ The validation to filter the stored filter is depending on:
 ##### Returns
 
 
--  a new Filter object structure
+-  true: the filter data has filters by the Qrvey ID
 
 
 
 
-### dist/filters/helpers/common/getFilterColumnLabel.js
+### dist/filters/helpers/common/isBetweenValidator.js
 
 
-#### getFilterColumnLabel(column) 
+#### isBetweenValidator(validator) 
 
-Get an string of the properties of the given filter column.
+Validates if the given validator is a Between type
 
 
 
@@ -3482,7 +3508,7 @@ Get an string of the properties of the given filter column.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| column |  | The filter column |   |
+| validator |  | The validator |   |
 
 
 
@@ -3490,17 +3516,17 @@ Get an string of the properties of the given filter column.
 ##### Returns
 
 
--  an string with the property, aggregate or calculation label.
+-  true: it is a between validator; false: it is not a between validator
 
 
 
 
-### dist/filters/helpers/common/getFilterLabel.js
+### dist/filters/helpers/common/isDateDistinctProperty.js
 
 
-#### getFilterLabel(filter) 
+#### isDateDistinctProperty(column, property) 
 
-Gets the Filter Label + Column label
+Determines if the filter column and property is a distinct group dates type
 
 
 
@@ -3509,7 +3535,8 @@ Gets the Filter Label + Column label
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | the UI filter |   |
+| column |  | The filter column |   |
+| property |  | The filter property |   |
 
 
 
@@ -3517,28 +3544,17 @@ Gets the Filter Label + Column label
 ##### Returns
 
 
--  a sring label
+-  True if the given property is included from distinct group dates type
 
 
 
 
-### dist/filters/helpers/common/getFilterid.js
+### dist/filters/helpers/common/isInValidator.js
 
 
-#### getFilterid(filter) 
+#### isInValidator(validator) 
 
-Get the Filter ID by the filter structure
-The order of the epression ID is:
-- Scope Type
-- scopeid
-- qrveyid
-- panelid
-- columnid
-- validator
-- property
-- Column Aggregate
-- Column Calculation
-- Optional Index
+Validates if the given validator is a In type
 
 
 
@@ -3547,7 +3563,7 @@ The order of the epression ID is:
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filter |  | the filter structure |   |
+| validator |  | The validator |   |
 
 
 
@@ -3555,17 +3571,17 @@ The order of the epression ID is:
 ##### Returns
 
 
--  a text to identify the filter
+-  true: it is a In validator; false: it is not a In validator
 
 
 
 
-### dist/filters/helpers/common/getFiltersByAggregateColumn.js
+### dist/filters/helpers/common/isNullValidator.js
 
 
-#### getFiltersByAggregateColumn(filterData) 
+#### isNullValidator(validator) 
 
-Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
+Checks if the given validator is a Null type.
 
 
 
@@ -3574,7 +3590,7 @@ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggr
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object |   |
+| validator |  | The Filter Validator |   |
 
 
 
@@ -3582,26 +3598,17 @@ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggr
 ##### Returns
 
 
--  The new filter data object that were get the aggregate filters
+-  True: It is a Null Validator; False: It is not a Null Validator.
 
 
 
 
-### dist/filters/helpers/common/getFiltersByParams.js
+### dist/filters/helpers/common/isRangeValidator.js
 
 
-#### getFiltersByParams(filterData, params) 
+#### isRangeValidator(validator) 
 
-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
+Validates if the given validator is a Range type. Range type means the value has min and max values to filter
 
 
 
@@ -3610,8 +3617,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 dataset |   |
+| validator |  | The filter validator |   |
 
 
 
@@ -3619,17 +3625,17 @@ The validation to filter the stored filter is depending on:
 ##### Returns
 
 
--  a new Filter object structure
+-  true: it is a range validator
 
 
 
 
-### dist/filters/helpers/common/getFiltersByScopes.js
+### dist/filters/helpers/common/isRegularValidator.js
 
 
-#### getFiltersByScopes(filterData, scopes) 
+#### isRegularValidator(validator) 
 
-Filters and gets a Filter Data by the given scopes
+Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
 
 
 
@@ -3638,8 +3644,7 @@ Filters and gets a Filter Data by the given scopes
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The Filter Data |   |
-| scopes |  | collection of scopes types |   |
+| validator |  | The filter validator |   |
 
 
 
@@ -3647,17 +3652,17 @@ Filters and gets a Filter Data by the given scopes
 ##### Returns
 
 
--  The new Filter Data
+-  true: it is a range validator
 
 
 
 
-### dist/filters/helpers/common/getFiltersByScopesIds.js
+### dist/filters/helpers/common/mergeFilters.js
 
 
-#### getFiltersByScopesIds(filterData, scopes) 
+#### mergeFilters(filterData1, filterData2, overwriteValues) 
 
-Gets filters from Filter Data by Scopes/Scope IDs.
+Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
 
 
 
@@ -3666,8 +3671,9 @@ Gets filters from Filter Data by Scopes/Scope IDs.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data |   |
-| scopes |  | The collection of Scopes/Scope IDs |   |
+| filterData1 |  | The target filter data |   |
+| filterData2 |  | the filter data to be merged |   |
+| overwriteValues |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -3675,17 +3681,13 @@ Gets filters from Filter Data by Scopes/Scope IDs.
 ##### Returns
 
 
--  a new Filter Data
-
-
-
+-  a new filter data structure
 
-### dist/filters/helpers/common/getFiltersByVisibility.js
 
 
-#### getFiltersByVisibility(filterData, scopes) 
+#### mergeScopes(scopes1, scopes2, overwriteValues) 
 
-Get a new Filter Data by filtering scopes/scope IDs and enabled flags
+Gets a new scope structure array by merging two scope structures
 
 
 
@@ -3694,8 +3696,9 @@ 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 |   |
+| scopes1 |  | the target scope structure |   |
+| scopes2 |  | the scope to be merged |   |
+| overwriteValues |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -3703,17 +3706,13 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
 ##### Returns
 
 
--  a new Filter Data
-
-
-
+-  a new scope structure array
 
-### dist/filters/helpers/common/getMergeFiltersSettings.js
 
 
-#### getMergeFiltersSettings(settings) 
+#### mergeDatasets(datasets1, datasets2, overwriteValues) 
 
-Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
+Gets a new dataset structure array by merging two dataset structures
 
 
 
@@ -3722,7 +3721,9 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| settings |  | an object to the MergeFilters settings |   |
+| datasets1 |  | the target dataset structure |   |
+| datasets2 |  | the dataset to be merged |   |
+| overwriteValues |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -3730,17 +3731,13 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
 ##### Returns
 
 
--  a new MergeFilters settings object.
-
-
-
+-  a new dataset structure array
 
-### dist/filters/helpers/common/getParamsToGetFilterSettings.js
 
 
-#### getParamsToGetFilterSettings(settings) 
+#### mergeFilterss(filters1, filters2, overwriteValues) 
 
-Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
+Gets a new filter structure array by merging two filter structures
 
 
 
@@ -3749,7 +3746,9 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| settings |  | an object to the ParamsToGetFilter settings |   |
+| filters1 |  | the target filter structure |   |
+| filters2 |  | the filter to be merged |   |
+| overwriteValues |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -3757,17 +3756,13 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
 ##### Returns
 
 
--  a new ParamsToGetFilter settings object.
-
-
-
+-  a new filter structure array
 
-### dist/filters/helpers/common/haveFiltersByDataset.js
 
 
-#### haveFiltersByDataset(filterData, qrveyid) 
+#### mergeValues(filter1, filter2, overwrite) 
 
-Validates if the filter data has filters by a dataset ID (Qrvey ID).
+Gets a new value structure array by merging two value structures
 
 
 
@@ -3776,8 +3771,9 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| filterData |  | the filter data or the UI filter data. |   |
-| qrveyid |  | The Qrvey ID |   |
+| filter1 |  | the target filter structure |   |
+| filter2 |  | the filter to be used to merge the values |   |
+| overwrite |  | Flag to overwrite or not the filter values |   |
 
 
 
@@ -3785,17 +3781,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 value structure array
 
 
 
 
-### dist/filters/helpers/common/isBetweenValidator.js
+### dist/filters/helpers/common/resolveDatasetConditions.js
 
 
-#### isBetweenValidator(validator) 
+#### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
 
-Validates if the given validator is a Between type
+Resolves the conditions by given params
 
 
 
@@ -3804,7 +3800,10 @@ Validates if the given validator is a Between type
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The validator |   |
+| 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. |   |
 
 
 
@@ -3812,17 +3811,17 @@ Validates if the given validator is a Between type
 ##### Returns
 
 
--  true: it is a between validator; false: it is not a between validator
+-  true: the condition is satisfied
 
 
 
 
-### dist/filters/helpers/common/isDateDistinctProperty.js
+### dist/filters/helpers/common/resolveFilterConditions.js
 
 
-#### isDateDistinctProperty(column, property) 
+#### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
 
-Determines if the filter column and property is a distinct group dates type
+Resolves the conditions by given params
 
 
 
@@ -3831,8 +3830,10 @@ Determines if the filter column and property is a distinct group dates type
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| column |  | The filter column |   |
-| property |  | The filter property |   |
+| filter |  | The 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. |   |
 
 
 
@@ -3840,17 +3841,17 @@ Determines if the filter column and property is a distinct group dates type
 ##### Returns
 
 
--  True if the given property is included from distinct group dates type
+-  true: the condition is satisfied
 
 
 
 
-### dist/filters/helpers/common/isInValidator.js
+### dist/filters/helpers/common/resolveScopeConditions.js
 
 
-#### isInValidator(validator) 
+#### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
 
-Validates if the given validator is a In type
+Resolves the conditions by given params
 
 
 
@@ -3859,7 +3860,10 @@ Validates if the given validator is a In type
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The validator |   |
+| filter |  | The filter scope structure |   |
+| params |  | given parameters to validate the filter |   |
+| letPassUndefinedProperties |  | Flag to avoid applying the condition when the filter properties are undefined |   |
+| letPassUndefinedParams |  | Flag to avoid applying the condition when the param properties are explicit undefined. |   |
 
 
 
@@ -3867,17 +3871,18 @@ Validates if the given validator is a In type
 ##### Returns
 
 
--  true: it is a In validator; false: it is not a In validator
+-  true: the condition is satisfied
 
 
 
 
-### dist/filters/helpers/common/isNullValidator.js
+### dist/filters/helpers/backend/buildExpression.js
 
 
-#### isNullValidator(validator) 
+#### buildExpression(filter) 
 
-Checks if the given validator is a Null type.
+Builds filter expression by the filter data.
+- If the resulting value array is empty the enabled property will be false.
 
 
 
@@ -3886,7 +3891,7 @@ Checks if the given validator is a Null type.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The Filter Validator |   |
+| filter |  | The filter to transform |   |
 
 
 
@@ -3894,17 +3899,17 @@ Checks if the given validator is a Null type.
 ##### Returns
 
 
--  True: It is a Null Validator; False: It is not a Null Validator.
+-  a filter expression
 
 
 
 
-### dist/filters/helpers/common/isRangeValidator.js
+### dist/filters/helpers/backend/buildUserFilters.js
 
 
-#### isRangeValidator(validator) 
+#### buildUserFilters(userFilters) 
 
-Validates if the given validator is a Range type. Range type means the value has min and max values to filter
+Transform user Filters array into Filter Logic structure
 
 
 
@@ -3913,7 +3918,7 @@ Validates if the given validator is a Range type. Range type means the value has
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The filter validator |   |
+| userFilters |  | The filters that the user defined. |   |
 
 
 
@@ -3921,17 +3926,17 @@ Validates if the given validator is a Range type. Range type means the value has
 ##### Returns
 
 
--  true: it is a range validator
+-  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/isRegularValidator.js
+### dist/filters/helpers/backend/getAggFiltersBySummaryIndex.js
 
 
-#### isRegularValidator(validator) 
+#### getAggFiltersBySummaryIndex(aggFilters, summaryIndex) 
+
 
-Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
 
 
 
@@ -3940,7 +3945,8 @@ Validates if the given validator is a regular type. Regular type means the filte
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| validator |  | The filter validator |   |
+| aggFilters |  |  |   |
+| summaryIndex |  |  |   |
 
 
 
@@ -3948,17 +3954,17 @@ Validates if the given validator is a regular type. Regular type means the filte
 ##### Returns
 
 
--  true: it is a range validator
+-  
 
 
 
 
-### dist/filters/helpers/common/mergeFilters.js
+### dist/filters/helpers/backend/getBackendGroupValue.js
 
 
-#### mergeFilters(filterData1, filterData2, overwriteValues) 
+#### getBackendGroupValue(filter) 
 
-Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
+Gets a group value for the backend logic structure
 
 
 
@@ -3967,9 +3973,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 |   |
+| filter |  | The filter |   |
 
 
 
@@ -3977,13 +3981,17 @@ Merge filter data structures in a new one. The first Filter Data passed in the a
 ##### Returns
 
 
--  a new filter data structure
+-  a property
 
 
 
-#### mergeScopes(scopes1, scopes2, overwriteValues) 
 
-Gets a new scope structure array by merging two scope structures
+### dist/filters/helpers/backend/getBackendProperty.js
+
+
+#### getBackendProperty(filter) 
+
+Gets a property for the logic structure
 
 
 
@@ -3992,9 +4000,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 |   |
+| filter |  | The filter |   |
 
 
 
@@ -4002,13 +4008,17 @@ Gets a new scope structure array by merging two scope structures
 ##### Returns
 
 
--  a new scope structure array
+-  a property
 
 
 
-#### mergeDatasets(datasets1, datasets2, overwriteValues) 
 
-Gets a new dataset structure array by merging two dataset structures
+### dist/filters/helpers/backend/getBackendValidator.js
+
+
+#### getBackendValidator(validator) 
+
+Gets the Validator that is used in requests
 
 
 
@@ -4017,9 +4027,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 |   |
+| validator |  | Filter Validator used in UI |   |
 
 
 
@@ -4027,13 +4035,17 @@ Gets a new dataset structure array by merging two dataset structures
 ##### Returns
 
 
--  a new dataset structure array
+-  Filter Validator used in Backend
 
 
 
-#### mergeFilterss(filters1, filters2, overwriteValues) 
 
-Gets a new filter structure array by merging two filter structures
+### dist/filters/helpers/backend/getBackendValues.js
+
+
+#### getBackendValues(filter) 
+
+Gets the expresion values in the logic format
 
 
 
@@ -4042,9 +4054,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 |   |
+| filter |  | The filter structure |   |
 
 
 
@@ -4052,13 +4062,13 @@ Gets a new filter structure array by merging two filter structures
 ##### Returns
 
 
--  a new filter structure array
+-  A collection of backend expression value
 
 
 
-#### mergeValues(filter1, filter2, overwrite) 
+#### getResultValues(values, filter) 
 
-Gets a new value structure array by merging two value structures
+Gets the expression values. Depending on the column type
 
 
 
@@ -4067,9 +4077,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 |   |
+| values |  | a collection of filter values |   |
+| filter |  | The filter structure |   |
 
 
 
@@ -4077,17 +4086,13 @@ Gets a new value structure array by merging two value structures
 ##### Returns
 
 
--  a new value structure array
-
-
-
+-  
 
-### dist/filters/helpers/common/resolveDatasetConditions.js
 
 
-#### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
+#### getRankingValues(values, rankingGroupIndex) 
 
-Resolves the conditions by given params
+Gets the Ranking values.
 
 
 
@@ -4096,10 +4101,8 @@ 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. |   |
+| values |  | a collection of filter values in the ranking structure |   |
+| rankingGroupIndex |  | determine the value by this index to build and return it |   |
 
 
 
@@ -4107,17 +4110,17 @@ Resolves the conditions by given params
 ##### Returns
 
 
--  true: the condition is satisfied
+-  Expression values for ranking
 
 
 
 
-### dist/filters/helpers/common/resolveFilterConditions.js
+### dist/filters/helpers/backend/getLogicByScopes.js
 
 
-#### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
+#### getLogicByScopes(logics, scopes) 
 
-Resolves the conditions by given params
+Gets the filters from logic data by Scopes/Scope IDs.
 
 
 
@@ -4126,10 +4129,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. |   |
+| logics |  | The logic array |   |
+| scopes |  | The collection of Scopes/Scope IDs |   |
 
 
 
@@ -4137,17 +4138,17 @@ Resolves the conditions by given params
 ##### Returns
 
 
--  true: the condition is satisfied
+-  a new Logic array
 
 
 
 
-### dist/filters/helpers/common/resolveScopeConditions.js
+### dist/filters/helpers/backend/getLogicByScopesHierarchy.js
 
 
-#### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams) 
+#### getLogicByScopesHierarchy(filterData, scopes, currentScope) 
 
-Resolves the conditions by given params
+Gets filters from the logic by the scopes hierarchy.
 
 
 
@@ -4156,10 +4157,9 @@ 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. |   |
+| filterData |  |  |   |
+| scopes |  |  |   |
+| currentScope |  |  |   |
 
 
 
@@ -4167,17 +4167,17 @@ Resolves the conditions by given params
 ##### Returns
 
 
--  true: the condition is satisfied
+-  a new array of Logic
 
 
 
 
-### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
+### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
 
 
-#### excludeUIFiltersByAggregate(uFilters) 
+#### excludeUIFlatFiltersByScopes(uFilters, scopes) 
 
-Excludes Aggregate Filters in the Flattened UI Filters array
+Excludes and returns a UI Flat Filters without filters by the given scopes
 
 
 
@@ -4186,7 +4186,8 @@ Excludes Aggregate Filters in the Flattened UI Filters array
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| uFilters |  | Collection of Flat UI Filters |   |
+| uFilters |  | The Flatten UI Filters |   |
+| scopes |  | collection of scopes types |   |
 
 
 
@@ -4194,17 +4195,17 @@ Excludes Aggregate Filters in the Flattened UI Filters array
 ##### Returns
 
 
--  a new Flat UI Filters that were excluded the aggregate filters
+-  The new array of UI Flattened filters
 
 
 
 
-### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
+### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
 
 
-#### excludeUIFlatFiltersByScopes(uFilters, scopes) 
+#### excludeUIFiltersByAggregate(uFilters) 
 
-Excludes and returns a UI Flat Filters without filters by the given scopes
+Excludes Aggregate Filters in the Flattened UI Filters array
 
 
 
@@ -4213,8 +4214,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 |   |
+| uFilters |  | Collection of Flat UI Filters |   |
 
 
 
@@ -4222,7 +4222,7 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
 ##### Returns
 
 
--  The new array of UI Flattened filters
+-  a new Flat UI Filters that were excluded the aggregate filters