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

    Interface OverlayArrowItem

    A 3D arrow; lengths in mm. size "screen" keeps ~48 px on screen and ignores length

    interface OverlayArrowItem {
        color?: string;
        depth?: "always" | "test" | "ghost";
        direction: [number, number, number];
        headLength?: number;
        id: string;
        label?: string;
        labelShow?: "always" | "hover";
        length?: number;
        origin: [number, number, number];
        qids?: string[];
        role?: OverlayRole;
        size?: "screen" | "world";
        storey?: string;
        tooltip?: string;
        type: "arrow";
        views?: ("2d" | "3d")[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    color? depth? direction headLength? id label? labelShow? length? origin qids? role? size? 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

    direction: [number, number, number]
    headLength?: number

    mm, default 0.3 x length; the thickness follows it (head radius 0.4 x headLength, shaft a third of that)

    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"

    length?: number
    origin: [number, number, number]
    qids?: string[]

    Related model objects

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

    Settings

    Member Visibility

    On This Page

    Properties