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

    Interface OverlayManager

    interface OverlayManager {
        add(
            overlay: Overlay,
            options?: { fit?: boolean; key?: string; persistent?: boolean },
        ): OverlayHandle | null;
        clear(): void;
        get(key: string): OverlayHandle | undefined;
        off(event: string, handler: (...args: any[]) => void): void;
        on(
            event: "overlay_hover",
            handler: (
                item: OverlayItemEvent | null,
                screenPosition: { x: number; y: number },
            ) => void,
        ): void;
        on(event: "overlay_click", handler: (item: OverlayItemEvent) => void): void;
        on(
            event: "overlay_stale",
            handler: (
                info: {
                    boundVersion: string;
                    loadedVersion: string;
                    overlayId: string;
                },
            ) => void,
        ): void;
        remove(key: string): void;
    }
    Index

    Methods

    • key replaces an earlier overlay with that key; fit fits the camera once it is placed; persistent keeps it through Viewer3d.resetResults() (markers the user switched on), default false

      Parameters

      • overlay: Overlay
      • Optionaloptions: { fit?: boolean; key?: string; persistent?: boolean }

      Returns OverlayHandle | null

    • Removes every overlay, persistent ones included

      Returns void

    • Parameters

      • key: string

      Returns OverlayHandle | undefined

    • Parameters

      • event: string
      • handler: (...args: any[]) => void

      Returns void

    • Parameters

      • event: "overlay_hover"
      • handler: (
            item: OverlayItemEvent | null,
            screenPosition: { x: number; y: number },
        ) => void

      Returns void

    • Parameters

      Returns void

    • Parameters

      • event: "overlay_stale"
      • handler: (
            info: { boundVersion: string; loadedVersion: string; overlayId: string },
        ) => void

      Returns void

    • Parameters

      • key: string

      Returns void