@qrvey/utils 1.2.9-25 → 1.2.9-26

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.
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-25*
1
+ # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-26*
2
2
 
3
3
  > Helper, Utils for all Qrvey Projects
4
4
 
@@ -3025,12 +3025,13 @@ Parses a string date and returns a dayjs date
3025
3025
 
3026
3026
 
3027
3027
 
3028
- ### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
3028
+ ### dist/filters/helpers/backend/buildExpression.js
3029
3029
 
3030
3030
 
3031
- #### getFilterBuilderGeneralConfig(config)
3031
+ #### buildExpression(filter)
3032
3032
 
3033
- Returns a filter builder config object by a any given config
3033
+ Builds filter expression by the filter data.
3034
+ - If the resulting value array is empty the enabled property will be false.
3034
3035
 
3035
3036
 
3036
3037
 
@@ -3039,7 +3040,7 @@ Returns a filter builder config object by a any given config
3039
3040
 
3040
3041
  | Name | Type | Description | |
3041
3042
  | ---- | ---- | ----------- | -------- |
3042
- | config | | any config object |   |
3043
+ | filter | | The filter to transform |   |
3043
3044
 
3044
3045
 
3045
3046
 
@@ -3047,17 +3048,17 @@ Returns a filter builder config object by a any given config
3047
3048
  ##### Returns
3048
3049
 
3049
3050
 
3050
- - The filter builder config object
3051
+ - a filter expression
3051
3052
 
3052
3053
 
3053
3054
 
3054
3055
 
3055
- ### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
3056
+ ### dist/filters/helpers/backend/buildUserFilters.js
3056
3057
 
3057
3058
 
3058
- #### excludeFiltersByAggregateColumn(filterData)
3059
+ #### buildUserFilters(userFilters)
3059
3060
 
3060
- Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
3061
+ Transform user Filters array into Filter Logic structure
3061
3062
 
3062
3063
 
3063
3064
 
@@ -3066,7 +3067,7 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
3066
3067
 
3067
3068
  | Name | Type | Description | |
3068
3069
  | ---- | ---- | ----------- | -------- |
3069
- | filterData | | The filter data object |   |
3070
+ | userFilters | | The filters that the user defined. |   |
3070
3071
 
3071
3072
 
3072
3073
 
@@ -3074,17 +3075,17 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
3074
3075
  ##### Returns
3075
3076
 
3076
3077
 
3077
- - The new filter data object that were excluded the aggregate filters
3078
+ - The filter logic for the given user filters. if No a given object is recieved, it will return an empty array.
3078
3079
 
3079
3080
 
3080
3081
 
3081
3082
 
3082
- ### dist/filters/helpers/common/areFiltersEquals.js
3083
+ ### dist/filters/helpers/backend/getAggFiltersBySummaryIndex.js
3083
3084
 
3084
3085
 
3085
- #### areFiltersEquals(filter1, filter2)
3086
+ #### getAggFiltersBySummaryIndex(aggFilters, summaryIndex)
3087
+
3086
3088
 
3087
- Validates if both filters are the same
3088
3089
 
3089
3090
 
3090
3091
 
@@ -3093,8 +3094,8 @@ Validates if both filters are the same
3093
3094
 
3094
3095
  | Name | Type | Description | |
3095
3096
  | ---- | ---- | ----------- | -------- |
3096
- | filter1 | | filter 1 |   |
3097
- | filter2 | | filter 2 |   |
3097
+ | aggFilters | | |   |
3098
+ | summaryIndex | | |   |
3098
3099
 
3099
3100
 
3100
3101
 
@@ -3102,26 +3103,17 @@ Validates if both filters are the same
3102
3103
  ##### Returns
3103
3104
 
3104
3105
 
3105
- - true: the filters are equal; false: the filters are NOT equal
3106
+ -
3106
3107
 
3107
3108
 
3108
3109
 
3109
3110
 
3110
- ### dist/filters/helpers/common/excludeFiltersByParams.js
3111
+ ### dist/filters/helpers/backend/getBackendGroupValue.js
3111
3112
 
3112
3113
 
3113
- #### excludeFiltersByParams(filterData, params)
3114
+ #### getBackendGroupValue(filter)
3114
3115
 
3115
- Excludes filters from the given Filters.
3116
- The validation to filter the stored filter is depending on:
3117
- - Column
3118
- - Qrvey ID
3119
- - Scope type
3120
- - Scope ID
3121
- - Panel ID
3122
- - Validator type
3123
- - Property type
3124
- - Enabled flags
3116
+ Gets a group value for the backend logic structure
3125
3117
 
3126
3118
 
3127
3119
 
@@ -3130,8 +3122,7 @@ The validation to filter the stored filter is depending on:
3130
3122
 
3131
3123
  | Name | Type | Description | |
3132
3124
  | ---- | ---- | ----------- | -------- |
3133
- | filterData | | The Filter Data or the UI Filter Data |   |
3134
- | params | | given parameters to validate the filter data |   |
3125
+ | filter | | The filter |   |
3135
3126
 
3136
3127
 
3137
3128
 
@@ -3139,17 +3130,17 @@ The validation to filter the stored filter is depending on:
3139
3130
  ##### Returns
3140
3131
 
3141
3132
 
3142
- - a new Filter object structure
3133
+ - a property
3143
3134
 
3144
3135
 
3145
3136
 
3146
3137
 
3147
- ### dist/filters/helpers/common/excludeFiltersByScopes.js
3138
+ ### dist/filters/helpers/backend/getBackendProperty.js
3148
3139
 
3149
3140
 
3150
- #### excludeFiltersByScopes(filterData, scopes)
3141
+ #### getBackendProperty(filter)
3151
3142
 
3152
- Excludes and returns a filter data without filters by the given scopes
3143
+ Gets a property for the logic structure
3153
3144
 
3154
3145
 
3155
3146
 
@@ -3158,8 +3149,7 @@ Excludes and returns a filter data without filters by the given scopes
3158
3149
 
3159
3150
  | Name | Type | Description | |
3160
3151
  | ---- | ---- | ----------- | -------- |
3161
- | filterData | | The Filter Data |   |
3162
- | scopes | | collection of scopes to be as filtering parameters |   |
3152
+ | filter | | The filter |   |
3163
3153
 
3164
3154
 
3165
3155
 
@@ -3167,17 +3157,17 @@ Excludes and returns a filter data without filters by the given scopes
3167
3157
  ##### Returns
3168
3158
 
3169
3159
 
3170
- - The new Filter Data without filters by the given scopes.
3160
+ - a property
3171
3161
 
3172
3162
 
3173
3163
 
3174
3164
 
3175
- ### dist/filters/helpers/common/getFilterColumnLabel.js
3165
+ ### dist/filters/helpers/backend/getBackendValidator.js
3176
3166
 
3177
3167
 
3178
- #### getFilterColumnLabel(column)
3168
+ #### getBackendValidator(validator)
3179
3169
 
3180
- Get an string of the properties of the given filter column.
3170
+ Gets the Validator that is used in requests
3181
3171
 
3182
3172
 
3183
3173
 
@@ -3186,7 +3176,7 @@ Get an string of the properties of the given filter column.
3186
3176
 
3187
3177
  | Name | Type | Description | |
3188
3178
  | ---- | ---- | ----------- | -------- |
3189
- | column | | The filter column |   |
3179
+ | validator | | Filter Validator used in UI |   |
3190
3180
 
3191
3181
 
3192
3182
 
@@ -3194,17 +3184,17 @@ Get an string of the properties of the given filter column.
3194
3184
  ##### Returns
3195
3185
 
3196
3186
 
3197
- - an string with the property, aggregate or calculation label.
3187
+ - Filter Validator used in Backend
3198
3188
 
3199
3189
 
3200
3190
 
3201
3191
 
3202
- ### dist/filters/helpers/common/getFilterLabel.js
3192
+ ### dist/filters/helpers/backend/getBackendValues.js
3203
3193
 
3204
3194
 
3205
- #### getFilterLabel(filter)
3195
+ #### getBackendValues(filter)
3206
3196
 
3207
- Gets the Filter Label + Column label
3197
+ Gets the expresion values in the logic format
3208
3198
 
3209
3199
 
3210
3200
 
@@ -3213,7 +3203,7 @@ Gets the Filter Label + Column label
3213
3203
 
3214
3204
  | Name | Type | Description | |
3215
3205
  | ---- | ---- | ----------- | -------- |
3216
- | filter | | the UI filter |   |
3206
+ | filter | | The filter structure |   |
3217
3207
 
3218
3208
 
3219
3209
 
@@ -3221,28 +3211,13 @@ Gets the Filter Label + Column label
3221
3211
  ##### Returns
3222
3212
 
3223
3213
 
3224
- - a sring label
3225
-
3226
-
3227
-
3214
+ - A collection of backend expression value
3228
3215
 
3229
- ### dist/filters/helpers/common/getFilterid.js
3230
3216
 
3231
3217
 
3232
- #### getFilterid(filter)
3218
+ #### getResultValues(values, filter)
3233
3219
 
3234
- Get the Filter ID by the filter structure
3235
- The order of the epression ID is:
3236
- - Scope Type
3237
- - scopeid
3238
- - qrveyid
3239
- - panelid
3240
- - columnid
3241
- - validator
3242
- - property
3243
- - Column Aggregate
3244
- - Column Calculation
3245
- - Optional Index
3220
+ Gets the expression values. Depending on the column type
3246
3221
 
3247
3222
 
3248
3223
 
@@ -3251,7 +3226,8 @@ The order of the epression ID is:
3251
3226
 
3252
3227
  | Name | Type | Description | |
3253
3228
  | ---- | ---- | ----------- | -------- |
3254
- | filter | | the filter structure |   |
3229
+ | values | | a collection of filter values |   |
3230
+ | filter | | The filter structure |   |
3255
3231
 
3256
3232
 
3257
3233
 
@@ -3259,17 +3235,13 @@ The order of the epression ID is:
3259
3235
  ##### Returns
3260
3236
 
3261
3237
 
3262
- - a text to identify the filter
3263
-
3264
-
3265
-
3238
+ -
3266
3239
 
3267
- ### dist/filters/helpers/common/getFiltersByAggregateColumn.js
3268
3240
 
3269
3241
 
3270
- #### getFiltersByAggregateColumn(filterData)
3242
+ #### getRankingValues(values, rankingGroupIndex)
3271
3243
 
3272
- Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
3244
+ Gets the Ranking values.
3273
3245
 
3274
3246
 
3275
3247
 
@@ -3278,7 +3250,8 @@ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggr
3278
3250
 
3279
3251
  | Name | Type | Description | |
3280
3252
  | ---- | ---- | ----------- | -------- |
3281
- | filterData | | The filter data object |   |
3253
+ | values | | a collection of filter values in the ranking structure |   |
3254
+ | rankingGroupIndex | | determine the value by this index to build and return it |   |
3282
3255
 
3283
3256
 
3284
3257
 
@@ -3286,26 +3259,17 @@ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggr
3286
3259
  ##### Returns
3287
3260
 
3288
3261
 
3289
- - The new filter data object that were get the aggregate filters
3262
+ - Expression values for ranking
3290
3263
 
3291
3264
 
3292
3265
 
3293
3266
 
3294
- ### dist/filters/helpers/common/getFiltersByParams.js
3267
+ ### dist/filters/helpers/backend/getLogicByScopes.js
3295
3268
 
3296
3269
 
3297
- #### getFiltersByParams(filterData, params)
3270
+ #### getLogicByScopes(logics, scopes)
3298
3271
 
3299
- Gets filters from the given params.
3300
- The validation to filter the stored filter is depending on:
3301
- - Column
3302
- - Qrvey ID
3303
- - Scope type
3304
- - Scope ID
3305
- - Panel ID
3306
- - Validator type
3307
- - Property type
3308
- - Enabled flags
3272
+ Gets the filters from logic data by Scopes/Scope IDs.
3309
3273
 
3310
3274
 
3311
3275
 
@@ -3314,8 +3278,8 @@ The validation to filter the stored filter is depending on:
3314
3278
 
3315
3279
  | Name | Type | Description | |
3316
3280
  | ---- | ---- | ----------- | -------- |
3317
- | filterData | | The Filter Data or the UI Filter Data |   |
3318
- | params | | given parameters to validate the dataset |   |
3281
+ | logics | | The logic array |   |
3282
+ | scopes | | The collection of Scopes/Scope IDs |   |
3319
3283
 
3320
3284
 
3321
3285
 
@@ -3323,17 +3287,17 @@ The validation to filter the stored filter is depending on:
3323
3287
  ##### Returns
3324
3288
 
3325
3289
 
3326
- - a new Filter object structure
3290
+ - a new Logic array
3327
3291
 
3328
3292
 
3329
3293
 
3330
3294
 
3331
- ### dist/filters/helpers/common/getFiltersByScopes.js
3295
+ ### dist/filters/helpers/backend/getLogicByScopesHierarchy.js
3332
3296
 
3333
3297
 
3334
- #### getFiltersByScopes(filterData, scopes)
3298
+ #### getLogicByScopesHierarchy(filterData, scopes, currentScope)
3335
3299
 
3336
- Filters and gets a Filter Data by the given scopes
3300
+ Gets filters from the logic by the scopes hierarchy.
3337
3301
 
3338
3302
 
3339
3303
 
@@ -3342,8 +3306,9 @@ Filters and gets a Filter Data by the given scopes
3342
3306
 
3343
3307
  | Name | Type | Description | |
3344
3308
  | ---- | ---- | ----------- | -------- |
3345
- | filterData | | The Filter Data |   |
3346
- | scopes | | collection of scopes types |   |
3309
+ | filterData | | |   |
3310
+ | scopes | | |   |
3311
+ | currentScope | | |   |
3347
3312
 
3348
3313
 
3349
3314
 
@@ -3351,17 +3316,17 @@ Filters and gets a Filter Data by the given scopes
3351
3316
  ##### Returns
3352
3317
 
3353
3318
 
3354
- - The new Filter Data
3319
+ - a new array of Logic
3355
3320
 
3356
3321
 
3357
3322
 
3358
3323
 
3359
- ### dist/filters/helpers/common/getFiltersByScopesIds.js
3324
+ ### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
3360
3325
 
3361
3326
 
3362
- #### getFiltersByScopesIds(filterData, scopes)
3327
+ #### getFilterBuilderGeneralConfig(config)
3363
3328
 
3364
- Gets filters from Filter Data by Scopes/Scope IDs.
3329
+ Returns a filter builder config object by a any given config
3365
3330
 
3366
3331
 
3367
3332
 
@@ -3370,8 +3335,7 @@ Gets filters from Filter Data by Scopes/Scope IDs.
3370
3335
 
3371
3336
  | Name | Type | Description | |
3372
3337
  | ---- | ---- | ----------- | -------- |
3373
- | filterData | | The filter data |   |
3374
- | scopes | | The collection of Scopes/Scope IDs |   |
3338
+ | config | | any config object |   |
3375
3339
 
3376
3340
 
3377
3341
 
@@ -3379,17 +3343,17 @@ Gets filters from Filter Data by Scopes/Scope IDs.
3379
3343
  ##### Returns
3380
3344
 
3381
3345
 
3382
- - a new Filter Data
3346
+ - The filter builder config object
3383
3347
 
3384
3348
 
3385
3349
 
3386
3350
 
3387
- ### dist/filters/helpers/common/getFiltersByVisibility.js
3351
+ ### dist/filters/helpers/common/areFiltersEquals.js
3388
3352
 
3389
3353
 
3390
- #### getFiltersByVisibility(filterData, scopes)
3354
+ #### areFiltersEquals(filter1, filter2)
3391
3355
 
3392
- Get a new Filter Data by filtering scopes/scope IDs and enabled flags
3356
+ Validates if both filters are the same
3393
3357
 
3394
3358
 
3395
3359
 
@@ -3398,8 +3362,8 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
3398
3362
 
3399
3363
  | Name | Type | Description | |
3400
3364
  | ---- | ---- | ----------- | -------- |
3401
- | filterData | | a Filter Data or UI Filter Data |   |
3402
- | scopes | | a Scopes/Scope IDs array |   |
3365
+ | filter1 | | filter 1 |   |
3366
+ | filter2 | | filter 2 |   |
3403
3367
 
3404
3368
 
3405
3369
 
@@ -3407,17 +3371,17 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
3407
3371
  ##### Returns
3408
3372
 
3409
3373
 
3410
- - a new Filter Data
3374
+ - true: the filters are equal; false: the filters are NOT equal
3411
3375
 
3412
3376
 
3413
3377
 
3414
3378
 
3415
- ### dist/filters/helpers/common/getMergeFiltersSettings.js
3379
+ ### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
3416
3380
 
3417
3381
 
3418
- #### getMergeFiltersSettings(settings)
3382
+ #### excludeFiltersByAggregateColumn(filterData)
3419
3383
 
3420
- Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
3384
+ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
3421
3385
 
3422
3386
 
3423
3387
 
@@ -3426,7 +3390,7 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
3426
3390
 
3427
3391
  | Name | Type | Description | |
3428
3392
  | ---- | ---- | ----------- | -------- |
3429
- | settings | | an object to the MergeFilters settings |   |
3393
+ | filterData | | The filter data object |   |
3430
3394
 
3431
3395
 
3432
3396
 
@@ -3434,17 +3398,26 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
3434
3398
  ##### Returns
3435
3399
 
3436
3400
 
3437
- - a new MergeFilters settings object.
3401
+ - The new filter data object that were excluded the aggregate filters
3438
3402
 
3439
3403
 
3440
3404
 
3441
3405
 
3442
- ### dist/filters/helpers/common/getParamsToGetFilterSettings.js
3406
+ ### dist/filters/helpers/common/excludeFiltersByParams.js
3443
3407
 
3444
3408
 
3445
- #### getParamsToGetFilterSettings(settings)
3409
+ #### excludeFiltersByParams(filterData, params)
3446
3410
 
3447
- Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
3411
+ Excludes filters from the given Filters.
3412
+ The validation to filter the stored filter is depending on:
3413
+ - Column
3414
+ - Qrvey ID
3415
+ - Scope type
3416
+ - Scope ID
3417
+ - Panel ID
3418
+ - Validator type
3419
+ - Property type
3420
+ - Enabled flags
3448
3421
 
3449
3422
 
3450
3423
 
@@ -3453,7 +3426,8 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
3453
3426
 
3454
3427
  | Name | Type | Description | |
3455
3428
  | ---- | ---- | ----------- | -------- |
3456
- | settings | | an object to the ParamsToGetFilter settings |   |
3429
+ | filterData | | The Filter Data or the UI Filter Data |   |
3430
+ | params | | given parameters to validate the filter data |   |
3457
3431
 
3458
3432
 
3459
3433
 
@@ -3461,17 +3435,17 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
3461
3435
  ##### Returns
3462
3436
 
3463
3437
 
3464
- - a new ParamsToGetFilter settings object.
3438
+ - a new Filter object structure
3465
3439
 
3466
3440
 
3467
3441
 
3468
3442
 
3469
- ### dist/filters/helpers/common/haveFiltersByDataset.js
3443
+ ### dist/filters/helpers/common/excludeFiltersByScopes.js
3470
3444
 
3471
3445
 
3472
- #### haveFiltersByDataset(filterData, qrveyid)
3446
+ #### excludeFiltersByScopes(filterData, scopes)
3473
3447
 
3474
- Validates if the filter data has filters by a dataset ID (Qrvey ID).
3448
+ Excludes and returns a filter data without filters by the given scopes
3475
3449
 
3476
3450
 
3477
3451
 
@@ -3480,8 +3454,8 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
3480
3454
 
3481
3455
  | Name | Type | Description | |
3482
3456
  | ---- | ---- | ----------- | -------- |
3483
- | filterData | | the filter data or the UI filter data. |   |
3484
- | qrveyid | | The Qrvey ID |   |
3457
+ | filterData | | The Filter Data |   |
3458
+ | scopes | | collection of scopes to be as filtering parameters |   |
3485
3459
 
3486
3460
 
3487
3461
 
@@ -3489,17 +3463,17 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
3489
3463
  ##### Returns
3490
3464
 
3491
3465
 
3492
- - true: the filter data has filters by the Qrvey ID
3466
+ - The new Filter Data without filters by the given scopes.
3493
3467
 
3494
3468
 
3495
3469
 
3496
3470
 
3497
- ### dist/filters/helpers/common/isBetweenValidator.js
3471
+ ### dist/filters/helpers/common/getFilterColumnLabel.js
3498
3472
 
3499
3473
 
3500
- #### isBetweenValidator(validator)
3474
+ #### getFilterColumnLabel(column)
3501
3475
 
3502
- Validates if the given validator is a Between type
3476
+ Get an string of the properties of the given filter column.
3503
3477
 
3504
3478
 
3505
3479
 
@@ -3508,7 +3482,7 @@ Validates if the given validator is a Between type
3508
3482
 
3509
3483
  | Name | Type | Description | |
3510
3484
  | ---- | ---- | ----------- | -------- |
3511
- | validator | | The validator |   |
3485
+ | column | | The filter column |   |
3512
3486
 
3513
3487
 
3514
3488
 
@@ -3516,17 +3490,17 @@ Validates if the given validator is a Between type
3516
3490
  ##### Returns
3517
3491
 
3518
3492
 
3519
- - true: it is a between validator; false: it is not a between validator
3493
+ - an string with the property, aggregate or calculation label.
3520
3494
 
3521
3495
 
3522
3496
 
3523
3497
 
3524
- ### dist/filters/helpers/common/isDateDistinctProperty.js
3498
+ ### dist/filters/helpers/common/getFilterLabel.js
3525
3499
 
3526
3500
 
3527
- #### isDateDistinctProperty(column, property)
3501
+ #### getFilterLabel(filter)
3528
3502
 
3529
- Determines if the filter column and property is a distinct group dates type
3503
+ Gets the Filter Label + Column label
3530
3504
 
3531
3505
 
3532
3506
 
@@ -3535,8 +3509,7 @@ Determines if the filter column and property is a distinct group dates type
3535
3509
 
3536
3510
  | Name | Type | Description | |
3537
3511
  | ---- | ---- | ----------- | -------- |
3538
- | column | | The filter column |   |
3539
- | property | | The filter property |   |
3512
+ | filter | | the UI filter |   |
3540
3513
 
3541
3514
 
3542
3515
 
@@ -3544,17 +3517,28 @@ Determines if the filter column and property is a distinct group dates type
3544
3517
  ##### Returns
3545
3518
 
3546
3519
 
3547
- - True if the given property is included from distinct group dates type
3520
+ - a sring label
3548
3521
 
3549
3522
 
3550
3523
 
3551
3524
 
3552
- ### dist/filters/helpers/common/isInValidator.js
3525
+ ### dist/filters/helpers/common/getFilterid.js
3553
3526
 
3554
3527
 
3555
- #### isInValidator(validator)
3528
+ #### getFilterid(filter)
3556
3529
 
3557
- Validates if the given validator is a In type
3530
+ Get the Filter ID by the filter structure
3531
+ The order of the epression ID is:
3532
+ - Scope Type
3533
+ - scopeid
3534
+ - qrveyid
3535
+ - panelid
3536
+ - columnid
3537
+ - validator
3538
+ - property
3539
+ - Column Aggregate
3540
+ - Column Calculation
3541
+ - Optional Index
3558
3542
 
3559
3543
 
3560
3544
 
@@ -3563,7 +3547,7 @@ Validates if the given validator is a In type
3563
3547
 
3564
3548
  | Name | Type | Description | |
3565
3549
  | ---- | ---- | ----------- | -------- |
3566
- | validator | | The validator |   |
3550
+ | filter | | the filter structure |   |
3567
3551
 
3568
3552
 
3569
3553
 
@@ -3571,17 +3555,17 @@ Validates if the given validator is a In type
3571
3555
  ##### Returns
3572
3556
 
3573
3557
 
3574
- - true: it is a In validator; false: it is not a In validator
3558
+ - a text to identify the filter
3575
3559
 
3576
3560
 
3577
3561
 
3578
3562
 
3579
- ### dist/filters/helpers/common/isNullValidator.js
3563
+ ### dist/filters/helpers/common/getFiltersByAggregateColumn.js
3580
3564
 
3581
3565
 
3582
- #### isNullValidator(validator)
3566
+ #### getFiltersByAggregateColumn(filterData)
3583
3567
 
3584
- Checks if the given validator is a Null type.
3568
+ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
3585
3569
 
3586
3570
 
3587
3571
 
@@ -3590,7 +3574,7 @@ Checks if the given validator is a Null type.
3590
3574
 
3591
3575
  | Name | Type | Description | |
3592
3576
  | ---- | ---- | ----------- | -------- |
3593
- | validator | | The Filter Validator |   |
3577
+ | filterData | | The filter data object |   |
3594
3578
 
3595
3579
 
3596
3580
 
@@ -3598,17 +3582,26 @@ Checks if the given validator is a Null type.
3598
3582
  ##### Returns
3599
3583
 
3600
3584
 
3601
- - True: It is a Null Validator; False: It is not a Null Validator.
3585
+ - The new filter data object that were get the aggregate filters
3602
3586
 
3603
3587
 
3604
3588
 
3605
3589
 
3606
- ### dist/filters/helpers/common/isRangeValidator.js
3590
+ ### dist/filters/helpers/common/getFiltersByParams.js
3607
3591
 
3608
3592
 
3609
- #### isRangeValidator(validator)
3593
+ #### getFiltersByParams(filterData, params)
3610
3594
 
3611
- Validates if the given validator is a Range type. Range type means the value has min and max values to filter
3595
+ Gets filters from the given params.
3596
+ The validation to filter the stored filter is depending on:
3597
+ - Column
3598
+ - Qrvey ID
3599
+ - Scope type
3600
+ - Scope ID
3601
+ - Panel ID
3602
+ - Validator type
3603
+ - Property type
3604
+ - Enabled flags
3612
3605
 
3613
3606
 
3614
3607
 
@@ -3617,7 +3610,8 @@ Validates if the given validator is a Range type. Range type means the value has
3617
3610
 
3618
3611
  | Name | Type | Description | |
3619
3612
  | ---- | ---- | ----------- | -------- |
3620
- | validator | | The filter validator |   |
3613
+ | filterData | | The Filter Data or the UI Filter Data |   |
3614
+ | params | | given parameters to validate the dataset |   |
3621
3615
 
3622
3616
 
3623
3617
 
@@ -3625,17 +3619,17 @@ Validates if the given validator is a Range type. Range type means the value has
3625
3619
  ##### Returns
3626
3620
 
3627
3621
 
3628
- - true: it is a range validator
3622
+ - a new Filter object structure
3629
3623
 
3630
3624
 
3631
3625
 
3632
3626
 
3633
- ### dist/filters/helpers/common/isRegularValidator.js
3627
+ ### dist/filters/helpers/common/getFiltersByScopes.js
3634
3628
 
3635
3629
 
3636
- #### isRegularValidator(validator)
3630
+ #### getFiltersByScopes(filterData, scopes)
3637
3631
 
3638
- Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
3632
+ Filters and gets a Filter Data by the given scopes
3639
3633
 
3640
3634
 
3641
3635
 
@@ -3644,7 +3638,8 @@ Validates if the given validator is a regular type. Regular type means the filte
3644
3638
 
3645
3639
  | Name | Type | Description | |
3646
3640
  | ---- | ---- | ----------- | -------- |
3647
- | validator | | The filter validator |   |
3641
+ | filterData | | The Filter Data |   |
3642
+ | scopes | | collection of scopes types |   |
3648
3643
 
3649
3644
 
3650
3645
 
@@ -3652,17 +3647,17 @@ Validates if the given validator is a regular type. Regular type means the filte
3652
3647
  ##### Returns
3653
3648
 
3654
3649
 
3655
- - true: it is a range validator
3650
+ - The new Filter Data
3656
3651
 
3657
3652
 
3658
3653
 
3659
3654
 
3660
- ### dist/filters/helpers/common/mergeFilters.js
3655
+ ### dist/filters/helpers/common/getFiltersByScopesIds.js
3661
3656
 
3662
3657
 
3663
- #### mergeFilters(filterData1, filterData2, overwriteValues)
3658
+ #### getFiltersByScopesIds(filterData, scopes)
3664
3659
 
3665
- Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
3660
+ Gets filters from Filter Data by Scopes/Scope IDs.
3666
3661
 
3667
3662
 
3668
3663
 
@@ -3671,9 +3666,8 @@ Merge filter data structures in a new one. The first Filter Data passed in the a
3671
3666
 
3672
3667
  | Name | Type | Description | |
3673
3668
  | ---- | ---- | ----------- | -------- |
3674
- | filterData1 | | The target filter data |   |
3675
- | filterData2 | | the filter data to be merged |   |
3676
- | overwriteValues | | Flag to overwrite or not the filter values |   |
3669
+ | filterData | | The filter data |   |
3670
+ | scopes | | The collection of Scopes/Scope IDs |   |
3677
3671
 
3678
3672
 
3679
3673
 
@@ -3681,13 +3675,17 @@ Merge filter data structures in a new one. The first Filter Data passed in the a
3681
3675
  ##### Returns
3682
3676
 
3683
3677
 
3684
- - a new filter data structure
3678
+ - a new Filter Data
3685
3679
 
3686
3680
 
3687
3681
 
3688
- #### mergeScopes(scopes1, scopes2, overwriteValues)
3689
3682
 
3690
- Gets a new scope structure array by merging two scope structures
3683
+ ### dist/filters/helpers/common/getFiltersByVisibility.js
3684
+
3685
+
3686
+ #### getFiltersByVisibility(filterData, scopes)
3687
+
3688
+ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
3691
3689
 
3692
3690
 
3693
3691
 
@@ -3696,9 +3694,8 @@ Gets a new scope structure array by merging two scope structures
3696
3694
 
3697
3695
  | Name | Type | Description | |
3698
3696
  | ---- | ---- | ----------- | -------- |
3699
- | scopes1 | | the target scope structure |   |
3700
- | scopes2 | | the scope to be merged |   |
3701
- | overwriteValues | | Flag to overwrite or not the filter values |   |
3697
+ | filterData | | a Filter Data or UI Filter Data |   |
3698
+ | scopes | | a Scopes/Scope IDs array |   |
3702
3699
 
3703
3700
 
3704
3701
 
@@ -3706,13 +3703,17 @@ Gets a new scope structure array by merging two scope structures
3706
3703
  ##### Returns
3707
3704
 
3708
3705
 
3709
- - a new scope structure array
3706
+ - a new Filter Data
3710
3707
 
3711
3708
 
3712
3709
 
3713
- #### mergeDatasets(datasets1, datasets2, overwriteValues)
3714
3710
 
3715
- Gets a new dataset structure array by merging two dataset structures
3711
+ ### dist/filters/helpers/common/getMergeFiltersSettings.js
3712
+
3713
+
3714
+ #### getMergeFiltersSettings(settings)
3715
+
3716
+ Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
3716
3717
 
3717
3718
 
3718
3719
 
@@ -3721,9 +3722,7 @@ Gets a new dataset structure array by merging two dataset structures
3721
3722
 
3722
3723
  | Name | Type | Description | |
3723
3724
  | ---- | ---- | ----------- | -------- |
3724
- | datasets1 | | the target dataset structure |   |
3725
- | datasets2 | | the dataset to be merged |   |
3726
- | overwriteValues | | Flag to overwrite or not the filter values |   |
3725
+ | settings | | an object to the MergeFilters settings |   |
3727
3726
 
3728
3727
 
3729
3728
 
@@ -3731,13 +3730,17 @@ Gets a new dataset structure array by merging two dataset structures
3731
3730
  ##### Returns
3732
3731
 
3733
3732
 
3734
- - a new dataset structure array
3733
+ - a new MergeFilters settings object.
3735
3734
 
3736
3735
 
3737
3736
 
3738
- #### mergeFilterss(filters1, filters2, overwriteValues)
3739
3737
 
3740
- Gets a new filter structure array by merging two filter structures
3738
+ ### dist/filters/helpers/common/getParamsToGetFilterSettings.js
3739
+
3740
+
3741
+ #### getParamsToGetFilterSettings(settings)
3742
+
3743
+ Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
3741
3744
 
3742
3745
 
3743
3746
 
@@ -3746,9 +3749,7 @@ Gets a new filter structure array by merging two filter structures
3746
3749
 
3747
3750
  | Name | Type | Description | |
3748
3751
  | ---- | ---- | ----------- | -------- |
3749
- | filters1 | | the target filter structure |   |
3750
- | filters2 | | the filter to be merged |   |
3751
- | overwriteValues | | Flag to overwrite or not the filter values |   |
3752
+ | settings | | an object to the ParamsToGetFilter settings |   |
3752
3753
 
3753
3754
 
3754
3755
 
@@ -3756,13 +3757,17 @@ Gets a new filter structure array by merging two filter structures
3756
3757
  ##### Returns
3757
3758
 
3758
3759
 
3759
- - a new filter structure array
3760
+ - a new ParamsToGetFilter settings object.
3760
3761
 
3761
3762
 
3762
3763
 
3763
- #### mergeValues(filter1, filter2, overwrite)
3764
3764
 
3765
- Gets a new value structure array by merging two value structures
3765
+ ### dist/filters/helpers/common/haveFiltersByDataset.js
3766
+
3767
+
3768
+ #### haveFiltersByDataset(filterData, qrveyid)
3769
+
3770
+ Validates if the filter data has filters by a dataset ID (Qrvey ID).
3766
3771
 
3767
3772
 
3768
3773
 
@@ -3771,9 +3776,8 @@ Gets a new value structure array by merging two value structures
3771
3776
 
3772
3777
  | Name | Type | Description | |
3773
3778
  | ---- | ---- | ----------- | -------- |
3774
- | filter1 | | the target filter structure |   |
3775
- | filter2 | | the filter to be used to merge the values |   |
3776
- | overwrite | | Flag to overwrite or not the filter values |   |
3779
+ | filterData | | the filter data or the UI filter data. |   |
3780
+ | qrveyid | | The Qrvey ID |   |
3777
3781
 
3778
3782
 
3779
3783
 
@@ -3781,17 +3785,17 @@ Gets a new value structure array by merging two value structures
3781
3785
  ##### Returns
3782
3786
 
3783
3787
 
3784
- - a new value structure array
3788
+ - true: the filter data has filters by the Qrvey ID
3785
3789
 
3786
3790
 
3787
3791
 
3788
3792
 
3789
- ### dist/filters/helpers/common/resolveDatasetConditions.js
3793
+ ### dist/filters/helpers/common/isBetweenValidator.js
3790
3794
 
3791
3795
 
3792
- #### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
3796
+ #### isBetweenValidator(validator)
3793
3797
 
3794
- Resolves the conditions by given params
3798
+ Validates if the given validator is a Between type
3795
3799
 
3796
3800
 
3797
3801
 
@@ -3800,10 +3804,7 @@ Resolves the conditions by given params
3800
3804
 
3801
3805
  | Name | Type | Description | |
3802
3806
  | ---- | ---- | ----------- | -------- |
3803
- | filter | | The dataset structure |   |
3804
- | params | | given parameters to validate the dataset |   |
3805
- | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined |   |
3806
- | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. |   |
3807
+ | validator | | The validator |   |
3807
3808
 
3808
3809
 
3809
3810
 
@@ -3811,17 +3812,17 @@ Resolves the conditions by given params
3811
3812
  ##### Returns
3812
3813
 
3813
3814
 
3814
- - true: the condition is satisfied
3815
+ - true: it is a between validator; false: it is not a between validator
3815
3816
 
3816
3817
 
3817
3818
 
3818
3819
 
3819
- ### dist/filters/helpers/common/resolveFilterConditions.js
3820
+ ### dist/filters/helpers/common/isDateDistinctProperty.js
3820
3821
 
3821
3822
 
3822
- #### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
3823
+ #### isDateDistinctProperty(column, property)
3823
3824
 
3824
- Resolves the conditions by given params
3825
+ Determines if the filter column and property is a distinct group dates type
3825
3826
 
3826
3827
 
3827
3828
 
@@ -3830,10 +3831,8 @@ Resolves the conditions by given params
3830
3831
 
3831
3832
  | Name | Type | Description | |
3832
3833
  | ---- | ---- | ----------- | -------- |
3833
- | filter | | The filter |   |
3834
- | params | | given parameters to validate the filter |   |
3835
- | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined |   |
3836
- | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. |   |
3834
+ | column | | The filter column |   |
3835
+ | property | | The filter property |   |
3837
3836
 
3838
3837
 
3839
3838
 
@@ -3841,17 +3840,17 @@ Resolves the conditions by given params
3841
3840
  ##### Returns
3842
3841
 
3843
3842
 
3844
- - true: the condition is satisfied
3843
+ - True if the given property is included from distinct group dates type
3845
3844
 
3846
3845
 
3847
3846
 
3848
3847
 
3849
- ### dist/filters/helpers/common/resolveScopeConditions.js
3848
+ ### dist/filters/helpers/common/isInValidator.js
3850
3849
 
3851
3850
 
3852
- #### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
3851
+ #### isInValidator(validator)
3853
3852
 
3854
- Resolves the conditions by given params
3853
+ Validates if the given validator is a In type
3855
3854
 
3856
3855
 
3857
3856
 
@@ -3860,10 +3859,7 @@ Resolves the conditions by given params
3860
3859
 
3861
3860
  | Name | Type | Description | |
3862
3861
  | ---- | ---- | ----------- | -------- |
3863
- | filter | | The filter scope structure |   |
3864
- | params | | given parameters to validate the filter |   |
3865
- | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined |   |
3866
- | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. |   |
3862
+ | validator | | The validator |   |
3867
3863
 
3868
3864
 
3869
3865
 
@@ -3871,18 +3867,17 @@ Resolves the conditions by given params
3871
3867
  ##### Returns
3872
3868
 
3873
3869
 
3874
- - true: the condition is satisfied
3870
+ - true: it is a In validator; false: it is not a In validator
3875
3871
 
3876
3872
 
3877
3873
 
3878
3874
 
3879
- ### dist/filters/helpers/backend/buildExpression.js
3875
+ ### dist/filters/helpers/common/isNullValidator.js
3880
3876
 
3881
3877
 
3882
- #### buildExpression(filter)
3878
+ #### isNullValidator(validator)
3883
3879
 
3884
- Builds filter expression by the filter data.
3885
- - If the resulting value array is empty the enabled property will be false.
3880
+ Checks if the given validator is a Null type.
3886
3881
 
3887
3882
 
3888
3883
 
@@ -3891,7 +3886,7 @@ Builds filter expression by the filter data.
3891
3886
 
3892
3887
  | Name | Type | Description | |
3893
3888
  | ---- | ---- | ----------- | -------- |
3894
- | filter | | The filter to transform |   |
3889
+ | validator | | The Filter Validator |   |
3895
3890
 
3896
3891
 
3897
3892
 
@@ -3899,17 +3894,17 @@ Builds filter expression by the filter data.
3899
3894
  ##### Returns
3900
3895
 
3901
3896
 
3902
- - a filter expression
3897
+ - True: It is a Null Validator; False: It is not a Null Validator.
3903
3898
 
3904
3899
 
3905
3900
 
3906
3901
 
3907
- ### dist/filters/helpers/backend/buildUserFilters.js
3902
+ ### dist/filters/helpers/common/isRangeValidator.js
3908
3903
 
3909
3904
 
3910
- #### buildUserFilters(userFilters)
3905
+ #### isRangeValidator(validator)
3911
3906
 
3912
- Transform user Filters array into Filter Logic structure
3907
+ Validates if the given validator is a Range type. Range type means the value has min and max values to filter
3913
3908
 
3914
3909
 
3915
3910
 
@@ -3918,7 +3913,7 @@ Transform user Filters array into Filter Logic structure
3918
3913
 
3919
3914
  | Name | Type | Description | |
3920
3915
  | ---- | ---- | ----------- | -------- |
3921
- | userFilters | | The filters that the user defined. |   |
3916
+ | validator | | The filter validator |   |
3922
3917
 
3923
3918
 
3924
3919
 
@@ -3926,17 +3921,17 @@ Transform user Filters array into Filter Logic structure
3926
3921
  ##### Returns
3927
3922
 
3928
3923
 
3929
- - The filter logic for the given user filters. if No a given object is recieved, it will return an empty array.
3930
-
3924
+ - true: it is a range validator
3931
3925
 
3932
3926
 
3933
3927
 
3934
- ### dist/filters/helpers/backend/getAggFiltersBySummaryIndex.js
3935
3928
 
3929
+ ### dist/filters/helpers/common/isRegularValidator.js
3936
3930
 
3937
- #### getAggFiltersBySummaryIndex(aggFilters, summaryIndex)
3938
3931
 
3932
+ #### isRegularValidator(validator)
3939
3933
 
3934
+ Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
3940
3935
 
3941
3936
 
3942
3937
 
@@ -3945,8 +3940,7 @@ Transform user Filters array into Filter Logic structure
3945
3940
 
3946
3941
  | Name | Type | Description | |
3947
3942
  | ---- | ---- | ----------- | -------- |
3948
- | aggFilters | | |   |
3949
- | summaryIndex | | |   |
3943
+ | validator | | The filter validator |   |
3950
3944
 
3951
3945
 
3952
3946
 
@@ -3954,17 +3948,17 @@ Transform user Filters array into Filter Logic structure
3954
3948
  ##### Returns
3955
3949
 
3956
3950
 
3957
- -
3951
+ - true: it is a range validator
3958
3952
 
3959
3953
 
3960
3954
 
3961
3955
 
3962
- ### dist/filters/helpers/backend/getBackendGroupValue.js
3956
+ ### dist/filters/helpers/common/mergeFilters.js
3963
3957
 
3964
3958
 
3965
- #### getBackendGroupValue(filter)
3959
+ #### mergeFilters(filterData1, filterData2, overwriteValues)
3966
3960
 
3967
- Gets a group value for the backend logic structure
3961
+ Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
3968
3962
 
3969
3963
 
3970
3964
 
@@ -3973,7 +3967,9 @@ Gets a group value for the backend logic structure
3973
3967
 
3974
3968
  | Name | Type | Description | |
3975
3969
  | ---- | ---- | ----------- | -------- |
3976
- | filter | | The filter |   |
3970
+ | filterData1 | | The target filter data |   |
3971
+ | filterData2 | | the filter data to be merged |   |
3972
+ | overwriteValues | | Flag to overwrite or not the filter values |   |
3977
3973
 
3978
3974
 
3979
3975
 
@@ -3981,17 +3977,13 @@ Gets a group value for the backend logic structure
3981
3977
  ##### Returns
3982
3978
 
3983
3979
 
3984
- - a property
3985
-
3986
-
3987
-
3980
+ - a new filter data structure
3988
3981
 
3989
- ### dist/filters/helpers/backend/getBackendProperty.js
3990
3982
 
3991
3983
 
3992
- #### getBackendProperty(filter)
3984
+ #### mergeScopes(scopes1, scopes2, overwriteValues)
3993
3985
 
3994
- Gets a property for the logic structure
3986
+ Gets a new scope structure array by merging two scope structures
3995
3987
 
3996
3988
 
3997
3989
 
@@ -4000,7 +3992,9 @@ Gets a property for the logic structure
4000
3992
 
4001
3993
  | Name | Type | Description | |
4002
3994
  | ---- | ---- | ----------- | -------- |
4003
- | filter | | The filter |   |
3995
+ | scopes1 | | the target scope structure |   |
3996
+ | scopes2 | | the scope to be merged |   |
3997
+ | overwriteValues | | Flag to overwrite or not the filter values |   |
4004
3998
 
4005
3999
 
4006
4000
 
@@ -4008,17 +4002,13 @@ Gets a property for the logic structure
4008
4002
  ##### Returns
4009
4003
 
4010
4004
 
4011
- - a property
4012
-
4013
-
4014
-
4005
+ - a new scope structure array
4015
4006
 
4016
- ### dist/filters/helpers/backend/getBackendValidator.js
4017
4007
 
4018
4008
 
4019
- #### getBackendValidator(validator)
4009
+ #### mergeDatasets(datasets1, datasets2, overwriteValues)
4020
4010
 
4021
- Gets the Validator that is used in requests
4011
+ Gets a new dataset structure array by merging two dataset structures
4022
4012
 
4023
4013
 
4024
4014
 
@@ -4027,7 +4017,9 @@ Gets the Validator that is used in requests
4027
4017
 
4028
4018
  | Name | Type | Description | |
4029
4019
  | ---- | ---- | ----------- | -------- |
4030
- | validator | | Filter Validator used in UI |   |
4020
+ | datasets1 | | the target dataset structure |   |
4021
+ | datasets2 | | the dataset to be merged |   |
4022
+ | overwriteValues | | Flag to overwrite or not the filter values |   |
4031
4023
 
4032
4024
 
4033
4025
 
@@ -4035,17 +4027,13 @@ Gets the Validator that is used in requests
4035
4027
  ##### Returns
4036
4028
 
4037
4029
 
4038
- - Filter Validator used in Backend
4039
-
4040
-
4041
-
4030
+ - a new dataset structure array
4042
4031
 
4043
- ### dist/filters/helpers/backend/getBackendValues.js
4044
4032
 
4045
4033
 
4046
- #### getBackendValues(filter)
4034
+ #### mergeFilterss(filters1, filters2, overwriteValues)
4047
4035
 
4048
- Gets the expresion values in the logic format
4036
+ Gets a new filter structure array by merging two filter structures
4049
4037
 
4050
4038
 
4051
4039
 
@@ -4054,7 +4042,9 @@ Gets the expresion values in the logic format
4054
4042
 
4055
4043
  | Name | Type | Description | |
4056
4044
  | ---- | ---- | ----------- | -------- |
4057
- | filter | | The filter structure |   |
4045
+ | filters1 | | the target filter structure |   |
4046
+ | filters2 | | the filter to be merged |   |
4047
+ | overwriteValues | | Flag to overwrite or not the filter values |   |
4058
4048
 
4059
4049
 
4060
4050
 
@@ -4062,13 +4052,13 @@ Gets the expresion values in the logic format
4062
4052
  ##### Returns
4063
4053
 
4064
4054
 
4065
- - A collection of backend expression value
4055
+ - a new filter structure array
4066
4056
 
4067
4057
 
4068
4058
 
4069
- #### getResultValues(values, filter)
4059
+ #### mergeValues(filter1, filter2, overwrite)
4070
4060
 
4071
- Gets the expression values. Depending on the column type
4061
+ Gets a new value structure array by merging two value structures
4072
4062
 
4073
4063
 
4074
4064
 
@@ -4077,8 +4067,9 @@ Gets the expression values. Depending on the column type
4077
4067
 
4078
4068
  | Name | Type | Description | |
4079
4069
  | ---- | ---- | ----------- | -------- |
4080
- | values | | a collection of filter values |   |
4081
- | filter | | The filter structure |   |
4070
+ | filter1 | | the target filter structure |   |
4071
+ | filter2 | | the filter to be used to merge the values |   |
4072
+ | overwrite | | Flag to overwrite or not the filter values |   |
4082
4073
 
4083
4074
 
4084
4075
 
@@ -4086,13 +4077,17 @@ Gets the expression values. Depending on the column type
4086
4077
  ##### Returns
4087
4078
 
4088
4079
 
4089
- -
4080
+ - a new value structure array
4090
4081
 
4091
4082
 
4092
4083
 
4093
- #### getRankingValues(values, rankingGroupIndex)
4094
4084
 
4095
- Gets the Ranking values.
4085
+ ### dist/filters/helpers/common/resolveDatasetConditions.js
4086
+
4087
+
4088
+ #### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
4089
+
4090
+ Resolves the conditions by given params
4096
4091
 
4097
4092
 
4098
4093
 
@@ -4101,8 +4096,10 @@ Gets the Ranking values.
4101
4096
 
4102
4097
  | Name | Type | Description | |
4103
4098
  | ---- | ---- | ----------- | -------- |
4104
- | values | | a collection of filter values in the ranking structure |   |
4105
- | rankingGroupIndex | | determine the value by this index to build and return it |   |
4099
+ | filter | | The dataset structure |   |
4100
+ | params | | given parameters to validate the dataset |   |
4101
+ | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined |   |
4102
+ | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. |   |
4106
4103
 
4107
4104
 
4108
4105
 
@@ -4110,17 +4107,17 @@ Gets the Ranking values.
4110
4107
  ##### Returns
4111
4108
 
4112
4109
 
4113
- - Expression values for ranking
4110
+ - true: the condition is satisfied
4114
4111
 
4115
4112
 
4116
4113
 
4117
4114
 
4118
- ### dist/filters/helpers/backend/getLogicByScopes.js
4115
+ ### dist/filters/helpers/common/resolveFilterConditions.js
4119
4116
 
4120
4117
 
4121
- #### getLogicByScopes(logics, scopes)
4118
+ #### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
4122
4119
 
4123
- Gets the filters from logic data by Scopes/Scope IDs.
4120
+ Resolves the conditions by given params
4124
4121
 
4125
4122
 
4126
4123
 
@@ -4129,8 +4126,10 @@ Gets the filters from logic data by Scopes/Scope IDs.
4129
4126
 
4130
4127
  | Name | Type | Description | |
4131
4128
  | ---- | ---- | ----------- | -------- |
4132
- | logics | | The logic array |   |
4133
- | scopes | | The collection of Scopes/Scope IDs |   |
4129
+ | filter | | The filter |   |
4130
+ | params | | given parameters to validate the filter |   |
4131
+ | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined |   |
4132
+ | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. |   |
4134
4133
 
4135
4134
 
4136
4135
 
@@ -4138,17 +4137,17 @@ Gets the filters from logic data by Scopes/Scope IDs.
4138
4137
  ##### Returns
4139
4138
 
4140
4139
 
4141
- - a new Logic array
4140
+ - true: the condition is satisfied
4142
4141
 
4143
4142
 
4144
4143
 
4145
4144
 
4146
- ### dist/filters/helpers/backend/getLogicByScopesHierarchy.js
4145
+ ### dist/filters/helpers/common/resolveScopeConditions.js
4147
4146
 
4148
4147
 
4149
- #### getLogicByScopesHierarchy(filterData, scopes, currentScope)
4148
+ #### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
4150
4149
 
4151
- Gets filters from the logic by the scopes hierarchy.
4150
+ Resolves the conditions by given params
4152
4151
 
4153
4152
 
4154
4153
 
@@ -4157,9 +4156,10 @@ Gets filters from the logic by the scopes hierarchy.
4157
4156
 
4158
4157
  | Name | Type | Description | |
4159
4158
  | ---- | ---- | ----------- | -------- |
4160
- | filterData | | |   |
4161
- | scopes | | |   |
4162
- | currentScope | | |   |
4159
+ | filter | | The filter scope structure |   |
4160
+ | params | | given parameters to validate the filter |   |
4161
+ | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined |   |
4162
+ | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. |   |
4163
4163
 
4164
4164
 
4165
4165
 
@@ -4167,17 +4167,17 @@ Gets filters from the logic by the scopes hierarchy.
4167
4167
  ##### Returns
4168
4168
 
4169
4169
 
4170
- - a new array of Logic
4170
+ - true: the condition is satisfied
4171
4171
 
4172
4172
 
4173
4173
 
4174
4174
 
4175
- ### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
4175
+ ### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
4176
4176
 
4177
4177
 
4178
- #### excludeUIFlatFiltersByScopes(uFilters, scopes)
4178
+ #### excludeUIFiltersByAggregate(uFilters)
4179
4179
 
4180
- Excludes and returns a UI Flat Filters without filters by the given scopes
4180
+ Excludes Aggregate Filters in the Flattened UI Filters array
4181
4181
 
4182
4182
 
4183
4183
 
@@ -4186,8 +4186,7 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
4186
4186
 
4187
4187
  | Name | Type | Description | |
4188
4188
  | ---- | ---- | ----------- | -------- |
4189
- | uFilters | | The Flatten UI Filters |   |
4190
- | scopes | | collection of scopes types |   |
4189
+ | uFilters | | Collection of Flat UI Filters |   |
4191
4190
 
4192
4191
 
4193
4192
 
@@ -4195,17 +4194,17 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
4195
4194
  ##### Returns
4196
4195
 
4197
4196
 
4198
- - The new array of UI Flattened filters
4197
+ - a new Flat UI Filters that were excluded the aggregate filters
4199
4198
 
4200
4199
 
4201
4200
 
4202
4201
 
4203
- ### dist/filters/helpers/ui/excludeUIFiltersByAggregate.js
4202
+ ### dist/filters/helpers/ui/excludeUIFlatFiltersByScopes.js
4204
4203
 
4205
4204
 
4206
- #### excludeUIFiltersByAggregate(uFilters)
4205
+ #### excludeUIFlatFiltersByScopes(uFilters, scopes)
4207
4206
 
4208
- Excludes Aggregate Filters in the Flattened UI Filters array
4207
+ Excludes and returns a UI Flat Filters without filters by the given scopes
4209
4208
 
4210
4209
 
4211
4210
 
@@ -4214,7 +4213,8 @@ Excludes Aggregate Filters in the Flattened UI Filters array
4214
4213
 
4215
4214
  | Name | Type | Description | |
4216
4215
  | ---- | ---- | ----------- | -------- |
4217
- | uFilters | | Collection of Flat UI Filters |   |
4216
+ | uFilters | | The Flatten UI Filters |   |
4217
+ | scopes | | collection of scopes types |   |
4218
4218
 
4219
4219
 
4220
4220
 
@@ -4222,7 +4222,7 @@ Excludes Aggregate Filters in the Flattened UI Filters array
4222
4222
  ##### Returns
4223
4223
 
4224
4224
 
4225
- - a new Flat UI Filters that were excluded the aggregate filters
4225
+ - The new array of UI Flattened filters
4226
4226
 
4227
4227
 
4228
4228