Lime Web Components API Documentation - v6.24.0
    Preparing search index...

    Interface LoadOptions

    interface LoadOptions {
        filter?: Expression;
        includeTotals?: boolean;
        limit?: number;
        offset?: number;
        order?: PropertyOrder[];
        properties?: (string | AggregateProperty)[];
    }
    Index

    Properties

    filter?: Expression

    Filter to apply to the objects

    includeTotals?: boolean

    Whether to include totals (totalCount, totalRelations, aggregates) in the response. Set to false to skip the extra COUNT query on the server, which can significantly improve performance for large datasets.

    When false, totalCount and totalRelations will be null in the response. Use a separate request with limit: 0 to fetch totals without object data.

    Maps to the ?includeTotals=false query parameter. Defaults to true.

    limit?: number

    Maximum number of objects to load

    offset?: number

    Offset of the objects to load

    order?: PropertyOrder[]

    Order to sort the properties by

    properties?: (string | AggregateProperty)[]

    Properties to load on the objects. If omitted, all properties will be loaded