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

    Interface OverlayAreaItem

    Planar polygons (flat x,y rings, not closed) and circles, on the plane z or in plane

    interface OverlayAreaItem {
        circles?: { center: [number, number]; radius: number }[];
        color?: string;
        depth?: "always" | "test" | "ghost";
        id: string;
        label?: string;
        labelShow?: "always" | "hover";
        lift?: number;
        plane?: { normal: number[]; origin: number[]; xAxis: number[] };
        polygons?: { holes?: number[][]; outer: number[] }[];
        qids?: string[];
        role?: OverlayRole;
        storey?: string;
        style?: { fill?: number; hatch?: string | null; outline?: boolean };
        tooltip?: string;
        type: "area";
        views?: ("2d" | "3d")[];
        z?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    circles? color? depth? id label? labelShow? lift? plane? polygons? qids? role? storey? style? tooltip? type views? z?

    Properties

    circles?: { center: [number, number]; radius: number }[]
    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"

    lift?: number

    mm above the plane, default 15

    plane?: { normal: number[]; origin: number[]; xAxis: number[] }
    polygons?: { holes?: number[][]; outer: number[] }[]
    qids?: string[]

    Related model objects

    role?: OverlayRole
    storey?: string
    style?: { fill?: number; hatch?: string | null; outline?: boolean }
    tooltip?: string
    type: "area"
    views?: ("2d" | "3d")[]
    z?: number

    Settings

    Member Visibility

    On This Page

    Properties