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

    Interface OverlayItemCommon

    Fields common to every overlay item (docs/check-overlays-design.md §3.1)

    interface OverlayItemCommon {
        color?: string;
        depth?: "always" | "test" | "ghost";
        id: string;
        label?: string;
        labelShow?: "always" | "hover";
        qids?: string[];
        role?: OverlayRole;
        storey?: string;
        tooltip?: string;
        type: string;
        views?: ("2d" | "3d")[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    color? depth? id label? labelShow? qids? role? storey? tooltip? type views?

    Properties

    color?: string

    "#rrggbb" or "#rrggbbaa", overrides the role colour

    depth?: "always" | "test" | "ghost"

    "ghost" draws as "test" until the ghost pass arrives

    id: string

    Unique within the overlay

    label?: string
    labelShow?: "always" | "hover"

    "hover": the label only while the item or one of its qids is hovered; default "always"

    qids?: string[]

    Related model objects

    role?: OverlayRole
    storey?: string
    tooltip?: string
    type: string
    views?: ("2d" | "3d")[]

    Settings

    Member Visibility

    On This Page

    Properties