@sisense/sdk-data 1.23.0 → 1.25.0
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/dist/cjs/dimensional-model/filter-relations.d.ts +9 -0
- package/dist/cjs/dimensional-model/filter-relations.js +18 -0
- package/dist/cjs/dimensional-model/filters/factory.d.ts +84 -85
- package/dist/cjs/dimensional-model/filters/factory.js +126 -127
- package/dist/cjs/dimensional-model/filters/filter-config-utils.d.ts +25 -0
- package/dist/cjs/dimensional-model/filters/filter-config-utils.js +49 -0
- package/dist/cjs/dimensional-model/filters/filters.d.ts +28 -51
- package/dist/cjs/dimensional-model/filters/filters.js +51 -95
- package/dist/cjs/dimensional-model/filters/utils/condition-filter-util.d.ts +4 -4
- package/dist/cjs/dimensional-model/filters/utils/condition-filter-util.js +35 -28
- package/dist/cjs/dimensional-model/filters/utils/filter-code-util.d.ts +9 -5
- package/dist/cjs/dimensional-model/filters/utils/filter-code-util.js +32 -8
- package/dist/cjs/dimensional-model/filters/utils/filter-from-jaql-util.d.ts +17 -27
- package/dist/cjs/dimensional-model/filters/utils/filter-from-jaql-util.js +37 -39
- package/dist/cjs/dimensional-model/interfaces.d.ts +113 -15
- package/dist/cjs/dimensional-model/types.d.ts +18 -11
- package/dist/cjs/index.d.ts +2 -0
- package/dist/cjs/index.js +2 -0
- package/dist/cjs/interfaces.d.ts +8 -0
- package/dist/cjs/utils.d.ts +5 -3
- package/dist/cjs/utils.js +35 -9
- package/dist/dimensional-model/filter-relations.d.ts +9 -0
- package/dist/dimensional-model/filter-relations.js +14 -0
- package/dist/dimensional-model/filters/factory.d.ts +84 -85
- package/dist/dimensional-model/filters/factory.js +126 -127
- package/dist/dimensional-model/filters/filter-config-utils.d.ts +25 -0
- package/dist/dimensional-model/filters/filter-config-utils.js +39 -0
- package/dist/dimensional-model/filters/filters.d.ts +28 -51
- package/dist/dimensional-model/filters/filters.js +51 -95
- package/dist/dimensional-model/filters/utils/condition-filter-util.d.ts +4 -4
- package/dist/dimensional-model/filters/utils/condition-filter-util.js +35 -28
- package/dist/dimensional-model/filters/utils/filter-code-util.d.ts +9 -5
- package/dist/dimensional-model/filters/utils/filter-code-util.js +32 -8
- package/dist/dimensional-model/filters/utils/filter-from-jaql-util.d.ts +17 -27
- package/dist/dimensional-model/filters/utils/filter-from-jaql-util.js +36 -37
- package/dist/dimensional-model/interfaces.d.ts +113 -15
- package/dist/dimensional-model/types.d.ts +18 -11
- package/dist/index.d.ts +2 -0
- package/dist/index.js +2 -0
- package/dist/interfaces.d.ts +8 -0
- package/dist/tsconfig.prod.cjs.tsbuildinfo +1 -1
- package/dist/utils.d.ts +5 -3
- package/dist/utils.js +33 -7
- package/package.json +3 -3
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { DateDimension, LevelAttribute, Attribute, Measure, Filter, BaseMeasure, FilterRelationsNode, FilterRelations } from '../interfaces.js';
|
|
1
|
+
import { DateDimension, LevelAttribute, Attribute, Measure, Filter, BaseMeasure, FilterRelationsNode, FilterRelations, MembersFilterConfig, BaseFilterConfig } from '../interfaces.js';
|
|
2
2
|
/**
|
|
3
3
|
* Creates a filter representing the union of multiple filters on the same attribute. The resulting
|
|
4
4
|
* union filter filters on items that match any of the given filters.
|
|
@@ -15,10 +15,10 @@ import { DateDimension, LevelAttribute, Attribute, Measure, Filter, BaseMeasure,
|
|
|
15
15
|
* ])
|
|
16
16
|
* ```
|
|
17
17
|
* @param filters - Filters to union. The filters must all be on the same attribute.
|
|
18
|
-
* @param
|
|
18
|
+
* @param config - Optional configuration for the filter
|
|
19
19
|
* @returns A filter instance
|
|
20
20
|
*/
|
|
21
|
-
export declare function union(filters: Filter[],
|
|
21
|
+
export declare function union(filters: Filter[], config?: BaseFilterConfig): Filter;
|
|
22
22
|
/**
|
|
23
23
|
* Creates a filter representing the intersection of multiple filters on the same attribute. The resulting
|
|
24
24
|
* intersection filter filters on items that match all of the given filters.
|
|
@@ -35,10 +35,10 @@ export declare function union(filters: Filter[], guid?: string): Filter;
|
|
|
35
35
|
* ])
|
|
36
36
|
* ```
|
|
37
37
|
* @param filters - Filters to intersect. The filters must all be on the same attribute.
|
|
38
|
-
* @param
|
|
38
|
+
* @param config - Optional configuration for the filter
|
|
39
39
|
* @returns A filter instance
|
|
40
40
|
*/
|
|
41
|
-
export declare function intersection(filters: Filter[],
|
|
41
|
+
export declare function intersection(filters: Filter[], config?: BaseFilterConfig): Filter;
|
|
42
42
|
/**
|
|
43
43
|
* Creates a filter that excludes items matching the given filter
|
|
44
44
|
* from all items or from items matching the optional input filter.
|
|
@@ -61,11 +61,11 @@ export declare function intersection(filters: Filter[], guid?: string): Filter;
|
|
|
61
61
|
* ```
|
|
62
62
|
* @param filter - Filter to exclude
|
|
63
63
|
* @param input - Input filter to exclude from, on the same attribute. If not provided, the filter excludes from all items.
|
|
64
|
-
* @param
|
|
64
|
+
* @param config - Optional configuration for the filter
|
|
65
65
|
* @returns A filter representing an exclusion of the given filter
|
|
66
66
|
* from all attribute members or from the optional input filter
|
|
67
67
|
*/
|
|
68
|
-
export declare function exclude(filter: Filter, input?: Filter,
|
|
68
|
+
export declare function exclude(filter: Filter, input?: Filter, config?: BaseFilterConfig): Filter;
|
|
69
69
|
/**
|
|
70
70
|
* Creates a filter to isolate attribute values that do not contain a specified string.
|
|
71
71
|
*
|
|
@@ -82,10 +82,10 @@ export declare function exclude(filter: Filter, input?: Filter, guid?: string):
|
|
|
82
82
|
* ```
|
|
83
83
|
* @param attribute - Text attribute to filter on
|
|
84
84
|
* @param value - Value to filter by
|
|
85
|
-
* @param
|
|
85
|
+
* @param config - Optional configuration for the filter
|
|
86
86
|
* @returns A filter instance
|
|
87
87
|
*/
|
|
88
|
-
export declare function doesntContain(attribute: Attribute, value: string,
|
|
88
|
+
export declare function doesntContain(attribute: Attribute, value: string, config?: BaseFilterConfig): Filter;
|
|
89
89
|
/**
|
|
90
90
|
* Creates a filter to isolate attribute values that do not end with a specified string.
|
|
91
91
|
*
|
|
@@ -102,10 +102,10 @@ export declare function doesntContain(attribute: Attribute, value: string, guid?
|
|
|
102
102
|
* ```
|
|
103
103
|
* @param attribute - Text attribute to filter on
|
|
104
104
|
* @param value - Value to filter by
|
|
105
|
-
* @param
|
|
105
|
+
* @param config - Optional configuration for the filter
|
|
106
106
|
* @returns A filter instance
|
|
107
107
|
*/
|
|
108
|
-
export declare function doesntEndWith(attribute: Attribute, value: string,
|
|
108
|
+
export declare function doesntEndWith(attribute: Attribute, value: string, config?: BaseFilterConfig): Filter;
|
|
109
109
|
/**
|
|
110
110
|
* Creates a filter to isolate attribute values that do not start with a specified string.
|
|
111
111
|
*
|
|
@@ -122,10 +122,10 @@ export declare function doesntEndWith(attribute: Attribute, value: string, guid?
|
|
|
122
122
|
* ```
|
|
123
123
|
* @param attribute - Text attribute to filter on
|
|
124
124
|
* @param value - Value to filter by
|
|
125
|
-
* @param
|
|
125
|
+
* @param config - Optional configuration for the filter
|
|
126
126
|
* @returns A filter instance
|
|
127
127
|
*/
|
|
128
|
-
export declare function doesntStartWith(attribute: Attribute, value: string,
|
|
128
|
+
export declare function doesntStartWith(attribute: Attribute, value: string, config?: BaseFilterConfig): Filter;
|
|
129
129
|
/**
|
|
130
130
|
* Creates a filter to isolate attribute values that contain a specified string.
|
|
131
131
|
*
|
|
@@ -142,10 +142,10 @@ export declare function doesntStartWith(attribute: Attribute, value: string, gui
|
|
|
142
142
|
* ```
|
|
143
143
|
* @param attribute - Text attribute to filter on
|
|
144
144
|
* @param value - Value to filter by
|
|
145
|
-
* @param
|
|
145
|
+
* @param config - Optional configuration for the filter
|
|
146
146
|
* @returns A filter instance
|
|
147
147
|
*/
|
|
148
|
-
export declare function contains(attribute: Attribute, value: string,
|
|
148
|
+
export declare function contains(attribute: Attribute, value: string, config?: BaseFilterConfig): Filter;
|
|
149
149
|
/**
|
|
150
150
|
* Creates a filter to isolate attribute values that end with a specified string.
|
|
151
151
|
*
|
|
@@ -162,10 +162,10 @@ export declare function contains(attribute: Attribute, value: string, guid?: str
|
|
|
162
162
|
* ```
|
|
163
163
|
* @param attribute - Text attribute to filter on
|
|
164
164
|
* @param value - Value to filter by
|
|
165
|
-
* @param
|
|
165
|
+
* @param config - Optional configuration for the filter
|
|
166
166
|
* @returns A filter instance
|
|
167
167
|
*/
|
|
168
|
-
export declare function endsWith(attribute: Attribute, value: string,
|
|
168
|
+
export declare function endsWith(attribute: Attribute, value: string, config?: BaseFilterConfig): Filter;
|
|
169
169
|
/**
|
|
170
170
|
* Creates a filter to isolate attribute values that start with a specified string.
|
|
171
171
|
*
|
|
@@ -182,10 +182,10 @@ export declare function endsWith(attribute: Attribute, value: string, guid?: str
|
|
|
182
182
|
* ```
|
|
183
183
|
* @param attribute - Text attribute to filter on
|
|
184
184
|
* @param value - Value to filter by
|
|
185
|
-
* @param
|
|
185
|
+
* @param config - Optional configuration for the filter
|
|
186
186
|
* @returns A filter instance
|
|
187
187
|
*/
|
|
188
|
-
export declare function startsWith(attribute: Attribute, value: string,
|
|
188
|
+
export declare function startsWith(attribute: Attribute, value: string, config?: BaseFilterConfig): Filter;
|
|
189
189
|
/**
|
|
190
190
|
* Creates a filter to isolate attribute values that match a specified string pattern.
|
|
191
191
|
*
|
|
@@ -207,10 +207,10 @@ export declare function startsWith(attribute: Attribute, value: string, guid?: s
|
|
|
207
207
|
* ```
|
|
208
208
|
* @param attribute - Text attribute to filter on
|
|
209
209
|
* @param value - Value to filter by
|
|
210
|
-
* @param
|
|
210
|
+
* @param config - Optional configuration for the filter
|
|
211
211
|
* @returns A filter instance
|
|
212
212
|
*/
|
|
213
|
-
export declare function like(attribute: Attribute, value: string,
|
|
213
|
+
export declare function like(attribute: Attribute, value: string, config?: BaseFilterConfig): Filter;
|
|
214
214
|
/**
|
|
215
215
|
* Creates a filter to isolate attribute values that do not equal a specified string or number.
|
|
216
216
|
*
|
|
@@ -227,9 +227,10 @@ export declare function like(attribute: Attribute, value: string, guid?: string)
|
|
|
227
227
|
* ```
|
|
228
228
|
* @param attribute - Text or numeric attribute to filter on
|
|
229
229
|
* @param value - Value to filter by
|
|
230
|
+
* @param config - Optional configuration for the filter
|
|
230
231
|
* @returns A filter instance
|
|
231
232
|
*/
|
|
232
|
-
export declare function doesntEqual(attribute: Attribute, value: string | number,
|
|
233
|
+
export declare function doesntEqual(attribute: Attribute, value: string | number, config?: BaseFilterConfig): Filter;
|
|
233
234
|
/**
|
|
234
235
|
* Creates a filter to isolate attribute values that equal a specified string or number.
|
|
235
236
|
*
|
|
@@ -246,10 +247,10 @@ export declare function doesntEqual(attribute: Attribute, value: string | number
|
|
|
246
247
|
* ```
|
|
247
248
|
* @param attribute - Text or numeric attribute to filter on
|
|
248
249
|
* @param value - Value to filter by
|
|
249
|
-
* @param
|
|
250
|
+
* @param config - Optional configuration for the filter
|
|
250
251
|
* @returns A filter instance
|
|
251
252
|
*/
|
|
252
|
-
export declare function equals(attribute: Attribute, value: string | number,
|
|
253
|
+
export declare function equals(attribute: Attribute, value: string | number, config?: BaseFilterConfig): Filter;
|
|
253
254
|
/**
|
|
254
255
|
* Creates a filter to isolate attribute values strictly greater than a specified number.
|
|
255
256
|
*
|
|
@@ -260,10 +261,10 @@ export declare function equals(attribute: Attribute, value: string | number, gui
|
|
|
260
261
|
* ```
|
|
261
262
|
* @param attribute - Numeric attribute to filter on
|
|
262
263
|
* @param value - Value to filter by
|
|
263
|
-
* @param
|
|
264
|
+
* @param config - Optional configuration for the filter
|
|
264
265
|
* @returns A filter instance
|
|
265
266
|
*/
|
|
266
|
-
export declare function greaterThan(attribute: Attribute, value: number,
|
|
267
|
+
export declare function greaterThan(attribute: Attribute, value: number, config?: BaseFilterConfig): Filter;
|
|
267
268
|
/**
|
|
268
269
|
* Creates a filter to isolate attribute values greater than or equal to a specified number.
|
|
269
270
|
*
|
|
@@ -274,10 +275,10 @@ export declare function greaterThan(attribute: Attribute, value: number, guid?:
|
|
|
274
275
|
* ```
|
|
275
276
|
* @param attribute - Numeric attribute to filter on
|
|
276
277
|
* @param value - Value to filter by
|
|
277
|
-
* @param
|
|
278
|
+
* @param config - Optional configuration for the filter
|
|
278
279
|
* @returns A filter instance
|
|
279
280
|
*/
|
|
280
|
-
export declare function greaterThanOrEqual(attribute: Attribute, value: number,
|
|
281
|
+
export declare function greaterThanOrEqual(attribute: Attribute, value: number, config?: BaseFilterConfig): Filter;
|
|
281
282
|
/**
|
|
282
283
|
* Creates a filter to isolate attribute values strictly less than a specified number.
|
|
283
284
|
*
|
|
@@ -288,10 +289,10 @@ export declare function greaterThanOrEqual(attribute: Attribute, value: number,
|
|
|
288
289
|
* ```
|
|
289
290
|
* @param attribute - Numeric attribute to filter on
|
|
290
291
|
* @param value - Value to filter by
|
|
291
|
-
* @param
|
|
292
|
+
* @param config - Optional configuration for the filter
|
|
292
293
|
* @returns A filter instance
|
|
293
294
|
*/
|
|
294
|
-
export declare function lessThan(attribute: Attribute, value: number,
|
|
295
|
+
export declare function lessThan(attribute: Attribute, value: number, config?: BaseFilterConfig): Filter;
|
|
295
296
|
/**
|
|
296
297
|
* Creates a filter to isolate attribute values less than or equal to a specified number.
|
|
297
298
|
*
|
|
@@ -302,10 +303,10 @@ export declare function lessThan(attribute: Attribute, value: number, guid?: str
|
|
|
302
303
|
* ```
|
|
303
304
|
* @param attribute - Numeric attribute to filter on
|
|
304
305
|
* @param value - Value to filter by
|
|
305
|
-
* @param
|
|
306
|
+
* @param config - Optional configuration for the filter
|
|
306
307
|
* @returns A filter instance
|
|
307
308
|
*/
|
|
308
|
-
export declare function lessThanOrEqual(attribute: Attribute, value: number,
|
|
309
|
+
export declare function lessThanOrEqual(attribute: Attribute, value: number, config?: BaseFilterConfig): Filter;
|
|
309
310
|
/**
|
|
310
311
|
* Creates a filter to isolate attribute values within or exactly matching two specified numerical boundaries.
|
|
311
312
|
*
|
|
@@ -317,10 +318,10 @@ export declare function lessThanOrEqual(attribute: Attribute, value: number, gui
|
|
|
317
318
|
* @param attribute - Numeric attribute to filter on
|
|
318
319
|
* @param valueA - Value to filter from
|
|
319
320
|
* @param valueB - Value to filter to
|
|
320
|
-
* @param
|
|
321
|
+
* @param config - Optional configuration for the filter
|
|
321
322
|
* @returns A filter instance
|
|
322
323
|
*/
|
|
323
|
-
export declare function between(attribute: Attribute, valueA: number, valueB: number,
|
|
324
|
+
export declare function between(attribute: Attribute, valueA: number, valueB: number, config?: BaseFilterConfig): Filter;
|
|
324
325
|
/**
|
|
325
326
|
* Creates a filter that isolates attribute values strictly within two specified numerical boundaries.
|
|
326
327
|
*
|
|
@@ -332,10 +333,10 @@ export declare function between(attribute: Attribute, valueA: number, valueB: nu
|
|
|
332
333
|
* @param attribute - Numeric attribute to filter on
|
|
333
334
|
* @param valueA - Value to filter from
|
|
334
335
|
* @param valueB - Value to filter to
|
|
335
|
-
* @param
|
|
336
|
+
* @param config - Optional configuration for the filter
|
|
336
337
|
* @returns A filter instance
|
|
337
338
|
*/
|
|
338
|
-
export declare function betweenNotEqual(attribute: Attribute, valueA: number, valueB: number,
|
|
339
|
+
export declare function betweenNotEqual(attribute: Attribute, valueA: number, valueB: number, config?: BaseFilterConfig): Filter;
|
|
339
340
|
/**
|
|
340
341
|
* Creates a custom numeric filter that filters for given attribute values.
|
|
341
342
|
*
|
|
@@ -356,10 +357,10 @@ export declare function betweenNotEqual(attribute: Attribute, valueA: number, va
|
|
|
356
357
|
* @param valueA - First value
|
|
357
358
|
* @param operatorB - Second operator
|
|
358
359
|
* @param valueB - Second value
|
|
359
|
-
* @param
|
|
360
|
+
* @param config - Optional configuration for the filter
|
|
360
361
|
* @returns A custom numeric filter of the given attribute
|
|
361
362
|
*/
|
|
362
|
-
export declare function numeric(attribute: Attribute, operatorA?: string, valueA?: number, operatorB?: string, valueB?: number,
|
|
363
|
+
export declare function numeric(attribute: Attribute, operatorA?: string, valueA?: number, operatorB?: string, valueB?: number, config?: BaseFilterConfig): Filter;
|
|
363
364
|
/**
|
|
364
365
|
* Creates a filter to isolate attribute values that match any of the specified strings.
|
|
365
366
|
*
|
|
@@ -373,15 +374,11 @@ export declare function numeric(attribute: Attribute, operatorA?: string, valueA
|
|
|
373
374
|
* ```
|
|
374
375
|
* @param attribute - Attribute to filter on
|
|
375
376
|
* @param members - Array of member values to filter by
|
|
376
|
-
* @param
|
|
377
|
-
* @param guid - Optional GUID for the filter
|
|
378
|
-
* @param deactivatedMembers - Array of deactivated member values
|
|
379
|
-
* @param backgroundFilter - Optional background filter
|
|
380
|
-
* @param multiSelection - Optional flag to disable multi-selection
|
|
377
|
+
* @param config - Optional configuration for the filter
|
|
381
378
|
* @returns A filter instance
|
|
382
379
|
* @shortDescription Creates filter on attribute to match certain string values
|
|
383
380
|
*/
|
|
384
|
-
export declare function members(attribute: Attribute, members: string[],
|
|
381
|
+
export declare function members(attribute: Attribute, members: string[], config?: MembersFilterConfig): Filter;
|
|
385
382
|
/**
|
|
386
383
|
* Creates a filter to isolate date values starting from and including the given date and level.
|
|
387
384
|
*
|
|
@@ -392,9 +389,10 @@ export declare function members(attribute: Attribute, members: string[], exclude
|
|
|
392
389
|
* ```
|
|
393
390
|
* @param level - Date {@link LevelAttribute} to filter on
|
|
394
391
|
* @param from - Date or string representing the value to filter from
|
|
392
|
+
* @param config - Optional configuration for the filter
|
|
395
393
|
* @returns A filter instance
|
|
396
394
|
*/
|
|
397
|
-
export declare function dateFrom(level: LevelAttribute, from: Date | string,
|
|
395
|
+
export declare function dateFrom(level: LevelAttribute, from: Date | string, config?: BaseFilterConfig): Filter;
|
|
398
396
|
/**
|
|
399
397
|
* Creates a filter to isolate items up until and including the given date and level.
|
|
400
398
|
*
|
|
@@ -405,10 +403,10 @@ export declare function dateFrom(level: LevelAttribute, from: Date | string, gui
|
|
|
405
403
|
* ```
|
|
406
404
|
* @param level - Date {@link LevelAttribute} to filter on
|
|
407
405
|
* @param to - Date or string representing the last member to filter to
|
|
408
|
-
* @param
|
|
406
|
+
* @param config - Optional configuration for the filter
|
|
409
407
|
* @returns A filter instance
|
|
410
408
|
*/
|
|
411
|
-
export declare function dateTo(level: LevelAttribute, to: Date | string,
|
|
409
|
+
export declare function dateTo(level: LevelAttribute, to: Date | string, config?: BaseFilterConfig): Filter;
|
|
412
410
|
/**
|
|
413
411
|
* Creates a filter to isolate items between and including the given dates and level.
|
|
414
412
|
*
|
|
@@ -420,10 +418,10 @@ export declare function dateTo(level: LevelAttribute, to: Date | string, guid?:
|
|
|
420
418
|
* @param level - Date {@link LevelAttribute} to filter on
|
|
421
419
|
* @param from - Date or string representing the start member to filter from
|
|
422
420
|
* @param to - Date or string representing the end member to filter to
|
|
423
|
-
* @param
|
|
421
|
+
* @param config - Optional configuration for the filter
|
|
424
422
|
* @returns A filter instance
|
|
425
423
|
*/
|
|
426
|
-
export declare function dateRange(level: LevelAttribute, from?: Date | string, to?: Date | string,
|
|
424
|
+
export declare function dateRange(level: LevelAttribute, from?: Date | string, to?: Date | string, config?: BaseFilterConfig): Filter;
|
|
427
425
|
/**
|
|
428
426
|
* Creates a filter to isolate items with a date dimension value within a specified range after a
|
|
429
427
|
* given date and level.
|
|
@@ -453,10 +451,10 @@ export declare function dateRange(level: LevelAttribute, from?: Date | string, t
|
|
|
453
451
|
* Positive numbers skip forwards and negative numbers skip backwards (e.g. `-6` is 6 months backwards when `level` is a months level attribute)
|
|
454
452
|
* @param count - Number of levels to include in the filter (e.g. `6` is 6 months when `level` is a months level attribute)
|
|
455
453
|
* @param anchor - Date to filter from, defaults to the current day
|
|
456
|
-
* @param
|
|
454
|
+
* @param config - Optional configuration for the filter
|
|
457
455
|
* @returns A filter instance
|
|
458
456
|
*/
|
|
459
|
-
export declare function dateRelative(level: LevelAttribute, offset: number, count: number, anchor?: Date | string,
|
|
457
|
+
export declare function dateRelative(level: LevelAttribute, offset: number, count: number, anchor?: Date | string, config?: BaseFilterConfig): Filter;
|
|
460
458
|
/**
|
|
461
459
|
* Creates a filter to isolate items with a date dimension value within a specified range after a
|
|
462
460
|
* given date and level.
|
|
@@ -470,10 +468,10 @@ export declare function dateRelative(level: LevelAttribute, offset: number, coun
|
|
|
470
468
|
* @param offset - Number of levels to skip from the given `anchor` or the default of the current day (e.g. `6` is 6 months when `level` is a months level attribute)
|
|
471
469
|
* @param count - Number of levels to include in the filter (e.g. `6` is 6 months when `level` is a months level attribute)
|
|
472
470
|
* @param anchor - Date to filter from, defaults to the current day
|
|
473
|
-
* @param
|
|
471
|
+
* @param config - Optional configuration for the filter
|
|
474
472
|
* @returns A filter instance
|
|
475
473
|
*/
|
|
476
|
-
export declare function dateRelativeFrom(level: LevelAttribute, offset: number, count: number, anchor?: Date | string,
|
|
474
|
+
export declare function dateRelativeFrom(level: LevelAttribute, offset: number, count: number, anchor?: Date | string, config?: BaseFilterConfig): Filter;
|
|
477
475
|
/**
|
|
478
476
|
* Creates a filter to isolate items with a date dimension value within a specified range before a
|
|
479
477
|
* given date and level.
|
|
@@ -487,10 +485,10 @@ export declare function dateRelativeFrom(level: LevelAttribute, offset: number,
|
|
|
487
485
|
* @param offset - Number of levels to skip from the given `anchor` or the default of the current day (e.g. `6` is 6 months when `level` is a months level attribute)
|
|
488
486
|
* @param count - Number of levels to include in the filter (e.g. `6` is 6 months when `level` is a months level attribute)
|
|
489
487
|
* @param anchor - Date to filter to, defaults to the current day
|
|
490
|
-
* @param
|
|
488
|
+
* @param config - Optional configuration for the filter
|
|
491
489
|
* @returns A filter instance
|
|
492
490
|
*/
|
|
493
|
-
export declare function dateRelativeTo(level: LevelAttribute, offset: number, count: number, anchor?: Date | string,
|
|
491
|
+
export declare function dateRelativeTo(level: LevelAttribute, offset: number, count: number, anchor?: Date | string, config?: BaseFilterConfig): Filter;
|
|
494
492
|
/**
|
|
495
493
|
* Creates a filter to isolate items with a date dimension value in the current calendar year.
|
|
496
494
|
*
|
|
@@ -500,10 +498,10 @@ export declare function dateRelativeTo(level: LevelAttribute, offset: number, co
|
|
|
500
498
|
* filterFactory.thisYear(DM.Commerce.Date)
|
|
501
499
|
* ```
|
|
502
500
|
* @param dimension - Date dimension to filter
|
|
503
|
-
* @param
|
|
501
|
+
* @param config - Optional configuration for the filter
|
|
504
502
|
* @returns A filter instance
|
|
505
503
|
*/
|
|
506
|
-
export declare function thisYear(dimension: DateDimension,
|
|
504
|
+
export declare function thisYear(dimension: DateDimension, config?: BaseFilterConfig): Filter;
|
|
507
505
|
/**
|
|
508
506
|
* Creates a filter to isolate items with a date dimension value in the current calendar month.
|
|
509
507
|
*
|
|
@@ -513,10 +511,10 @@ export declare function thisYear(dimension: DateDimension, guid?: string): Filte
|
|
|
513
511
|
* filterFactory.thisMonth(DM.Commerce.Date)
|
|
514
512
|
* ```
|
|
515
513
|
* @param dimension - Date dimension to filter
|
|
516
|
-
* @param
|
|
514
|
+
* @param config - Optional configuration for the filter
|
|
517
515
|
* @returns A filter instance
|
|
518
516
|
*/
|
|
519
|
-
export declare function thisMonth(dimension: DateDimension,
|
|
517
|
+
export declare function thisMonth(dimension: DateDimension, config?: BaseFilterConfig): Filter;
|
|
520
518
|
/**
|
|
521
519
|
* Creates a filter to isolate items with a date dimension value in the current quarter.
|
|
522
520
|
*
|
|
@@ -526,10 +524,10 @@ export declare function thisMonth(dimension: DateDimension, guid?: string): Filt
|
|
|
526
524
|
* filterFactory.thisQuarter(DM.Commerce.Date)
|
|
527
525
|
* ```
|
|
528
526
|
* @param dimension - Date dimension to filter
|
|
529
|
-
* @param
|
|
527
|
+
* @param config - Optional configuration for the filter
|
|
530
528
|
* @returns A filter instance
|
|
531
529
|
*/
|
|
532
|
-
export declare function thisQuarter(dimension: DateDimension,
|
|
530
|
+
export declare function thisQuarter(dimension: DateDimension, config?: BaseFilterConfig): Filter;
|
|
533
531
|
/**
|
|
534
532
|
* Creates a filter to isolate items with a date dimension value of the current date.
|
|
535
533
|
*
|
|
@@ -539,10 +537,10 @@ export declare function thisQuarter(dimension: DateDimension, guid?: string): Fi
|
|
|
539
537
|
* filterFactory.today(DM.Commerce.Date)
|
|
540
538
|
* ```
|
|
541
539
|
* @param dimension - date dimension to filter
|
|
542
|
-
* @param
|
|
540
|
+
* @param config - Optional configuration for the filter
|
|
543
541
|
* @returns A filter instance
|
|
544
542
|
*/
|
|
545
|
-
export declare function today(dimension: DateDimension,
|
|
543
|
+
export declare function today(dimension: DateDimension, config?: BaseFilterConfig): Filter;
|
|
546
544
|
/**
|
|
547
545
|
* Creates a filter on all measure values matching the provided criteria.
|
|
548
546
|
*
|
|
@@ -552,11 +550,11 @@ export declare function today(dimension: DateDimension, guid?: string): Filter;
|
|
|
552
550
|
* @param valueA - First value
|
|
553
551
|
* @param operatorB - Operator to apply on `valueB` ({@link NumericOperators})
|
|
554
552
|
* @param valueB - Second value
|
|
555
|
-
* @param
|
|
553
|
+
* @param config - Optional configuration for the filter
|
|
556
554
|
* @returns A filter representing the provided logic
|
|
557
555
|
* @internal
|
|
558
556
|
*/
|
|
559
|
-
export declare function measureBase(attribute: Attribute, measure: Measure, operatorA?: string, valueA?: number, operatorB?: string, valueB?: number,
|
|
557
|
+
export declare function measureBase(attribute: Attribute, measure: Measure, operatorA?: string, valueA?: number, operatorB?: string, valueB?: number, config?: BaseFilterConfig): Filter;
|
|
560
558
|
/**
|
|
561
559
|
* Creates a filter to isolate a measure value equal to a given number.
|
|
562
560
|
*
|
|
@@ -570,10 +568,10 @@ export declare function measureBase(attribute: Attribute, measure: Measure, oper
|
|
|
570
568
|
* ```
|
|
571
569
|
* @param measure - Measure to filter by
|
|
572
570
|
* @param value - Value
|
|
573
|
-
* @param
|
|
571
|
+
* @param config - Optional configuration for the filter
|
|
574
572
|
* @returns A filter instance
|
|
575
573
|
*/
|
|
576
|
-
export declare function measureEquals(measure: BaseMeasure, value: number,
|
|
574
|
+
export declare function measureEquals(measure: BaseMeasure, value: number, config?: BaseFilterConfig): Filter;
|
|
577
575
|
/**
|
|
578
576
|
* Creates a filter to isolate a measure value greater than to a given number.
|
|
579
577
|
*
|
|
@@ -588,10 +586,10 @@ export declare function measureEquals(measure: BaseMeasure, value: number, guid?
|
|
|
588
586
|
* ```
|
|
589
587
|
* @param measure - Measure to filter by
|
|
590
588
|
* @param value - Min value
|
|
591
|
-
* @param
|
|
589
|
+
* @param config - Optional configuration for the filter
|
|
592
590
|
* @returns A filter instance
|
|
593
591
|
*/
|
|
594
|
-
export declare function measureGreaterThan(measure: BaseMeasure, value: number,
|
|
592
|
+
export declare function measureGreaterThan(measure: BaseMeasure, value: number, config?: BaseFilterConfig): Filter;
|
|
595
593
|
/**
|
|
596
594
|
* Creates a filter to isolate a measure value greater than or equal to a given number.
|
|
597
595
|
*
|
|
@@ -606,10 +604,10 @@ export declare function measureGreaterThan(measure: BaseMeasure, value: number,
|
|
|
606
604
|
* ```
|
|
607
605
|
* @param measure - Measure to filter by
|
|
608
606
|
* @param value - Min value
|
|
609
|
-
* @param
|
|
607
|
+
* @param config - Optional configuration for the filter
|
|
610
608
|
* @returns A filter instance
|
|
611
609
|
*/
|
|
612
|
-
export declare function measureGreaterThanOrEqual(measure: BaseMeasure, value: number,
|
|
610
|
+
export declare function measureGreaterThanOrEqual(measure: BaseMeasure, value: number, config?: BaseFilterConfig): Filter;
|
|
613
611
|
/**
|
|
614
612
|
* Creates a filter to isolate a measure value less than or equal to a given number.
|
|
615
613
|
*
|
|
@@ -624,10 +622,10 @@ export declare function measureGreaterThanOrEqual(measure: BaseMeasure, value: n
|
|
|
624
622
|
* ```
|
|
625
623
|
* @param measure - Measure to filter by
|
|
626
624
|
* @param value - Max value
|
|
627
|
-
* @param
|
|
625
|
+
* @param config - Optional configuration for the filter
|
|
628
626
|
* @returns A filter instance
|
|
629
627
|
*/
|
|
630
|
-
export declare function measureLessThanOrEqual(measure: BaseMeasure, value: number,
|
|
628
|
+
export declare function measureLessThanOrEqual(measure: BaseMeasure, value: number, config?: BaseFilterConfig): Filter;
|
|
631
629
|
/**
|
|
632
630
|
* Creates a filter to isolate a measure value less than a given number.
|
|
633
631
|
*
|
|
@@ -641,10 +639,10 @@ export declare function measureLessThanOrEqual(measure: BaseMeasure, value: numb
|
|
|
641
639
|
* ```
|
|
642
640
|
* @param measure - Measure to filter by
|
|
643
641
|
* @param value - Value
|
|
644
|
-
* @param
|
|
642
|
+
* @param config - Optional configuration for the filter
|
|
645
643
|
* @returns A filter instance
|
|
646
644
|
*/
|
|
647
|
-
export declare function measureLessThan(measure: BaseMeasure, value: number,
|
|
645
|
+
export declare function measureLessThan(measure: BaseMeasure, value: number, config?: BaseFilterConfig): Filter;
|
|
648
646
|
/**
|
|
649
647
|
* Creates a filter to isolate a measure value between or equal to two given numbers.
|
|
650
648
|
*
|
|
@@ -661,10 +659,10 @@ export declare function measureLessThan(measure: BaseMeasure, value: number, gui
|
|
|
661
659
|
* @param measure - Measure to filter by
|
|
662
660
|
* @param valueA - Min value
|
|
663
661
|
* @param valueB - Max value
|
|
664
|
-
* @param
|
|
662
|
+
* @param config - Optional configuration for the filter
|
|
665
663
|
* @returns A filter instance
|
|
666
664
|
*/
|
|
667
|
-
export declare function measureBetween(measure: BaseMeasure, valueA: number, valueB: number,
|
|
665
|
+
export declare function measureBetween(measure: BaseMeasure, valueA: number, valueB: number, config?: BaseFilterConfig): Filter;
|
|
668
666
|
/**
|
|
669
667
|
* Creates a filter to isolate a measure value between but not equal to two given numbers.
|
|
670
668
|
*
|
|
@@ -681,10 +679,10 @@ export declare function measureBetween(measure: BaseMeasure, valueA: number, val
|
|
|
681
679
|
* @param measure - Measure to filter by
|
|
682
680
|
* @param valueA - Min value
|
|
683
681
|
* @param valueB - Max value
|
|
684
|
-
* @param
|
|
682
|
+
* @param config - Optional configuration for the filter
|
|
685
683
|
* @returns A filter instance
|
|
686
684
|
*/
|
|
687
|
-
export declare function measureBetweenNotEqual(measure: BaseMeasure, valueA: number, valueB: number,
|
|
685
|
+
export declare function measureBetweenNotEqual(measure: BaseMeasure, valueA: number, valueB: number, config?: BaseFilterConfig): Filter;
|
|
688
686
|
/**
|
|
689
687
|
* Creates a filter to isolate items that rank towards the top for a given measure.
|
|
690
688
|
*
|
|
@@ -700,10 +698,10 @@ export declare function measureBetweenNotEqual(measure: BaseMeasure, valueA: num
|
|
|
700
698
|
* @param attribute - Attribute to filter
|
|
701
699
|
* @param measure - Measure to filter by
|
|
702
700
|
* @param count - Number of members to return
|
|
703
|
-
* @param
|
|
701
|
+
* @param config - Optional configuration for the filter
|
|
704
702
|
* @returns A filter instance
|
|
705
703
|
*/
|
|
706
|
-
export declare function topRanking(attribute: Attribute, measure: Measure, count: number,
|
|
704
|
+
export declare function topRanking(attribute: Attribute, measure: Measure, count: number, config?: BaseFilterConfig): Filter;
|
|
707
705
|
/**
|
|
708
706
|
* Creates a filter to isolate items that rank towards the bottom for a given measure.
|
|
709
707
|
*
|
|
@@ -719,10 +717,10 @@ export declare function topRanking(attribute: Attribute, measure: Measure, count
|
|
|
719
717
|
* @param attribute - Attribute to filter
|
|
720
718
|
* @param measure - Measure to filter by
|
|
721
719
|
* @param count - Number of members to return
|
|
722
|
-
* @param
|
|
720
|
+
* @param config - Optional configuration for the filter
|
|
723
721
|
* @returns A filter instance
|
|
724
722
|
*/
|
|
725
|
-
export declare function bottomRanking(attribute: Attribute, measure: Measure, count: number,
|
|
723
|
+
export declare function bottomRanking(attribute: Attribute, measure: Measure, count: number, config?: BaseFilterConfig): Filter;
|
|
726
724
|
/**
|
|
727
725
|
* Set of logic operators for filter relations construction
|
|
728
726
|
*
|
|
@@ -793,9 +791,10 @@ export declare namespace logic {
|
|
|
793
791
|
/**
|
|
794
792
|
* Creates a filter from JAQL
|
|
795
793
|
*
|
|
794
|
+
* @param attribute - Attribute to filter
|
|
796
795
|
* @param jaql - Filter Jaql
|
|
797
|
-
* @param
|
|
796
|
+
* @param config - Optional configuration for the filter
|
|
798
797
|
* @returns A filter instance
|
|
799
798
|
* @internal
|
|
800
799
|
*/
|
|
801
|
-
export declare function customFilter(attribute: Attribute, jaql: any,
|
|
800
|
+
export declare function customFilter(attribute: Attribute, jaql: any, config?: BaseFilterConfig): Filter;
|