@sisense/sdk-data 1.11.0 → 1.13.0

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

@@ -0,0 +1,344 @@
+import { LevelAttribute, Attribute, Measure, Filter } from '../interfaces.js';
+import { DimensionalElement } from '../base.js';
+/**
+ * Different text operators that can be used with text filters
+ *
+ * @internal
+ */
+export declare const TextOperators: {
+    Contains: string;
+    StartsWith: string;
+    EndsWith: string;
+    Equals: string;
+    DoesntEqual: string;
+    DoesntStartWith: string;
+    DoesntContain: string;
+    DoesntEndWith: string;
+    Like: string;
+};
+/**
+ * Different numeric operators that can be used with numeric filters
+ */
+export declare const NumericOperators: {
+    Equals: string;
+    DoesntEqual: string;
+    From: string;
+    FromNotEqual: string;
+    To: string;
+    ToNotEqual: string;
+};
+/**
+ * Different date operators that can be used with date filters
+ *
+ * @internal
+ */
+export declare const DateOperators: {
+    From: string;
+    To: string;
+    Last: string;
+    Next: string;
+    Anchor: string;
+};
+/**
+ * Different logical operators that can be used with logical filters
+ *
+ * @internal
+ */
+export declare const LogicalOperators: {
+    Union: string;
+    Intersection: string;
+    Exclude: string;
+};
+/**
+ * Different ranking operators that can be used with ranking filter
+ *
+ * @internal
+ */
+export declare const RankingOperators: {
+    Top: string;
+    Bottom: string;
+};
+/**
+ * Different filter types
+ *
+ * @internal
+ */
+export declare const FilterTypes: {
+    logicalAttribute: string;
+    members: string;
+    exclude: string;
+    measure: string;
+    ranking: string;
+    text: string;
+    numeric: string;
+    date: string;
+    relativeDate: string;
+    cascading: string;
+    advanced: string;
+};
+/**
+ * base implementation for filter classes
+ *
+ * @internal
+ */
+declare abstract class AbstractFilter extends DimensionalElement implements Filter {
+    /**
+     * Attribute this filter instance is filtering
+     */
+    readonly attribute: Attribute;
+    /**
+     * Filter type
+     */
+    readonly filterType: string;
+    /**
+     * Global filter identifier
+     */
+    readonly guid: string;
+    private _disabled;
+    /**
+     * Boolean flag whether the filter is disabled
+     *
+     * @internal
+     */
+    get disabled(): boolean;
+    set disabled(value: boolean);
+    constructor(att: Attribute, filterType: string, guid?: string);
+    get name(): string;
+    /**
+     * Gets JAQL representing this Filter instance
+     */
+    abstract filterJaql(): any;
+    /**
+     * gets the element's ID
+     */
+    abstract get id(): string;
+    /**
+     * Defines whether the filter is a scope filters
+     */
+    isScope: boolean;
+    /**
+     * Gets a serializable representation of the element
+     */
+    serializable(): any;
+    /**
+     * Gets the JAQL representation of this instance
+     *
+     * @param nested - defines whether the JAQL is nested within parent JAQL statement or a root JAQL element
+     */
+    jaql(nested?: boolean): any;
+    static checkAttributeSupport(attribute: Attribute): void;
+    static disabledJaql(nested?: boolean): any;
+}
+/**
+ * @internal
+ */
+export declare class LogicalAttributeFilter extends AbstractFilter {
+    readonly filters: Filter[];
+    readonly operator: string;
+    constructor(filters: Filter[], operator: string, guid?: string);
+    /**
+     * gets the element's ID
+     */
+    get id(): string;
+    /**
+     * Gets a serializable representation of the element
+     */
+    serializable(): any;
+    /**
+     * Gets JAQL representing this Filter instance
+     */
+    filterJaql(): any;
+}
+/**
+ * @internal
+ */
+export declare class MembersFilter extends AbstractFilter {
+    readonly members: any[];
+    /** @internal */
+    _deactivatedMembers: any[];
+    constructor(attribute: Attribute, members?: any[], _deactivatedMembers?: any[], guid?: string);
+    /**
+     * gets the element's ID
+     */
+    get id(): string;
+    /**
+     * Gets a serializable representation of the element
+     */
+    serializable(): any;
+    /**
+     * Gets JAQL representing this Filter instance
+     */
+    filterJaql(): any;
+}
+/**
+ * @internal
+ */
+export declare class CascadingFilter extends AbstractFilter {
+    readonly filters: Filter[];
+    constructor(filters: Filter[], guid?: string);
+    /**
+     * gets the element's ID
+     */
+    get id(): string;
+    get disabled(): boolean;
+    set disabled(value: boolean);
+    /**
+     * Gets a serializable representation of the element
+     */
+    serializable(): any;
+    /**
+     * Gets JAQL representing this Filter instance
+     */
+    filterJaql(): any;
+    jaql(nested?: boolean): any;
+}
+/**
+ * @internal
+ */
+export declare class ExcludeFilter extends AbstractFilter {
+    readonly filter: Filter;
+    readonly input?: Filter;
+    constructor(filter: Filter, input?: Filter, guid?: string);
+    /**
+     * gets the element's ID
+     */
+    get id(): string;
+    /**
+     * Gets a serializable representation of the element
+     */
+    serializable(): any;
+    /**
+     * Gets JAQL representing this Filter instance
+     */
+    filterJaql(): any;
+}
+/**
+ * @internal
+ */
+export declare class DoubleOperatorFilter<Type> extends AbstractFilter {
+    operatorA?: string;
+    operatorB?: string;
+    valueA?: Type;
+    valueB?: Type;
+    constructor(att: Attribute, filterType: string, operatorA?: string, valueA?: Type, operatorB?: string, valueB?: Type, guid?: string);
+    /**
+     * gets the element's ID
+     */
+    get id(): string;
+    /**
+     * Gets a serializable representation of the element
+     */
+    serializable(): any;
+    /**
+     * Gets JAQL representing this Filter instance
+     */
+    filterJaql(): any;
+}
+/**
+ * @internal
+ */
+export declare class MeasureFilter extends DoubleOperatorFilter<number> {
+    measure: Measure;
+    constructor(att: Attribute, measure: Measure, operatorA?: string, valueA?: number, operatorB?: string, valueB?: number, guid?: string);
+    /**
+     * gets the element's ID
+     */
+    get id(): string;
+    /**
+     * Gets a serializable representation of the element
+     */
+    serializable(): any;
+    jaql(nested?: boolean | undefined): any;
+}
+/**
+ * @internal
+ */
+export declare class RankingFilter extends AbstractFilter {
+    count: number;
+    operator: string;
+    measure: Measure;
+    constructor(att: Attribute, measure: Measure, operator: string, count: number, guid?: string);
+    /**
+     * gets the element's ID
+     */
+    get id(): string;
+    /**
+     * Gets a serializable representation of the element
+     */
+    serializable(): any;
+    /**
+     * Gets JAQL representing this Filter instance
+     */
+    filterJaql(): any;
+}
+/**
+ * @internal
+ */
+export declare class NumericFilter extends DoubleOperatorFilter<number> {
+    constructor(att: Attribute, operatorA?: string, valueA?: number, operatorB?: string, valueB?: number, guid?: string);
+}
+/**
+ * @internal
+ */
+export declare class TextFilter extends DoubleOperatorFilter<string> {
+    constructor(att: Attribute, operator: string, value: string, guid?: string);
+}
+/**
+ * @internal
+ */
+export declare class DateRangeFilter extends DoubleOperatorFilter<Date | string> {
+    constructor(l: LevelAttribute, valueFrom?: Date | string, valueTo?: Date | string, guid?: string);
+    get level(): LevelAttribute;
+    get from(): string;
+    get to(): string;
+    /**
+     * Gets JAQL representing this Filter instance
+     */
+    filterJaql(): any;
+}
+/**
+ * @internal
+ */
+export declare class RelativeDateFilter extends AbstractFilter {
+    readonly offset: number;
+    readonly count: number;
+    readonly operator: string;
+    readonly anchor?: Date | string;
+    constructor(l: LevelAttribute, offset: number, count: number, operator?: string, anchor?: Date | string, guid?: string);
+    get level(): LevelAttribute;
+    /**
+     * gets the element's ID
+     */
+    get id(): string;
+    /**
+     * Gets a serializable representation of the element
+     */
+    serializable(): any;
+    /**
+     * Gets JAQL representing this Filter instance
+     *
+     */
+    filterJaql(): any;
+}
+/**
+ * @internal
+ */
+export declare class CustomFilter extends AbstractFilter {
+    readonly jaqlExpression: any;
+    constructor(att: Attribute, jaql: any, guid?: string);
+    /**
+     * gets the element's ID
+     */
+    get id(): string;
+    /**
+     * Gets JAQL representing this Filter instance
+     *
+     */
+    filterJaql(): any;
+}
+/**
+ * @param json - Filter JSON representation
+ * @internal
+ */
+export declare function createFilter(json: any): Filter;
+export {};