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

    Class CompareResult

    A model compare result: the document CompareModels and GetCompareResult answer, with the object sets as QidSets and the correspondence between the sides. Object sets need details "objects" or more, records "changes" or more, layers "full".

    Index

    Constructors

    constructor

    Properties

    alignment cached categories clusters document error? federated groups hiddenFeatures layers left leftVid leftVids moves paging ready records resultUuid right rightVid rightVids stats status warnings

    Methods

    category categoryOf clusterObjects counterpart loadRecords moveQids objects recordQid whenReady

    Constructors

    Properties

    alignment: CompareAlignment | null

    The rigid move most matched objects share, null when there is none

    cached: boolean
    categories: CompareCategory[]
    clusters: CompareCluster[]

    Units that changed alike, the largest first

    document: Record<string, unknown>
    error?: string
    federated: boolean

    Whether either side is a federation

    groups: {
        counts: Record<string, number>;
        key: Record<string, string | null>;
        total: number;
    }[]

    The summary by the definition's group by

    hiddenFeatures: string[]
    layers: CompareLayer[]
    left: CompareResultSide | null

    The left side; a federation's has its models, and its version_uuid names no Version

    leftVid: string

    The left Version; a federation's first model

    leftVids: string[]

    The Versions of each side: one, or a federation's models

    moves:
        | {
            count: number;
            items: number[][];
            left_v?: number[];
            right_v?: number[];
            truncated?: boolean;
        }
        | null

    The pairs that moved (details "full" with layers): items [left oid, right oid, from x, y, z, to x, y, z] in world mm

    paging:
        | {
            category?: string;
            limit: number;
            offset: number;
            returned: number;
            total: number;
        }
        | null
    ready: boolean
    records: CompareRecord[]
    resultUuid: string
    right: CompareResultSide | null
    rightVid: string
    rightVids: string[]
    stats: Record<string, unknown>
    status: "FAILED" | "PENDING" | "RUNNING" | "READY"
    warnings: { code: string; details?: unknown; message: string }[]

    Methods

    • The category an object is in

      Parameters

      • qid: string | Qid

      Returns string | null

    • The objects of a cluster (details "objects" and up)

      Parameters

      • clusterId: string
      • Optionalside: "both" | "left" | "right"

      Returns QidSet

    • The paired object on the other side; null for added, removed or unknown objects

      Parameters

      • qid: string | Qid

      Returns string | null

    • Loads a page of records from the server

      Parameters

      • Optionalpage: {
            category?: string;
            details?: "changes" | "full";
            limit?: number;
            offset?: number;
        }

      Returns Promise<CompareRecord[]>

    • The qids of the pair of moves item i

      Parameters

      • i: number

      Returns { left: string; right: string }

    • The objects of a category on one side or both

      Parameters

      • categoryId: string
      • Optionalside: "both" | "left" | "right"

      Returns QidSet

    • The qid ("vid-oid") of one side of a record, null when it has none there

      Parameters

      Returns string | null

    • Waits until a compare that was still running is ready

      Parameters

      • Optionaloptions: {
            details?: "summary" | "objects" | "changes" | "full";
            intervalMs?: number;
            timeoutMs?: number;
        }

      Returns Promise<CompareResult>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods