Interface: OverlayCollection<MetadataType>
@cognite/reveal.OverlayCollection
Type parameters
| Name |
|---|
MetadataType |
Methods
addOverlays
▸ addOverlays(overlays): Overlay3D<MetadataType>[]
Add overlays to the collection.
Parameters
| Name | Type | Description |
|---|---|---|
overlays | OverlayInfo<MetadataType>[] | Overlays to add to the collection. |
Returns
Overlay3D<MetadataType>[]
The added overlays.
Defined in
packages/3d-overlays/src/OverlayCollection.ts:28
getOverlays
▸ getOverlays(): Overlay3D<MetadataType>[]
Get all overlays in the collection.
Returns
Overlay3D<MetadataType>[]
Defined in
packages/3d-overlays/src/OverlayCollection.ts:21
removeAllOverlays
▸ removeAllOverlays(): void
Remove all overlays from the collection.
Returns
void
Defined in
packages/3d-overlays/src/OverlayCollection.ts:39
removeOverlays
▸ removeOverlays(overlays): void
Remove overlays from the collection.
Parameters
| Name | Type | Description |
|---|---|---|
overlays | Overlay3D<MetadataType>[] | Overlays to remove from the collection. |
Returns
void
Defined in
packages/3d-overlays/src/OverlayCollection.ts:34
setVisibility
▸ setVisibility(visibility): void
Sets whether overlays in the collection should be visible.
Parameters
| Name | Type |
|---|---|
visibility | boolean |
Returns
void