@sisense/sdk-data 0.11.3

package/dist/dimensional-model/filters/factory.d.ts

@@ -0,0 +1,315 @@
+import { DateDimension, LevelAttribute, Attribute, Measure, Filter, BaseMeasure } from '../interfaces.js';
+/**
+ * Creates a filter representing a union of multiple filters of the same attribute.
+ *
+ * @param filters - Filters, of the same attribute, to union
+ * @returns A filter representing a union of the given filters
+ */
+export declare function union(filters: Filter[]): Filter;
+/**
+ * Creates a filter representing an intersection of multiple filters of the same attribute.
+ *
+ * @param filters - Filters, of the same attribute, to intersect
+ * @returns A filter representing an intersection of the given filters
+ */
+export declare function intersection(filters: Filter[]): Filter;
+/**
+ * Creates a filter representing an exclusion of the given filter
+ * from all attribute members or from the optional input filter.
+ *
+ * @param filter - Filter to exclude
+ * @param input - Input filter to exclude from (optional)
+ * @returns A filter representing an exclusion of the given filter
+ * from all attribute members or from the optional input filter
+ */
+export declare function exclude(filter: Filter, input?: Filter): Filter;
+/**
+ * Creates a "doesn't contain" filter.
+ *
+ * @param attribute - Text attribute to filter
+ * @param value - Value to filter by
+ * @returns A text filter of the given attribute
+ */
+export declare function doesntContain(attribute: Attribute, value: string): Filter;
+/**
+ * Creates a "doesn't end with" filter.
+ *
+ * @param attribute - Text attribute to filter
+ * @param value - Value to filter by
+ * @returns A text filter of the given attribute
+ */
+export declare function doesntEndWith(attribute: Attribute, value: string): Filter;
+/**
+ * Creates a "doesn't start with" filter.
+ *
+ * @param attribute - Text attribute to filter
+ * @param value - Value to filter by
+ * @returns A text filter of the given attribute
+ */
+export declare function doesntStartWith(attribute: Attribute, value: string): Filter;
+/**
+ * Creates a "contains" filter.
+ *
+ * @param attribute - Text attribute to filter
+ * @param value - Value to filter by
+ * @returns A text filter of the given attribute
+ */
+export declare function contains(attribute: Attribute, value: string): Filter;
+/**
+ * Creates an "ends with" filter.
+ *
+ * @param attribute - Text attribute to filter
+ * @param value - Value to filter by
+ * @returns A text filter of the given attribute
+ */
+export declare function endsWith(attribute: Attribute, value: string): Filter;
+/**
+ * Creates a "starts with" filter.
+ *
+ * @param attribute - Text attribute to filter
+ * @param value - Value to filter by
+ * @returns A text filter of the given attribute
+ */
+export declare function startsWith(attribute: Attribute, value: string): Filter;
+/**
+ * Creates a "like" filter.
+ *
+ * @param attribute - Text attribute to filter
+ * @param value - Value to filter by
+ * @returns A text filter of the given attribute
+ */
+export declare function like(attribute: Attribute, value: string): Filter;
+/**
+ * Creates a "doesn't equal" filter.
+ *
+ * @param attribute - Text or numeric attribute to filter
+ * @param value - Value to filter by
+ * @returns A filter of the given attribute
+ */
+export declare function doesntEqual(attribute: Attribute, value: string | number): Filter;
+/**
+ * Creates an "equals" filter.
+ *
+ * @param attribute - Text or numeric attribute to filter
+ * @param value - Value to filter by
+ * @returns A filter of the given attribute
+ */
+export declare function equals(attribute: Attribute, value: string | number): Filter;
+/**
+ * Creates a "greater than" filter.
+ *
+ * @param attribute - Numeric attribute to filter
+ * @param value - Value to filter by
+ * @returns A numeric filter of the given attribute
+ */
+export declare function greaterThan(attribute: Attribute, value: number): Filter;
+/**
+ * Creates a "greater than or equal" filter.
+ *
+ * @param attribute - Numeric attribute to filter
+ * @param value - Value to filter by
+ * @returns A numeric filter of the given attribute
+ */
+export declare function greaterThanOrEqual(attribute: Attribute, value: number): Filter;
+/**
+ * Creates a "less than" filter.
+ *
+ * @param attribute - Numeric attribute to filter
+ * @param value - Value to filter by
+ * @returns A numeric filter of the given attribute
+ */
+export declare function lessThan(attribute: Attribute, value: number): Filter;
+/**
+ * Creates a "less than or equal" filter.
+ *
+ * @param attribute - Numeric attribute to filter
+ * @param value - Value to filter by
+ * @returns A numeric filter of the given attribute
+ */
+export declare function lessThanOrEqual(attribute: Attribute, value: number): Filter;
+/**
+ * Creates a "between" filter.
+ *
+ * @param attribute - Numeric attribute to filter
+ * @param valueA - Value to filter from
+ * @param valueB - Value to filter to
+ * @returns A numeric filter of the given attribute
+ */
+export declare function between(attribute: Attribute, valueA: number, valueB: number): Filter;
+/**
+ * Creates a "between, but not equal" filter.
+ *
+ * @param attribute - Numeric attribute to filter
+ * @param valueA - Value to filter from
+ * @param valueB - Value to filter to
+ * @returns A numeric filter of the given attribute
+ */
+export declare function betweenNotEqual(attribute: Attribute, valueA: number, valueB: number): Filter;
+/**
+ * Creates a custom numeric filter.
+ *
+ * @param attribute - Numeric attribute to filter
+ * @param operatorA - First operator
+ * @param valueA - First value
+ * @param operatorB - Second operator
+ * @param valueB - Second value
+ * @returns A custom numeric filter of the given attribute
+ */
+export declare function numeric(attribute: Attribute, operatorA?: string, valueA?: number, operatorB?: string, valueB?: number): Filter;
+/**
+ * Creates a filter on the given members of the given attribute.
+ *
+ * @param attribute - Attribute to filter
+ * @param members - Array of member values to filter by
+ * @returns A filter instance representing the given members of the given attribute
+ */
+export declare function members(attribute: Attribute, members: string[]): Filter;
+/**
+ * Creates a filter on all values starting at the given date of the given level.
+ *
+ * @param level - Date level attribute to filter. See {@link DateLevels} for supported levels.
+ * @param from - Date or String representing the value to filter from
+ * @returns A filter instance filtering all values starting at the given value
+ */
+export declare function dateFrom(level: LevelAttribute, from: Date | string): Filter;
+/**
+ * Creates a filter on all values ending at the given date of the given level.
+ *
+ * @param level - Date level attribute to filter. See {@link DateLevels} for supported levels.
+ * @param to - Date or String representing the last member to filter to
+ * @returns A filter instance filtering all values ending at the given value
+ */
+export declare function dateTo(level: LevelAttribute, to: Date | string): Filter;
+/**
+ * Creates a range filter between the given "from" and "to" arguments.
+ *
+ * @param level - Date level attribute to filter. See {@link DateLevels} for supported levels.
+ * @param from - Date or String representing the start member to filter from
+ * @param to - Date or String representing the end member to filter to
+ * @returns A filter instance filtering all values ending at the given value
+ */
+export declare function dateRange(level: LevelAttribute, from?: Date | string, to?: Date | string): Filter;
+/**
+ * Creates a relative date filter.
+ *
+ * @param level - Date level attribute to filter. See {@link DateLevels} for supported levels.
+ * @param offset - offset to skip from the given anchor, or Today if not provided,
+ * positive/negative to skip forward/backward
+ * @param count - number of members to filter
+ * @param anchor - Anchor to filter from, Today is used if not provided
+ * @returns A relative date filter
+ */
+export declare function dateRelative(level: LevelAttribute, offset: number, count: number, anchor?: Date | string): Filter;
+/**
+ * Creates a relative date filter from the given anchor date.
+ *
+ * @param level - Date level attribute to filter. See {@link DateLevels} for supported levels.
+ * @param offset - offset to skip from the given anchor, or Today if not provided
+ * @param count - number of members to filter
+ * @param anchor - Anchor to filter from, Today is used if not provided
+ * @returns A relative date filter
+ */
+export declare function dateRelativeFrom(level: LevelAttribute, offset: number, count: number, anchor?: Date | string): Filter;
+/**
+ * Creates a relative date filter to the given anchor date.
+ *
+ * @param level - Date level attribute to filter. See {@link DateLevels} for supported levels.
+ * @param offset - offset to skip from the given anchor, or Today if not provided
+ * @param count - number of members to filter
+ * @param anchor - Anchor to filter from, Today is used if not provided
+ * @returns A relative date filter
+ */
+export declare function dateRelativeTo(level: LevelAttribute, offset: number, count: number, anchor?: Date | string): Filter;
+/**
+ * Creates a filter on "This Year" of the given date dimension.
+ *
+ * @param dimension - date dimension to filter
+ * @returns A "This Year" filter of the given dimension
+ */
+export declare function thisYear(dimension: DateDimension): Filter;
+/**
+ * Creates a filter on "This Month" of the given date dimension.
+ *
+ * @param dimension - date dimension to filter
+ * @returns A "This Month" filter of the given dimension
+ */
+export declare function thisMonth(dimension: DateDimension): Filter;
+/**
+ * Creates a filter on "This Quarter" of the given date dimension.
+ *
+ * @param dimension - date dimension to filter
+ * @returns A "This Quarter" filter of the given dimension
+ */
+export declare function thisQuarter(dimension: DateDimension): Filter;
+/**
+ * Creates a filter on "Today" of the given date dimension.
+ *
+ * @param dimension - date dimension to filter
+ * @returns A "Today" filter of the given dimension
+ */
+export declare function today(dimension: DateDimension): Filter;
+/**
+ * Creates a filter on all measure values matching the provided criteria.
+ *
+ * @param attribute - Attribute to filter
+ * @param measure - Measure to filter by
+ * @param operatorA - Operator to apply on `valueA` ({@link NumericOperators})
+ * @param valueA - First value
+ * @param operatorB - Operator to apply on `valueB` ({@link NumericOperators})
+ * @param valueB - Second value
+ * @returns A filter representing the provided logic
+ * @internal
+ */
+export declare function measureBase(attribute: Attribute, measure: Measure, operatorA?: string, valueA?: number, operatorB?: string, valueB?: number): Filter;
+/**
+ * Creates a filter on all measure values that are greater than or equal to the given value.
+ *
+ * @param measure - Measure to filter by
+ * @param value - Min value
+ * @returns A filter representing the "greater than or equal to" logic
+ */
+export declare function measureGreaterThanOrEqual(measure: BaseMeasure, value: number): Filter;
+/**
+ * Creates a filter on all measure values less than or equal to the given value.
+ *
+ * @param measure - Measure to filter by
+ * @param value - Max value
+ * @returns A filter representing the "less than or equal to" logic
+ */
+export declare function measureLessThanOrEqual(measure: BaseMeasure, value: number): Filter;
+/**
+ * Creates a filter on all measure values within a range.
+ *
+ * @param measure - Measure to filter by
+ * @param valueA - Min value
+ * @param valueB - Max value
+ * @returns A filter representing the "between" logic
+ */
+export declare function measureBetween(measure: BaseMeasure, valueA: number, valueB: number): Filter;
+/**
+ * Creates a filter on all measure values within a range but not equal to the min and max values.
+ *
+ * @param measure - Measure to filter by
+ * @param valueA - Min value
+ * @param valueB - Max value
+ * @returns A filter representing the "between, not equal" logic
+ */
+export declare function measureBetweenNotEqual(measure: BaseMeasure, valueA: number, valueB: number): Filter;
+/**
+ * Creates a filter representing a top ranking logic.
+ *
+ * @param attribute - Attribute to filter
+ * @param measure - Measure to filter by
+ * @param count - Number of members to return
+ * @returns A filter representing a top ranking logic on the given attribute by the given measure
+ */
+export declare function topRanking(attribute: Attribute, measure: Measure, count: number): Filter;
+/**
+ * Creates a filter representing a bottom ranking logic.
+ *
+ * @param attribute - Attribute to filter
+ * @param measure - Measure to filter by
+ * @param count - Number of members to return
+ * @returns A filter representing a bottom ranking logic on the given attribute by the given measure
+ */
+export declare function bottomRanking(attribute: Attribute, measure: Measure, count: number): Filter;