spatial-monorepo

---

spatial-monorepo / core/src / BlueDotProps

Interface: BlueDotProps

Defined in: packages/core/src/components/BlueDot.tsx:48

Properties

activeFloorId

activeFloorId: string

Defined in: packages/core/src/components/BlueDot.tsx:59

The levelId of the floor currently visible. BlueDot only renders on this floor.

---

assetId

assetId: string

Defined in: packages/core/src/components/BlueDot.tsx:50

The asset to track. Must be present in the PositionMap.

---

followMode?

optional followMode?: BlueDotFollowMode

Defined in: packages/core/src/components/BlueDot.tsx:66

Issue #476 — camera follow mode. Default false (no camera follow). Switching this prop at runtime takes effect immediately (via the underlying setupBlueDot handle's setFollowMode) — no remount of the map or this component's MapLibre sources/layers (AC3).

---

getPathBearingDeg?

optional getPathBearingDeg?: (position) => number | null | undefined

Defined in: packages/core/src/components/BlueDot.tsx:72

Required for followMode="position-and-path-direction" — return the active route's path-tangent bearing (true-north degrees) for a given position, typically (pos) => navigation.trackCoordinate(pos)?.pathBearingDeg.

Parameters

position

PositionUpdate

Returns

number | null | undefined

---

onFollowDisengaged?

optional onFollowDisengaged?: () => void

Defined in: packages/core/src/components/BlueDot.tsx:78

Called once when a user pan/zoom/rotate/pitch gesture disengages an active follow mode (AC4) — use it to show a "Recenter" affordance. Bump reengageToken (e.g. on that button's click) to resume following.

Returns

void

---

positionMapRef?

optional positionMapRef?: MutableRefObject`<PositionMap>`

Defined in: packages/core/src/components/BlueDot.tsx:57

A React ref whose .current is a Map<assetId, PositionUpdate>. If not provided, the component creates and manages its own internal ref. Pass your own ref when you want to share the map with RTLSLayer or populate it programmatically (e.g. in tests).

---

reengageToken?

optional reengageToken?: string | number

Defined in: packages/core/src/components/BlueDot.tsx:85

Change this value (e.g. increment a counter in a "Recenter" button's click handler) to re-engage camera follow after a user gesture disengaged it — the recenter-button convention documented for AC4. Any value change re-arms follow; the value itself is otherwise unused.