Lime Web Components API Documentation - v7.4.0
    Preparing search index...

    Interface Filter

    Saved filter definition for a limetype.

    A Filter represents a named, reusable filter that can be applied to objects of a specific limetype. Filters are typically created by users or administrators and can be referenced by name in InFilterExpressions or used directly to query objects.

    Filters have multi-language names and descriptions, and can be either system-wide or user-specific (when iduser is set).

    import { Filter, Operator } from '@limetech/lime-web-components';

    const highValueDeals: Filter = {
        id: 'high_value_deals',
        limetype: 'deal',
        name: { en: 'High Value Deals', sv: 'Höga affärer' },
        description: { en: 'Active deals worth more than $100,000' },
        filter: {
            op: Operator.AND,
            exp: [
                { key: 'status', op: Operator.EQUALS, exp: 'active' },
                { key: 'value', op: Operator.GREATER_OR_EQUAL, exp: 100_000 },
            ],
        },
    };

    import { InFilterExpression, Operator } from '@limetech/lime-web-components';

    const ownedBySalesTeam: InFilterExpression = {
        type: 'filter',
        key: 'owner',
        op: Operator.IN,
        exp: 'sales_team',
    };
    interface Filter {
        description?: { [language: string]: string };
        filter: Expression;
        id: string;
        iduser?: number;
        limetype: string;
        name: { [language: string]: string };
    }
    Index

    Properties

    description? filter id iduser? limetype name

    Properties

    description?: { [language: string]: string }

    Optional description in different languages.

    Keys are language codes (e.g., 'en', 'sv'), values are translated descriptions.

    filter: Expression

    Filter expression that defines the matching criteria.

    Expression

    id: string

    Unique identifier for this filter.

    iduser?: number

    Optional user ID if this is a personal filter.

    If set, this filter is private to a specific user. If undefined, the filter is available system-wide.

    limetype: string

    Name of the limetype this filter applies to.

    name: { [language: string]: string }

    Display name in different languages.

    Keys are language codes (e.g., 'en', 'sv'), values are translated names.

    Settings

    Member Visibility

    On This Page

    Properties