Interface OverlayHandle

interface OverlayHandle {
    id: string;
    resolved: boolean;
    stale: boolean;
    isLayerVisible(layerId: string): boolean;
    remove(): void;
    setLayerVisible(layerId: string, visible: boolean): void;
    update(item: OverlayItem): boolean;
    viewFit(layerId?: string): boolean;
}

Index

Properties

id resolved stale

Methods

isLayerVisible remove setLayerVisible update viewFit

Properties

`Readonly`id

id: string

`Readonly`resolved

resolved: boolean

The bound model (or a stand-in version) is loaded and the overlay is drawn

`Readonly`stale

stale: boolean

Methods

isLayerVisible

isLayerVisible(layerId: string): boolean
Parameters
- layerId: string
Returns boolean
- Defined in Viewer3D/viewer3d.d.ts:3591

remove

remove(): void
Returns void
- Defined in Viewer3D/viewer3d.d.ts:3594

setLayerVisible

setLayerVisible(layerId: string, visible: boolean): void
Parameters
- layerId: string
- visible: boolean
Returns void
- Defined in Viewer3D/viewer3d.d.ts:3590

update

update(item: OverlayItem): boolean
Replaces the item with the same id; false when there is none
Parameters
- item: OverlayItem
Returns boolean
- Defined in Viewer3D/viewer3d.d.ts:3593

viewFit

viewFit(layerId?: string): boolean
Fits the camera to the overlay or one layer; false while it is not placed
Parameters
- OptionallayerId: string
Returns boolean
- Defined in Viewer3D/viewer3d.d.ts:3596