BIM.works SDKs - v3.0.0-b.115
    Preparing search index...

    Interface CompareOptions

    interface CompareOptions {
        align?: "auto" | "none";
        category?: string;
        details?: "summary" | "objects" | "changes" | "full";
        force?: boolean;
        layers?: boolean;
        limit?: number;
        offset?: number;
        waitMs?: number;
    }
    Index

    Properties

    align? category? details? force? layers? limit? offset? waitMs?

    Properties

    align?: "auto" | "none"

    Overrides the definition's align statement: "auto" judges with the shared move undone

    category?: string

    Only the records of this category

    details?: "summary" | "objects" | "changes" | "full"

    How much of the result to return (default "full")

    force?: boolean

    Compute again even when a stored result answers

    layers?: boolean

    Whether "full" includes the layers (default true)

    limit?: number
    offset?: number
    waitMs?: number

    Wait at most this long; a compare still running then answers with status RUNNING

    Settings

    Member Visibility

    On This Page

    Properties