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

    Interface BvlProcessOptions

    interface BvlProcessOptions {
        addedAnnotations?: unknown[] | null;
        keepMeasurements?: boolean;
        reset?: boolean;
        resultColorOf?: ((qid: string) => string | null) | null;
        transition?:
            | false
            | { duration?: number; easing?: TransitionEasing } & TransitionOptions
            | null;
    }
    Index

    Properties

    addedAnnotations?: unknown[] | null

    Receives every annotation and annotation layer added, so they can be taken away again

    keepMeasurements?: boolean

    Leave the measurements alone (a pick)

    reset?: boolean

    First take away the previous result (Viewer3d.resetResults); default true

    resultColorOf?: ((qid: string) => string | null) | null

    The "#rrggbb" colour of an object's check result, for COLOR RESULT n%; without it those objects keep their colour

    transition?:
        | false
        | { duration?: number; easing?: TransitionEasing } & TransitionOptions
        | null

    The visibility, selection, colours and VIEWFIT as one ObjectStateManager.transition step: its duration (default 500 ms) and easing, the schedule and onStop of TransitionOptions, each key over the script's TRANSITION header; either one makes it a transition. false applies at once whatever the script says. The flags, wireframes, labels and annotations apply at once either way (docs/viewer-state-transitions-design.md §8.2)