Orca Note Plugin API Documentation
    Preparing search index...

    Interface QueryDescription2

    Describes a query for searching and filtering blocks. Used to construct complex queries that can combine multiple conditions.

    interface QueryDescription2 {
        asCalendar?: {
            end: Date;
            field: "created" | "modified" | "journal";
            start: Date;
        };
        asTable?: boolean;
        excludeId?: number;
        group?: string;
        groupBy?: string;
        page?: number;
        pageSize?: number;
        q?: QueryGroup2;
        randomSeed?: number;
        referenceDate?: number;
        sort?: QuerySort[];
        stats?: QueryStat[];
        tagName?: string;
        useReferenceDate?: boolean;
    }
    Index

    Properties

    asCalendar? asTable? excludeId? group? groupBy? page? pageSize? q? randomSeed? referenceDate? sort? stats? tagName? useReferenceDate?

    Properties

    asCalendar?: {
        end: Date;
        field: "created" | "modified" | "journal";
        start: Date;
    }

    Calendar view configuration if results should be displayed in calendar format

    Type Declaration

    • end: Date

      End date for the calendar range

    • field: "created" | "modified" | "journal"

      Field to use for calendar date (created/modified/journal date)

    • start: Date

      Start date for the calendar range

    asTable?: boolean

    Whether to format results as a table

    excludeId?: number

    Optional block ID to exclude from results

    group?: string

    Specifies which group to return results for

    groupBy?: string

    Field to group results by

    Optionalpage

    page?: number

    For paginated results, the page number (0-based)

    pageSize?: number

    For paginated results, the number of items per page

    q?: QueryGroup2

    The main query group with conditions

    randomSeed?: number

    Random seed for stable random sorting across pagination

    referenceDate?: number

    The reference date for relative dates (Unix timestamp)

    sort?: QuerySort[]

    Array of sort specifications for ordering results

    stats?: QueryStat[]

    Statistical calculations to perform on results

    tagName?: string

    Filters results to blocks with a specific tag

    useReferenceDate?: boolean

    Whether to use the current page's date as the reference for relative dates

    Settings

    Member Visibility

    On This Page

    Properties