Class: Overlay3DTool<ContentType>

@cognite/reveal/tools.Overlay3DTool

Tool for adding and interacting with 2D overlays positioned at points in

Type parameters

Name	Type
ContentType	DefaultOverlay3DContentType

Hierarchy

• Cognite3DViewerToolBase

  ↳ Overlay3DTool

Constructors

constructor

• new Overlay3DTool<ContentType>(viewer, toolParameters?): Overlay3DTool<ContentType>

Type parameters

Name	Type
ContentType	DefaultOverlay3DContentType

Parameters

Name	Type
viewer	Cognite3DViewer
toolParameters?	Overlay3DToolParameters

Returns

Overlay3DTool<ContentType>

Overrides

Cognite3DViewerToolBase.constructor

Defined in

packages/tools/src/Overlay3D/Overlay3DTool.ts:100

Methods

clear

▸ clear(): void

Removes all overlays.

Returns

void

Defined in

packages/tools/src/Overlay3D/Overlay3DTool.ts:203

---

createOverlayCollection

▸ createOverlayCollection(overlays?, options?): OverlayCollection<ContentType>

Creates new OverlayCollection.

Parameters

Name	Type	Description
overlays?	OverlayInfo<ContentType>[]	Array of overlays to add.
options?	OverlayCollectionOptions	-

Returns

OverlayCollection<ContentType>

Overlay group containing it's id.

Defined in

packages/tools/src/Overlay3D/Overlay3DTool.ts:119

---

dispose

▸ dispose(): void

Dispose of resources used by this tool

Returns

void

Overrides

Cognite3DViewerToolBase.dispose

Defined in

packages/tools/src/Overlay3D/Overlay3DTool.ts:259

---

getCollections

▸ getCollections(): OverlayCollection<ContentType>[]

Gets all added overlay collections.

Returns

OverlayCollection<ContentType>[]

Defined in

packages/tools/src/Overlay3D/Overlay3DTool.ts:161

---

getTextOverlayVisible

▸ getTextOverlayVisible(): boolean

Gets whether text overlay is visible.

Returns

boolean

Defined in

packages/tools/src/Overlay3D/Overlay3DTool.ts:196

---

getVisible

▸ getVisible(): boolean

Gets whether overlays are visible.

Returns

boolean

Defined in

packages/tools/src/Overlay3D/Overlay3DTool.ts:180

---

off

▸ off(event, eventHandler): void

Unregisters an event handler for the 'disposed'-event.

Parameters

Name	Type
event	"hover"
eventHandler	OverlayEventHandler<ContentType>

Returns

void

Overrides

Cognite3DViewerToolBase.off

Defined in

packages/tools/src/Overlay3D/Overlay3DTool.ts:236

▸ off(event, eventHandler): void

Parameters

Name	Type
event	"click"
eventHandler	OverlayEventHandler<ContentType>

Returns

void

Overrides

Cognite3DViewerToolBase.off

Defined in

packages/tools/src/Overlay3D/Overlay3DTool.ts:237

▸ off(event, eventHandler): void

Parameters

Name	Type
event	"disposed"
eventHandler	DisposedDelegate

Returns

void

Overrides

Cognite3DViewerToolBase.off

Defined in

packages/tools/src/Overlay3D/Overlay3DTool.ts:238

---

on

▸ on(event, eventHandler): void

Subscribes to overlay events.

Parameters

Name	Type	Description
event	"hover"	event to subscribe to.
eventHandler	OverlayEventHandler<ContentType>

Returns

void

Overrides

Cognite3DViewerToolBase.on

Defined in

packages/tools/src/Overlay3D/Overlay3DTool.ts:216

▸ on(event, eventHandler): void

Parameters

Name	Type
event	"click"
eventHandler	OverlayEventHandler<ContentType>

Returns

void

Overrides

Cognite3DViewerToolBase.on

Defined in

packages/tools/src/Overlay3D/Overlay3DTool.ts:217

▸ on(event, eventHandler): void

Parameters

Name	Type
event	"disposed"
eventHandler	DisposedDelegate

Returns

void

Overrides

Cognite3DViewerToolBase.on

Defined in

packages/tools/src/Overlay3D/Overlay3DTool.ts:218

---

removeOverlayCollection

▸ removeOverlayCollection(overlayCollection): void

Removes overlays that were added with addOverlays method.

Parameters

Name	Type	Description
overlayCollection	OverlayCollection<ContentType>	Id of the overlay group to remove.

Returns

void

Defined in

packages/tools/src/Overlay3D/Overlay3DTool.ts:146

---

setTextOverlayVisible

▸ setTextOverlayVisible(visible): void

Sets whether text overlay is visible. Default is false.

Parameters

Name	Type
visible	boolean

Returns

void

Defined in

packages/tools/src/Overlay3D/Overlay3DTool.ts:188

---

setVisible

▸ setVisible(visible): void

Sets whether overlays are visible.

Parameters

Name	Type
visible	boolean

Returns

void

Defined in

packages/tools/src/Overlay3D/Overlay3DTool.ts:168