npm - @qrvey/utils - Versions diffs - 1.2.9-31 → 1.2.9-32 - Mend

@qrvey/utils 1.2.9-31 → 1.2.9-32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

package/README.md CHANGED Viewed

@@ -1,4483 +0,0 @@
-# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-31*
-> Helper, Utils for all Qrvey Projects
-### dist/format/format.js
-#### isValidDateString(bytes)
-Apply to the given date format to a date value
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| bytes |  | type number | &nbsp; |
-##### Returns
-- `Void`
-#### formatFileSize(bytes)
-Set convert Bytes into MB
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| bytes |  | type number | &nbsp; |
-##### Returns
-- `Void`
-### dist/tokens/isTokenLabel.js
-#### isTokenLabel(label)
-Get a text and evaluate if it matchs with a token box label.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| label |  | string to evaluate | &nbsp; |
-##### Returns
--  True is label matchs; otherwise false
-### dist/dates/adapters/mdyDateToDate.js
-#### mdyDateToDate(monthYearDate, time)
-Transforms String Date from a [mm/dd/yyyy] format to Date object.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| monthYearDate |  | String of [mm/dd/yyyy] date | &nbsp; |
-| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
-##### Returns
--  The date object or the date in milliseconds
-### dist/dates/adapters/monthYearToDate.js
-#### monthYearToDate(monthYearDate, time)
-Transforms String Date from a [Month Year] format to Date object.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| monthYearDate |  | String of [Month Year] date | &nbsp; |
-| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
-##### Returns
--  The date object or the date in milliseconds
-### dist/dates/adapters/quarterYearToDate.js
-#### quarterYearToDate(quarterYearDate, time)
-Transforms String Date from a [Quarter Year] format to Date object.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| quarterYearDate |  | String of [Quarter Year] date | &nbsp; |
-| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
-##### Returns
--  The date object or the date in milliseconds
-### dist/dates/adapters/weekYearToDate.js
-#### weekYearToDate(date, time)
-Transforms String Date from a [Week Year] format to Date object.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| date |  | String of [Week Year] date | &nbsp; |
-| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
-##### Returns
--  The date object or the date in milliseconds
-### dist/dates/adapters/yearToDate.js
-#### yearToDate(yearDate, time)
-Transforms String Date from a [Year] format to Date object.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| yearDate |  | String of [Year] date | &nbsp; |
-| time |  | Flag to parse the object date to milliseconds. | &nbsp; |
-##### Returns
--  The date object or the date in milliseconds
-### dist/dates/helpers/getDateByDateFormat.js
-#### getDateByDateFormat(date, format, time)
-Gets a Date Object instance by a Date format
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| date |  | String with a formatted date | &nbsp; |
-| format |  | The date format | &nbsp; |
-| time |  | flag to convert the formatted date to miliseconds | &nbsp; |
-##### Returns
--  a Date object, milisecond time or the same value if date format does not match.
-### dist/dates/helpers/getDateFormatByProperty.js
-#### getDateFormatByProperty(property)
-Gets the date format by the given property
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| property |  | The Column Property | &nbsp; |
-##### Returns
--  The date format
-### dist/dates/helpers/getDateFormatRegularExpressionInArray.js
-#### getDateFormatRegularExpressionInArray(dateFormat)
-Gets an array of regular expressions by the given date format
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| dateFormat |  | the date format | &nbsp; |
-##### Returns
--  an array of regular expressions
-### dist/dates/helpers/getSeparatorByDateFormat.js
-#### getSeparatorByDateFormat(format)
-Gets the separator of the date format
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| format |  | the date format | &nbsp; |
-##### Returns
--  a separator string
-### dist/dates/helpers/getWeek.js
-#### getWeek(date)
-Gets the week number of the year
-Additionally, the month and the year
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| date |  | the date object | &nbsp; |
-##### Returns
--  an object with the week, month and year.
-### dist/dates/helpers/validateDate.js
-#### validateDate(date, format)
-Validate a string date depending on giving format
-- If the string is a token label, the function lets it pass.
-- Otherwise depends of the format
-- Some escenarios the string is a mix of token labels and dates
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| date |  | String of date | &nbsp; |
-| format |  | String of the format to validate | &nbsp; |
-##### Returns
--  True if it is valid or not. Undefined if date is undefined
-### dist/dates/helpers/validateDateByDateFormat.js
-#### validateDateByDateFormat(date, dateForma)
-Validates the given string as Date by its date format.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| date |  | a string to validate as date form | &nbsp; |
-| dateForma |  | the format of the date to validate the string | &nbsp; |
-##### Returns
--  true: the string is a valida date
-### dist/dates/relative/Adapter.js
-#### value()
-Resolves statement and returns statement value
-##### Returns
-- `AbsoluteRange` `string`
-#### valueAsAnchor()
-Resolves statement as an anchor
-##### Returns
-- `string`
-#### _statementToRange()  *private method*
-Convert verbal statement to range value
-##### Returns
-- `AbsoluteRange`
-#### _resolveAsThis()  *private method*
-Apply 'this' cursor logic to statement
-##### Returns
-- `AbsoluteStatement`
-#### _resolveAsTheLast()  *private method*
-Apply 'the last' cursor logic to statement
-##### Returns
-- `AbsoluteStatement`
-#### _resolveAsTheNext()  *private method*
-Apply 'the next' cursor logic to statement
-##### Returns
-- `AbsoluteStatement`
-#### replaceNowToken(value, now)
-Replace '@now' token inside a string
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| value | `string`  |  | &nbsp; |
-| now | `Date`  |  | &nbsp; |
-##### Returns
-- `string`
-#### convertRelativeToAbsolute(args)
-Returns a range object (date) from a group of statement params
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| args | `RelativeToAbsoluteStruct`  |  | &nbsp; |
-##### Examples
-```javascript
-pivot = '2021-03-03T12:30:40'
-unit = month
-steps = 2
-setTo = END
-resolverAsCalendar: true
-=> Returns  '2021-05-31T23:59:59'
-```
-```javascript
-pivot = '2021-03-03T12:30:40'
-unit = month
-steps = -2
-setTo = START
-resolverAsCalendar: false
-=> Returns '2021-01-03T00:00:00'
-```
-##### Returns
-- `string`
-### dist/dates/relative/relative.js
-#### resolveRelative(statements, clock)
-Resolve a list of relative statements according to operator
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| statements | `Array.<RelativeStatement>` `Array.<string>`  | - Raw statements/values | &nbsp; |
-| clock | `Date`  | - Clock/time reference for relative date resolution | &nbsp; |
-##### Examples
-```javascript
-Input:
-{
- "cursor": "the_next",
- "unit": "year",
- "number": 1,
- "includeCurrent": false,
- "isCalendarDate": false,
- "anchor": "03/05/2021"
-}
-Output:
-{ gte: "03/06/2021 00:00:00", lte: "03/05/2022 23:59:59" }
-```
-##### Returns
-- `Array.&lt;AbsoluteRange&gt;` `Array.&lt;string&gt;`
-### dist/dates/range/getDateRange.js
-#### getDateRange(value, dateGroupLabel, withTime)
-Get date range object from a string date value
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| value | `String`  | string date value | &nbsp; |
-| dateGroupLabel | `String`  | could be 'YEAR', 'QUARTER', 'MONTH' or 'DAY'. Deafult is 'DAY' | &nbsp; |
-| withTime | `Boolean`  | determines if the date range will include time. Default is true | &nbsp; |
-##### Examples
-```javascript
-// 1) Year:
-getDateRange('2020', 'YEAR');
-// Will return:
-{
-   from: '01/01/2020 00:00:00',
-   to: '12/31/2020 23:59:59'
-}
-// 2) Quarter:
-getDateRange('Q3 2020', 'QUARTER');
-// Will return:
-{
-   from: '07/01/2020 00:00:00',
-   to: '09/30/2020 23:59:59'
-}
-// 3) Month:
-getDateRange('Oct 2020', 'MONTH');
-// Will return:
-{
-   from: '10/01/2020 00:00:00',
-   to: '10/31/2020 23:59:59'
-}
-```
-##### Returns
-- `Object`  an object with the date range with two string date properties: from and to
-### dist/filters/adapters/FDToFlatUI.js
-#### FDToFlatUI(filterData, datasetsInfo)
-Generates a Flattened UI filter structure from Filter Data structure.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object. | &nbsp; |
-| datasetsInfo |  | Collection of datasets information | &nbsp; |
-##### Returns
--  a flattened UI filters array
-#### FD21ToFlatUI(scopes, datasetsInfo)
-Generates a Filter Builder Structure from the Filter Data structure v2.1
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| scopes |  | The filter scope section | &nbsp; |
-| datasetsInfo |  | Collection of datasets information | &nbsp; |
-##### Returns
--  a flattened UI filters array
-### dist/filters/adapters/FDToLogic.js
-#### FDToLogic(filterData)
-Generates a Filter Logic structure from Filter Data structure.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object. | &nbsp; |
-##### Returns
--  a filter logic array
-#### getLogicBodyFromFD21(filterData)
-Gets the logic body
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object | &nbsp; |
-##### Returns
--  a filter logic array
-### dist/filters/adapters/FDToUI.js
-#### FDToUI(filterData, datasetsInfo)
-Generates a UI filter structure from Filter Data structure.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object. | &nbsp; |
-| datasetsInfo |  | Collection of datasets information | &nbsp; |
-##### Returns
--  a UI Filters structure
-#### FD21ToUI(scopes, section, version, datasetsInfo)
-Generates a UI filter Structure from the Filter Data structure v2.1
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| scopes |  | The filter scope section | &nbsp; |
-| section |  | The filter section. | &nbsp; |
-| version |  | The version of the filter structure | &nbsp; |
-| datasetsInfo |  | Collection of datasets information | &nbsp; |
-##### Returns
--  a UI filter Structure
-### dist/filters/adapters/UIToFD.js
-#### UIToFD(filterData)
-Generates a Filter Data Structure structure from UI Filter Data structure.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  | The UI filter data object. | &nbsp; |
-##### Returns
--  a Filter Data structure
-#### UI21ToFD(uFilterData, version)
-Builds the Fitler Data structure from UI filter data
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| uFilterData |  | The UI filter Data object | &nbsp; |
-| version |  | the version of the structure | &nbsp; |
-##### Returns
--
-### dist/filters/adapters/UIToFlatUI.js
-#### UIToFlatUI(filterData, datasetsInfo)
-Generates a Flattened UI filter structure from UI Filter Data structure.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  | The UI filter data object. | &nbsp; |
-| datasetsInfo |  | Collection of datasets information. Optional for updating the datasets info | &nbsp; |
-##### Returns
--  a flattened UI filters array
-#### UI21ToFlatUI(scopes)
-Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| scopes |  | The filter scope section | &nbsp; |
-##### Returns
--  a flattened UI filters array
-### dist/filters/adapters/adaptDateGroupingProperty.js
-#### adaptDateGroupingProperty(property)
-[TODO: For 2022, eliminate this adapter]
-Get the new property base on the old date grouping properties
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| property |  |  | &nbsp; |
-##### Returns
--
-### dist/filters/adapters/adaptFilterData.js
-#### adaptFilterData(filterData, getUIFilterData, datasetsInfo)
-Checks and adapts the v2.0 Filter Data Structure to the v2.1
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data structure. Accepts both v2.1 or v2.0 | &nbsp; |
-| getUIFilterData |  | Flag to get a Filter Data (False) or the UI Filter Data (True) | &nbsp; |
-| datasetsInfo |  | Collection of datasets information. If getUIFilterData is true, the datasetsInfo should be mandatory | &nbsp; |
-##### Returns
--  A new filter data structure 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 | &nbsp; |
-##### Returns
--  A new value array with the filled properties.
-### dist/filters/adapters/flatUIToFD.js
-#### flatUIToFD(uFilters, version)
-Generates a filter data structure from the flatttened UI filters.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| uFilters |  | Array of flattened filters from UI | &nbsp; |
-| version |  | Tag for the version of the filter data structure | &nbsp; |
-##### Returns
--  a Filter Data.
-#### buildScopes(fbFilters)
-Gets an array of scopes structure for the filter data. The scopes is organized by scope types and scope IDs
-Also, adds and organizes filters by datasets
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| fbFilters |  | Array of flat filters from UI | &nbsp; |
-##### Returns
--  an array of scopes structure.
-#### buildScope(uFilter)
-Gets an scope structure for the filter data
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| uFilter |  | UI structure filter | &nbsp; |
-##### Returns
--  an scope structure
-#### buildDataset(uFilter)
-Gets an dataset structure for the filter data
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| uFilter |  | a UI structure filter | &nbsp; |
-##### Returns
--  an dataset structure
-#### buildFilter(uFilter)
-Gets an filter structure for the filter data
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| uFilter |  | a UI structure filter | &nbsp; |
-##### Returns
--  an filter structure
-### dist/filters/adapters/flatUIToLogic.js
-#### flatUIToLogic(uFilter)
-Generates a Logic structure from flattened UI filters
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| uFilter |  | Array of flat filters from UI | &nbsp; |
-##### Returns
--  The logic structure
-### dist/filters/adapters/flatUIToOldLogic.js
-#### flatUIToOldLogic(uFilters)
-Generates a Logic structure from flattened UI filters
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| uFilters |  | Array of flat filters from UI | &nbsp; |
-##### Returns
--  The logic structure
-### dist/filters/adapters/flatUIToUI.js
-#### flatUIToUI(uFilters, version)
-Generates a UI filter data structure from the flatttened UI filters.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| uFilters |  | Array of flattened filters from UI | &nbsp; |
-| version |  | Tag for the version of the filter data structure | &nbsp; |
-##### Returns
--  a UI Filter Data.
-#### buildScopes(fbFilters)
-Gets an array of scopes structure for the UI filter data. The scopes is organized by scope types and scope IDs
-Also, adds and organizes filters by datasets
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| fbFilters |  | Array of flat filters from UI | &nbsp; |
-##### Returns
--  an array of scopes structure.
-#### buildScope(uFilter)
-Gets an scope structure for the UI filter data
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| uFilter |  | UI structure filter | &nbsp; |
-##### Returns
--  an scope structure
-#### buildDataset(uFilter)
-Gets an dataset structure for the UI filter data
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| uFilter |  | a UI structure filter | &nbsp; |
-##### Returns
--  an dataset structure
-#### buildFilter(uFilter)
-Gets an filter structure for the UI filter data
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| uFilter |  | a UI structure filter | &nbsp; |
-##### Returns
--  an filter structure
-### dist/filters/adapters/logicToFD.js
-#### logicToFD(filterData, version)
-Generates a filter data structure from the old logic structure (v2.0).
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  | The old filter data structure with logic (v2.0) | &nbsp; |
-| version |  | Tag for the version of the filter data structure | &nbsp; |
-##### Returns
--  a Filter Data.
-### dist/filters/adapters/logicToFlatUI.js
-#### logicToFlatUI(logics)
-Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| logics |  | The old logic structure (v2.0) | &nbsp; |
-##### Returns
--  The Flattened UI Filters array
-#### getFilter(filters, filter, getIndex)
-Get the filter or the index of the given array, validating an old filter structure.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filters |  | The array of UI filters | &nbsp; |
-| filter |  | The old logic structure filter | &nbsp; |
-| getIndex |  | Determines if the index or returns the UI filter object | &nbsp; |
-##### Returns
--  the index or the UI filter object
-#### refineRankingValues(values, uiValues)
-Refines the values of the Ranking column type.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| values |  | the Array of Ranking values | &nbsp; |
-| uiValues |  | Object with additional info about the values of the filter. | &nbsp; |
-##### Returns
--  the array of Ranking values
-### dist/filters/adapters/logicToUI.js
-#### logicToUI(uFilters, datasetsInfo)
-Generates a UI filter structure from the old logic structure (v2.0).
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| uFilters |  | Array of filters from old logic structure | &nbsp; |
-| datasetsInfo |  | Collection of datasets information | &nbsp; |
-##### Returns
--  a UI Filter Data.
-### dist/filters/adapters/transformFilters.js
-#### transformFilters(oldFiltersObj, section)
-Transform the old filters structure into the new one
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| oldFiltersObj | `Object`  | an object with the old filters structure | &nbsp; |
-| section | `String`  | could be 'ANALYZE', 'PB', 'UM' or any other value. Deafult is 'ANYWHERE' | &nbsp; |
-##### Examples
-```javascript
-const oldPreferenceFilters = {
-  "WWXHAULtR-_-xYOQAdpqT__ENABLED": true,
-  "WWXHAULtR-_-xYOQAdpqT__ALL--ENABLED": true,
-  "WWXHAULtR-_-xYOQAdpqT__COLLAPSED": false,
-  "WWXHAULtR-_-xYOQAdpqT__LABEL": "GLOBAL",
-  "WWXHAULtR-_-xYOQAdpqT-_-AK4M8UV2": {
-    "formulaId": null,
-    "panelId": null,
-    "values": [
-      {
-        "EQUALS": [
-          {
-            "id": "AK4M8UV2a0",
-            "value": "A",
-            "enabled": true,
-            "imageUrl": null
-          },
-          {
-            "id": "AK4M8UV2a1",
-            "value": "B",
-            "enabled": true,
-            "imageUrl": null
-          }
-        ]
-      }
-    ],
-    "bucketId": null,
-    "text": "MC",
-    "title": "MC",
-    "type": "SINGLE_CHOICE",
-    "qid": "AK4M8UV2",
-    "dataset": {
-      "sourceid": "xYOQAdpqT",
-      "name": "Form All Questions",
-      "qrveyid": "xYOQAdpqT",
-      "text": "Form All Questions",
-      "linkid": 0
-    },
-    "enabled": true,
-    "linked": null
-  }
-};
-const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
-```
-##### Returns
-- `Object`  an object with the new filters structure
-### dist/filters/classes/FilterInputErrorHandler.js
-#### new FilterInputErrorHandler()
-##### Returns
-- `Void`
-### dist/filters/helpers/applyHierarchyForAggFilters.js
-#### applyHierarchyForAggFilters(chartSettings, scopes, currentScope)
-[TODO: Make a proper description for this function]
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| chartSettings |  | Chart Settings for the Filter Builder | &nbsp; |
-| scopes |  |  | &nbsp; |
-| currentScope |  |  | &nbsp; |
-##### Returns
--
-### dist/filters/helpers/getAvailableScopes.js
-#### getAvailableScopes(config)
-Gets Scopes/Scope IDs by given IDs
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| config |  | given Differnts IDs in order set a available scope | &nbsp; |
-##### Returns
--  a Scopes/Scope IDs array
-### dist/filters/helpers/getAvailableScopesIDsByConfig.js
-#### getAvailableScopesIDsByConfig(config)
-Gets the Scopes IDS for the Available Scope function by any config
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| config |  | any config | &nbsp; |
-##### Returns
--  a Available Scope IDS config
-### dist/filters/helpers/getScopesByHierarchy.js
-#### getScopesByHierarchy(scopes, currentScope)
-[TODO: Make a description for this]
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| scopes |  | the collection of Scopes/Scope IDs | &nbsp; |
-| currentScope |  | Current scope type | &nbsp; |
-##### Returns
--  A new array of Scopes/Scope IDs
-### dist/general/array/delete.js
-#### ArrayDelete(array, index)
-Inmutable Array Item deletion
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| array | `Array`  | a collection of items to delete | &nbsp; |
-| index | `Number`  | the position of the item to delete | &nbsp; |
-##### Returns
--  a new Array or the given parameter when is empty or not an array
-### dist/general/array/filterNestedTree.js
-#### filterNestedTree(arr, childArrKey, condition)
-Filters a nested tree array by a custom condition on the last child node
-- If the given arguments are not valid, the function returns the first argument.
-- If the childArrKey is not matched in the object, the condition tries to resolve the filter anyway and returns an empty array.
-- If the condition is not fulfilled, the function returns a filtered array, probably a empty array inside of the child array
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| arr |  | nested tree array | &nbsp; |
-| childArrKey |  | property representing the children array on the nested tree | &nbsp; |
-| condition |  | function callback that determines if the filter is applied on the last child node of the nested tree | &nbsp; |
-##### Returns
--  array filtered
-### dist/general/array/flattenDeep.js
-#### flattenDeep(arr)
-Flat deeply an array
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| arr |  | Array to flat deeply | &nbsp; |
-##### Returns
--  flatten array
-### dist/general/array/getFirstIndexFromArray.js
-#### getFirstIndexFromArray(array, callback)
-Gets the first index from the array by a callback condition
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| array |  |  | &nbsp; |
-| callback |  | function callback | &nbsp; |
-##### Returns
--  the first index of the array. -1 when the condition is not satisfied
-### dist/general/array/getLastIndexFromArray.js
-#### getLastIndexFromArray(array, callback)
-Gets the last index from the array by a callback condition
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| array |  |  | &nbsp; |
-| callback |  | function callback | &nbsp; |
-##### Returns
--  the last index of the array. -1 when the condition is not satisfied
-### dist/general/function/debounce.js
-#### debounce(fn, time)
-Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last time the debounced function was invoked.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| fn | `Function`  | original Function | &nbsp; |
-| time | `Number`  | default 500ms | &nbsp; |
-##### Returns
-- `Function`  debounced functions
-### dist/general/function/throttled.js
-#### throttled(fn, time)
-Make sure to only invokes _fn_ at most once per every _time_ milliseconds
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| fn | `Function`  | original Function | &nbsp; |
-| time | `Number`  | default 500ms | &nbsp; |
-##### Returns
-- `Function`  throttled function
-### dist/general/mix/compareDeep.js
-#### compareDeep(object1, object2)
-Compares two objects to know if they are equals. Go across nested objects.
-Includes arrays in the comparison.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| object1 |  | First Object to compare | &nbsp; |
-| object2 |  | Second Object to compare | &nbsp; |
-##### Returns
--  True: objects are equal. False: Objects are not equal. Undefined: invalid
-### dist/general/mix/getTag.js
-#### getTag(value)
-Gets the `toStringTag` of `value`.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| value |  | The value to query. | &nbsp; |
-##### Returns
-- `string`  Returns the `toStringTag`.
-### dist/general/mix/importScripts.js
-#### importScripts(scripts)
-Import a set of external Scripts given the URL in both serie and cascade way
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| scripts | `Array.<String>` `Array.<Object>`  | can be an array of string or an array of object with the follow structure: | &nbsp; |
-| scripts.url | `String`  | CDN URL | &nbsp; |
-| scripts.namespace | `String` `Function`  | (Optional) if is a String, that name is evaluated on Window[namespace] object otherwise the Function is invoked expecting a Thrutly value | &nbsp; |
-| scripts.type | `String`  | (Optional) it could be `module` of `text/javascript`. Default `text/javascript` | &nbsp; |
-| scripts.noModule | `Boolean`  | (Optional) add `momodule` attribute to script tag. Default `false` | &nbsp; |
-| scripts.dependencies | `Array.<Object>`  | an array with the same structure to load in cascade mode | &nbsp; |
-##### Examples
-```javascript
-// 1) Simple script (paralell loading)
-importScripts(['http://myscript.js', 'http://another.js']);
-// 2) Loading `.js` and `.esm.js` script (parallel loading)
-importScripts([
-  { url: 'http://myscript.esm.js', type: 'module' },
-  { url: 'http://myscript.js', noModule: true }
-]);
-// 3) import dependent scripts (cascade)
-importScripts([
-  { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] }
-]);
-// 4) mix
-importScripts([
-  { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] },
-  { url: 'http://another.esm.js', type: 'module' },
-  { url: 'http://another.js', noModule: true },
-  'http://simplescript.js'
-]);
-```
-##### Returns
-- `Promise`  Promise when all script have been loaded
-#### loadScript(url, type, noModule)
-Creates the script element and appends to document.head
-return a Promise that is resolved when the script is loaded
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| url | `String`  | Cdn Url | &nbsp; |
-| type | `String`  | (Optional) it could be `module` of `text/javascript`. Default `text/javascript` | &nbsp; |
-| noModule | `boolean`  | (Optional) add `momodule` attribute to script tag. Default `false` | &nbsp; |
-##### Returns
-- `Void`
-### dist/general/mix/isEmpty.js
-#### isEmpty(variable, includeFalsy)
-Validates if the given argument is empty
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| variable |  | the given variable | &nbsp; |
-| includeFalsy |  | flag to determine include the falsy variables into the validation | &nbsp; |
-##### Returns
--  true: the given argument is empty; false: is not.
-### dist/general/mix/isNaNV2.js
-#### isNaNV2(variable)
-Validates if the recieved number is NaN type.
-This function recieves any variable but will return false.
-Validates if variable is null, undefined, or an empty string, also, the function uses isNaN native function.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| variable |  | the variable to validate | &nbsp; |
-##### Returns
--  True if variable is a NaN or false otherwise
-### dist/general/mix/isNull.js
-#### isNull(arg)
-return if a given variable is either `null` or `undefined`
-useful to avoid falsify validating Number Zero (0)
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| arg | `any`  |  | &nbsp; |
-##### Returns
-- `Boolean`
-### dist/general/mix/randomId.js
-#### randomId(length, exclude)
-Creates a random string
-- If the first given argument is different than a length number, the variable is replaced by a default number
-- If the optional second given argument is passed the random string is permutated.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| length | `Number`  | size of the generated string. Default 8 | &nbsp; |
-| exclude | `Array`  | collection of strings that is going to be excluded of the random string. | &nbsp; |
-##### Returns
-- `String`  Random string
-### dist/general/mix/size.js
-#### size(obj)
-Gets the length of the given array.
-- Useful for Object, Array and string type.
-- For `null` or `undefined` or else argument the returned value will be 0.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| obj | `Any`  | Any object-type variable | &nbsp; |
-##### Returns
-- `Number`  the size of the given variable
-### dist/general/object/cloneDeep.js
-#### cloneDeep(obj)
-A simple Deep Cloning function. Valid only for primivite values and object with primitive values.
-Not to use this function with inner objects and functions
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| obj |  | The object | &nbsp; |
-##### Returns
--  The new reference object or the given object if the parsing is incorrect or empty
-### dist/general/object/get.js
-#### _get(baseObject, path, defaultValue)
-Like lodash _.get.
-Gets the value at path of object. If the resolved value is undefined, the defaultValue is returned in its place.
-Empty arrays and empty objects are returned but the defaultValue is not
-Undefined and null values will return the defaultValue.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| baseObject |  | The object to query | &nbsp; |
-| path |  | The string path or collection of string paths of the property to get. | &nbsp; |
-| defaultValue |  | The value returned for undefined resolved values. | &nbsp; |
-##### Examples
-```javascript
-// returns 'Hello'
-_get({ item1: 'Hello', item2: 'World' }, 'item1')
-```
-```javascript
-// returns 'A simple Hello'
-_get({ item1: 'Hello', item2: 'World' }, 'item3', 'A simple Hello')
-```
-```javascript
-// returns 'Hello Again'
-_get({ item1: { item11: 'Hello Again' }, item2: {} }, 'item1.item11')
-```
-```javascript
-// returns 'Hello 2'
-_get({ item1: ['Hello 1', 'Hello 2' }, item2: [] }, 'item1[1]')
-```
-```javascript
-// returns 'Hello Again'
-_get({ item1: { item11: 'Hello Again' }, item2: {} }, ['item1', 'item11'])
-```
-##### Returns
--  the resolved value.
-### dist/general/object/getAttribute.js
-#### getAttribute(obj, key)
-Searchs for properties in different case styles such as: lower, upper, camel and pascal
-- To optimize the searching, it is required a key in a snake_case style
-- List of cases that do not match
--- From lower to snake case
--- From upper to snake case
--- From lower to camel case
--- From upper to camel case
--- From lower to pascal case
--- From upper to pascal case
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| obj | `object`  | object to look for | &nbsp; |
-| key | `string`  | String attribute in snake_case style | &nbsp; |
-##### Examples
-```javascript
-getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
-```
-##### Returns
-- `Void`
-### dist/general/object/hasProperty.js
-#### _hasProperty(obj, property)
-Use the hasOwnProperty in order to verify if the given property exists in the object.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| obj | `object`  | an object | &nbsp; |
-| property | `string`  | String to verify if exists in the object as property | &nbsp; |
-##### Examples
-```javascript
-const prop = 'prop2'
-const obj1 = { prop1: 'hello', prop2: 'world'}
-_hasProperty(ob1, prop1) // true
-const obj2 = { prop1: 'hello world' }
-_hasProperty(ob1, prop2) // false
-```
-##### Returns
--  True if the object has the given property; otherwise, false.
-### dist/general/object/isObject.js
-#### isObject(obj)
-Checks if the given argument is an object type
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| obj |  | the variable to check | &nbsp; |
-##### Returns
--  True: It is an object; False: It is not.
-### dist/general/object/mapValues.js
-#### mapValues(baseObject, iteratee)
-Invoke iteratee (function) for each object key-value pair
-and return a mapped object
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| baseObject | `Object`  | Base object. | &nbsp; |
-| iteratee | `Function`  | The executed per iteration. | &nbsp; |
-##### Returns
-- `Object`  New mapped object.
-### dist/general/object/mergeDeep.js
-#### mergeDeep(obj1, obj2, settings)
-Merges two objects into a new one.
-The second given argument to the first given argument.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| obj1 |  | The target object | &nbsp; |
-| obj2 |  | The object to be merged | &nbsp; |
-| settings |  | Object settings for this function | &nbsp; |
-##### Returns
--  a new merged object
-#### isValid(obj1, obj2)
-Validates if the two arguments are objects
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| obj1 |  | The target object | &nbsp; |
-| obj2 |  | The object to be merged | &nbsp; |
-##### Returns
--  true: they are valid; false: they are not
-#### getParamsToMergeDeep(settings)
-Validates and gets the settings with all set parameters.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| settings |  | the settings object | &nbsp; |
-##### Returns
--  a new settings object with all set parameters.
-### dist/general/object/objectCopy.js
-#### objectCopy(entity, cache)
-Created a new reference of the given argument
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| entity |  | The variable to be copied | &nbsp; |
-| cache |  |  | &nbsp; |
-##### Returns
--  A new reference of the given argument
-### dist/general/object/omit.js
-#### omit(obj, props)
-return a new Object excluding attributes in _props_ list
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| obj | `Object`  | base object | &nbsp; |
-| props | `Array.<String>`  | list of attribute to exclude | &nbsp; |
-##### Returns
-- `Object`  clean object
-### dist/general/object/pick.js
-#### pick(baseObject, keys)
-return a new object just with attributes in _keys_ list
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| baseObject | `Object`  | base object | &nbsp; |
-| keys | `Array.<String>`  | list of attributes to preserve | &nbsp; |
-##### Returns
-- `Object`  new object just with desired attributes
-### dist/general/object/serialize.js
-#### serialize(obj)
-serialize object to url param
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| obj |  | - Object to be serialized | &nbsp; |
-##### Returns
-- `Void`
-### dist/general/string/capitalize.js
-#### capitalize(text)
-Upper case the first letter of a given text
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| text | `String`  |  | &nbsp; |
-##### Returns
-- `String`  a capitalized text
-### dist/qrvey/helpers/getColumnsLabel.js
-#### getColumnLabels(column)
-Get an string of the properties of the given column.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| column |  | The column | &nbsp; |
-##### Returns
--  an string with the property, aggregate or calculation label.
-### dist/qrvey/helpers/getValueWithSuffixes.js
-#### getValueWithSuffixes(value, suffixes)
-Get a string value with suffixes if available.
-Add suffix into the value string. Prioritized for numeric values.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| value |  | a number or string | &nbsp; |
-| suffixes |  | An object with singular or plural suffix string. | &nbsp; |
-##### Returns
--  a string value with suffix
-### dist/qrvey/helpers/transformValue.js
-#### transformValue(value, settings)
-Transforms a value depending of localization/globalization and extras settings.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| value |  | A value to transform | &nbsp; |
-| settings |  | The settings of the transformValue function | &nbsp; |
-##### Returns
--  A transformed value
-#### getOutputFormat(settings)
-Gets the outputformat settings
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| settings |  | The settings of the transformValue function | &nbsp; |
-##### Returns
--  the outputformat settings
-#### getFormatConfig(settings)
-Gets the format config
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| settings |  | The settings of the transformValue function | &nbsp; |
-##### Returns
--  the format config
-### dist/services/api/getAllDatasets.api.js
-#### getAllDatasets(config, pickDatasets)
-Get a dataset list from a collection of Qrvey IDs
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| config |  | the widget config. Includes the appid and others configuration properties | &nbsp; |
-| pickDatasets |  | Collection of Qrvey IDs for filtering the request | &nbsp; |
-##### Returns
--  a promise
-### 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
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| config |  | Configuration | &nbsp; |
-| params |  | Object for getting precise data | &nbsp; |
-##### Returns
-- `Void`
-### dist/services/api/getDatasetColumns.api.js
-#### getDatasetColumns(qrveyid)
-Get a dataset by Qrvey ID
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| qrveyid |  | The Qrvey ID | &nbsp; |
-##### Returns
--  a promise
-### dist/stencil/decorators/Config.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
-##### 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
-- `Void`
-### dist/stencil/util/createRef.js
-#### createRef()
-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
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| cfg |  |  | &nbsp; |
-##### Returns
-- `Void`
-### dist/typescript/decorators/Throttled.js
-#### Throttled(time)
-(Method Decorator) Throttled Class Method
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| time |  | (optional) deafult 500 | &nbsp; |
-##### Returns
-- `Void`
-### dist/typescript/decorators/Debounce.js
-#### Debounce(time)
-(Method Decorator) Debounce Class Method
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| time |  | (optional) deafult 500 | &nbsp; |
-##### Returns
-- `Void`
-### dist/dates/relative/helpers/formatStatement.js
-#### formatStatement(statement)
-Build a proper relative date statement type
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| statement | `RelativeStatement`  |  | &nbsp; |
-##### Returns
-- `RelativeStatement`
-### dist/dates/relative/helpers/getStatementCase.js
-#### getStatementCase(includeCurrent, isCalendarDate)
-Returns a number/constant that identifies a relative date case
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| includeCurrent | `boolean`  |  | &nbsp; |
-| isCalendarDate | `boolean`  |  | &nbsp; |
-##### Returns
-- `number`
-### dist/dates/relative/helpers/parseDate.js
-#### parseDate(date)
-Parses a string date and returns a dayjs date
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| date | `string` `Dayjs` `Date`  |  | &nbsp; |
-##### Returns
-- `Dayjs`  A dayjs date
-### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
-#### getFilterBuilderGeneralConfig(config)
-Returns a filter builder config object by a any given config
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| config |  | any config object | &nbsp; |
-##### Returns
--  The filter builder config object
-### dist/filters/helpers/backend/buildExpression.js
-#### buildExpression(filter)
-Builds filter expression by the filter data.
-- If the resulting value array is empty the enabled property will be false.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filter |  | The filter to transform | &nbsp; |
-##### Returns
--  a filter expression
-### dist/filters/helpers/backend/buildUserFilters.js
-#### buildUserFilters(userFilters)
-Transform user Filters array into Filter Logic structure
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| userFilters |  | The filters that the user defined. | &nbsp; |
-##### Returns
--  The filter logic for the given user filters. if No a given object is recieved, it will return an empty array.
-### dist/filters/helpers/backend/getAggFiltersBySummaryIndex.js
-#### getAggFiltersBySummaryIndex(aggFilters, summaryIndex)
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| aggFilters |  |  | &nbsp; |
-| summaryIndex |  |  | &nbsp; |
-##### Returns
--
-### dist/filters/helpers/backend/getBackendGroupValue.js
-#### getBackendGroupValue(filter)
-Gets a group value for the backend logic structure
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filter |  | The filter | &nbsp; |
-##### Returns
--  a property
-### dist/filters/helpers/backend/getBackendProperty.js
-#### getBackendProperty(filter)
-Gets a property for the logic structure
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filter |  | The filter | &nbsp; |
-##### Returns
--  a property
-### dist/filters/helpers/backend/getBackendValidator.js
-#### getBackendValidator(validator)
-Gets the Validator that is used in requests
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| validator |  | Filter Validator used in UI | &nbsp; |
-##### Returns
--  Filter Validator used in Backend
-### dist/filters/helpers/backend/getBackendValues.js
-#### getBackendValues(filter)
-Gets the expresion values in the logic format
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filter |  | The filter structure | &nbsp; |
-##### Returns
--  A collection of backend expression value
-#### getResultValues(values, filter)
-Gets the expression values. Depending on the column type
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| values |  | a collection of filter values | &nbsp; |
-| filter |  | The filter structure | &nbsp; |
-##### Returns
--
-#### getRankingValues(values, rankingGroupIndex)
-Gets the Ranking values.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| values |  | a collection of filter values in the ranking structure | &nbsp; |
-| rankingGroupIndex |  | determine the value by this index to build and return it | &nbsp; |
-##### Returns
--  Expression values for ranking
-### dist/filters/helpers/backend/getLogicByScopes.js
-#### getLogicByScopes(logics, scopes)
-Gets the filters from logic data by Scopes/Scope IDs.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| logics |  | The logic array | &nbsp; |
-| scopes |  | The collection of Scopes/Scope IDs | &nbsp; |
-##### Returns
--  a new Logic array
-### dist/filters/helpers/backend/getLogicByScopesHierarchy.js
-#### getLogicByScopesHierarchy(filterData, scopes, currentScope)
-Gets filters from the logic by the scopes hierarchy.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  |  | &nbsp; |
-| scopes |  |  | &nbsp; |
-| currentScope |  |  | &nbsp; |
-##### Returns
--  a new array of Logic
-### dist/filters/helpers/common/areFiltersEquals.js
-#### areFiltersEquals(filter1, filter2)
-Validates if both filters are the same
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filter1 |  | filter 1 | &nbsp; |
-| filter2 |  | filter 2 | &nbsp; |
-##### Returns
--  true: the filters are equal; false: the filters are NOT equal
-### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
-#### excludeFiltersByAggregateColumn(filterData)
-Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object | &nbsp; |
-##### Returns
--  The new filter data object that were excluded the aggregate filters
-### dist/filters/helpers/common/excludeFiltersByParams.js
-#### 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
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  | The Filter Data or the UI Filter Data | &nbsp; |
-| params |  | given parameters to validate the filter data | &nbsp; |
-##### Returns
--  a new Filter object structure
-### dist/filters/helpers/common/excludeFiltersByScopes.js
-#### excludeFiltersByScopes(filterData, scopes)
-Excludes and returns a filter data without filters by the given scopes
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  | The Filter Data | &nbsp; |
-| scopes |  | collection of scopes to be as filtering parameters | &nbsp; |
-##### Returns
--  The new Filter Data without filters by the given scopes.
-### dist/filters/helpers/common/getFilterColumnLabel.js
-#### getFilterColumnLabel(column)
-Get an string of the properties of the given filter column.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| column |  | The filter column | &nbsp; |
-##### Returns
--  an string with the property, aggregate or calculation label.
-### 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
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filter |  | the filter structure | &nbsp; |
-##### Returns
--  a text to identify the filter
-### dist/filters/helpers/common/getFilterLabel.js
-#### getFilterLabel(filter)
-Gets the Filter Label + Column label
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filter |  | the UI filter | &nbsp; |
-##### Returns
--  a sring label
-### dist/filters/helpers/common/getFiltersByAggregateColumn.js
-#### getFiltersByAggregateColumn(filterData)
-Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data object | &nbsp; |
-##### Returns
--  The new filter data object that were get the aggregate filters
-### 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
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  | The Filter Data or the UI Filter Data | &nbsp; |
-| params |  | given parameters to validate the dataset | &nbsp; |
-##### Returns
--  a new Filter object structure
-### dist/filters/helpers/common/getFiltersByScopes.js
-#### getFiltersByScopes(filterData, scopes)
-Filters and gets a Filter Data by the given scopes
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  | The Filter Data | &nbsp; |
-| scopes |  | collection of scopes types | &nbsp; |
-##### Returns
--  The new Filter Data
-### dist/filters/helpers/common/getFiltersByScopesIds.js
-#### getFiltersByScopesIds(filterData, scopes)
-Gets filters from Filter Data by Scopes/Scope IDs.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  | The filter data | &nbsp; |
-| scopes |  | The collection of Scopes/Scope IDs | &nbsp; |
-##### Returns
--  a new Filter Data
-### dist/filters/helpers/common/getFiltersByVisibility.js
-#### getFiltersByVisibility(filterData, scopes)
-Get a new Filter Data by filtering scopes/scope IDs and enabled flags
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  | a Filter Data or UI Filter Data | &nbsp; |
-| scopes |  | a Scopes/Scope IDs array | &nbsp; |
-##### Returns
--  a new Filter Data
-### dist/filters/helpers/common/getMergeFiltersSettings.js
-#### getMergeFiltersSettings(settings)
-Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| settings |  | an object to the MergeFilters settings | &nbsp; |
-##### Returns
--  a new MergeFilters settings object.
-### dist/filters/helpers/common/getParamsToGetFilterSettings.js
-#### getParamsToGetFilterSettings(settings)
-Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| settings |  | an object to the ParamsToGetFilter settings | &nbsp; |
-##### Returns
--  a new ParamsToGetFilter settings object.
-### dist/filters/helpers/common/haveFiltersByDataset.js
-#### haveFiltersByDataset(filterData, qrveyid)
-Validates if the filter data has filters by a dataset ID (Qrvey ID).
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData |  | the filter data or the UI filter data. | &nbsp; |
-| qrveyid |  | The Qrvey ID | &nbsp; |
-##### Returns
--  true: the filter data has filters by the Qrvey ID
-### dist/filters/helpers/common/isBetweenValidator.js
-#### isBetweenValidator(validator)
-Validates if the given validator is a Between type
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| validator |  | The validator | &nbsp; |
-##### Returns
--  true: it is a between validator; false: it is not a between validator
-### dist/filters/helpers/common/isDateDistinctProperty.js
-#### isDateDistinctProperty(column, property)
-Determines if the filter column and property is a distinct group dates type
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| column |  | The filter column | &nbsp; |
-| property |  | The filter property | &nbsp; |
-##### Returns
--  True if the given property is included from distinct group dates type
-### dist/filters/helpers/common/isInValidator.js
-#### isInValidator(validator)
-Validates if the given validator is a In type
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| validator |  | The validator | &nbsp; |
-##### Returns
--  true: it is a In validator; false: it is not a In validator
-### dist/filters/helpers/common/isNullValidator.js
-#### isNullValidator(validator)
-Checks if the given validator is a Null type.
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| validator |  | The Filter Validator | &nbsp; |
-##### Returns
--  True: It is a Null Validator; False: It is not a Null Validator.
-### dist/filters/helpers/common/isRangeValidator.js
-#### isRangeValidator(validator)
-Validates if the given validator is a Range type. Range type means the value has min and max values to filter
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| validator |  | The filter validator | &nbsp; |
-##### Returns
--  true: it is a range validator
-### dist/filters/helpers/common/isRegularValidator.js
-#### isRegularValidator(validator)
-Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| validator |  | The filter validator | &nbsp; |
-##### Returns
--  true: it is a range validator
-### dist/filters/helpers/common/mergeFilters.js
-#### mergeFilters(filterData1, filterData2, overwriteValues)
-Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filterData1 |  | The target filter data | &nbsp; |
-| filterData2 |  | the filter data to be merged | &nbsp; |
-| overwriteValues |  | Flag to overwrite or not the filter values | &nbsp; |
-##### Returns
--  a new filter data structure
-#### mergeScopes(scopes1, scopes2, overwriteValues)
-Gets a new scope structure array by merging two scope structures
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| scopes1 |  | the target scope structure | &nbsp; |
-| scopes2 |  | the scope to be merged | &nbsp; |
-| overwriteValues |  | Flag to overwrite or not the filter values | &nbsp; |
-##### Returns
--  a new scope structure array
-#### mergeDatasets(datasets1, datasets2, overwriteValues)
-Gets a new dataset structure array by merging two dataset structures
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| datasets1 |  | the target dataset structure | &nbsp; |
-| datasets2 |  | the dataset to be merged | &nbsp; |
-| overwriteValues |  | Flag to overwrite or not the filter values | &nbsp; |
-##### Returns
--  a new dataset structure array
-#### mergeFilterss(filters1, filters2, overwriteValues)
-Gets a new filter structure array by merging two filter structures
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filters1 |  | the target filter structure | &nbsp; |
-| filters2 |  | the filter to be merged | &nbsp; |
-| overwriteValues |  | Flag to overwrite or not the filter values | &nbsp; |
-##### Returns
--  a new filter structure array
-#### mergeValues(filter1, filter2, overwrite)
-Gets a new value structure array by merging two value structures
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filter1 |  | the target filter structure | &nbsp; |
-| filter2 |  | the filter to be used to merge the values | &nbsp; |
-| overwrite |  | Flag to overwrite or not the filter values | &nbsp; |
-##### Returns
--  a new value structure array
-### dist/filters/helpers/common/resolveDatasetConditions.js
-#### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
-Resolves the conditions by given params
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filter |  | The dataset structure | &nbsp; |
-| params |  | given parameters to validate the dataset | &nbsp; |
-| letPassUndefinedProperties |  | Flag to avoid applying the condition when the filter properties are undefined | &nbsp; |
-| letPassUndefinedParams |  | Flag to avoid applying the condition when the param properties are explicit undefined. | &nbsp; |
-##### Returns
--  true: the condition is satisfied
-### dist/filters/helpers/common/resolveFilterConditions.js
-#### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
-Resolves the conditions by given params
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filter |  | The filter | &nbsp; |
-| params |  | given parameters to validate the filter | &nbsp; |
-| letPassUndefinedProperties |  | Flag to avoid applying the condition when the filter properties are undefined | &nbsp; |
-| letPassUndefinedParams |  | Flag to avoid applying the condition when the param properties are explicit undefined. | &nbsp; |
-##### Returns
--  true: the condition is satisfied
-### dist/filters/helpers/common/resolveScopeConditions.js
-#### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
-Resolves the conditions by given params
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filter |  | The filter scope structure | &nbsp; |
-| params |  | given parameters to validate the filter | &nbsp; |
-| letPassUndefinedProperties |  | Flag to avoid applying the condition when the filter properties are undefined | &nbsp; |
-| letPassUndefinedParams |  | Flag to avoid applying the condition when the param properties are explicit undefined. | &nbsp; |
-##### Returns
--  true: the condition is satisfied
-### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
-#### excludeUIFiltersByAggregate(uFilters)
-Excludes Aggregate Filters in the Flattened UI Filters array
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| uFilters |  | Collection of Flat UI Filters | &nbsp; |
-##### Returns
--  a new Flat UI Filters that were excluded the aggregate filters
-### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
-#### excludeUIFlatFiltersByScopes(uFilters, scopes)
-Excludes and returns a UI Flat Filters without filters by the given scopes
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| uFilters |  | The Flatten UI Filters | &nbsp; |
-| scopes |  | collection of scopes types | &nbsp; |
-##### Returns
--  The new array of UI Flattened filters
-### dist/filters/helpers/ui/getFilterPropertyLabel.js
-#### getFilterPropertyLabel(filter)
-Gets the label of the filter property
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filter |  | The UI Filter | &nbsp; |
-##### Returns
--  a string of the filter property label
-### dist/filters/helpers/ui/getOutputFormatByColumn.js
-#### getOutputFormatByColumn(column, datasets)
-Gets output format object from Datasets by the given column. Item of the datasets array must have outputformat item in order to be returned
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| column |  | The column | &nbsp; |
-| datasets |  | array of datasets | &nbsp; |
-##### Returns
--  The output format object
-### dist/filters/helpers/ui/getQrveyIdsByUIFilters.js
-#### getQrveyIdsByUIFilters(uiFilter)
-Gets a collection of Qrvey IDs in the UI Filter structure.
-Looks around all filter structure finding the qrveyid propertty in each dataset
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| uiFilter |  |  | &nbsp; |
-##### Returns
-- `Void`
-### dist/filters/helpers/ui/getUIFlatFilterByParams.js
-#### getUIFlatFilterByParams()
-Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
-The validation to filter the stored filter is depending on:
-- Column
-- Qrvey ID,
-- Scope type
-- Scope ID
-- Panel ID
-- Validator type
-- Property type
-##### Returns
--  The index of the uFilter array or the Filter object s
-### dist/filters/helpers/ui/getUIFlatFiltersByParams.js
-#### getUIFlatFiltersByParams()
-Gets a filter from the given Flattened UI Filters by given params. Return a index of the array or an object
-The validation to filter the stored filter is depending on:
-- Column
-- Qrvey ID,
-- Scope type
-- Scope ID
-- Panel ID
-- Validator type
-- Property type
-- Enabled flags
-##### Returns
--  The index of the uFilter array or the Filter object s
-### dist/filters/helpers/ui/getUIFlatFiltersByScopes.js
-#### getUIFlatFiltersByScopes(uFilters, scopes)
-Filters and gets a UI Flatten Filters by the given scopes
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| uFilters |  | The Flatten UI Filters | &nbsp; |
-| scopes |  | collection of scopes types | &nbsp; |
-##### Returns
--  The new array of UI Flattened filters
-### dist/filters/helpers/ui/getUIValues.js
-#### getUIValues(filter, addEnableds, rankingGroupIndex)
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filter |  |  | &nbsp; |
-| addEnableds |  |  | &nbsp; |
-| rankingGroupIndex |  |  | &nbsp; |
-##### Returns
--
-### dist/filters/helpers/ui/getUpdatedUIFilters.js
-#### getUpdatedUIFilters(data, datasets)
-Gets a new UI Filter structure with a datasets/columns info updates
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| data |  | The UI Filter structure | &nbsp; |
-| datasets |  | An array of datasets/column info used for updating the data | &nbsp; |
-##### Returns
--  A new UI FIlter structure
-### dist/filters/helpers/ui/resolveUIFlatFiltersByParams.js
-#### resolveUIFlatFilterByParams(filter, params)
-Resolves conditions between UI flattened filter and given parameters
-##### Parameters
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| filter |  | UI Flatten Filter | &nbsp; |
-| params |  | Parameters to validate | &nbsp; |
-##### Returns
--  true: the conditions are satisfied.
-*Documentation generated with [doxdox](https://github.com/neogeek/doxdox).*