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