BIM.works SDKs - v3.0.0-beta.168
    Preparing search index...

    Interface BimQueryOptions

    Options accepted by Bim.query.

    interface BimQueryOptions {
        aliasKeys?: boolean;
        forceGetQid?: boolean;
        parameters?: Record<string, unknown>;
        useCache?: boolean;
        virtualFeatures?: unknown;
    }
    Index

    Properties

    aliasKeys?: boolean

    True puts values under their AS aliases, as before 3.0; omitted uses the client's default (Bim.setAliasKeys, false). By default an alias only names its column: read values by alias with QueryColumns.

    forceGetQid?: boolean

    Include qids even when GET does not request them. Defaults to false.

    parameters?: Record<string, unknown>

    Named BQL parameter values, without the leading dollar sign.

    useCache?: boolean

    Cache this query result for this client. Defaults to false.

    virtualFeatures?: unknown

    Virtual-feature selection sent to the server; omitted uses the client's default.