# `Overlays.hotspots`

> Contract 2.0.0 · package sha256 `a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e` · generated from `configurator-runtime.d.ts` by `services/onsite-scripter/scripts/build-contract-docs.mjs`; edit the source, not this file.

Property of [`Overlays`](Overlays.md) · stable · since 2.0.0 · called as `session.overlays.hotspots`

```ts
readonly hotspots: {
  set(badges: readonly HotspotBadge[]): void;
  clear?(): void;
};
```

Runtime-drawn `<button>` badges with a text label, at world points.

## Members

| Member | Summary |
| --- | --- |
| [`set`](Overlays.hotspots.set.md) | Replaces every badge (an empty array removes them). |
| [`clear`](Overlays.hotspots.clear.md) | Removes every badge, as `set([])` does, and as `anchors.clear()` removes the anchors. |

## Generic-API test (spec 3.1)

| Rule | Result |
| --- | --- |
| 1. Neutral name | pass: `hotspots` names no product |
| 2. A precedent | pass: [Babylon.js SpriteManager](https://github.com/BabylonJS/Babylon.js/blob/master/packages/dev/core/src/Sprites/spriteManager.ts) (row `K50`); [model-viewer (ar, camera-orbit, auto-rotate)](https://modelviewer.dev/docs/) (row `K50`) |
| 3. Two apps, or labs | pass: 18 apps (ledger: app-ddfb017681, app-fc07850558, app-fc306ec3dc; fleet cross-check: app-37356bf09f, app-4fd23bc869, app-822bb9d6aa, app-8675b3225c, app-bcb7ef21da, app-c1384707fc, app-e3b47169bc, app-e61a0b42ad and 7 more) |
| 4. The cheaper fix first | decided per need in Appendix B: rows `K50` at tier stable (a member only where no rule, data, asset or app code serves the need) |