spatial-monorepo / core/src / UseFloorResult
Interface: UseFloorResult
Defined in: packages/core/src/hooks/useFloor.ts:12
Properties
current
current:
LevelFeature|undefined
Defined in: packages/core/src/hooks/useFloor.ts:14
The active LevelFeature for this building, or undefined.
levels
levels:
LevelFeature[]
Defined in: packages/core/src/hooks/useFloor.ts:22
All levels belonging to this building.
resetVisibility
resetVisibility: () =>
void
Defined in: packages/core/src/hooks/useFloor.ts:20
Clear the visibility filter (show all floors).
Returns
void
setCurrentByOrdinal
setCurrentByOrdinal: (
n) =>void
Defined in: packages/core/src/hooks/useFloor.ts:16
Set the active floor by ordinal number.
Parameters
n
number
Returns
void
showUpToOrdinal
showUpToOrdinal: (
n) =>void
Defined in: packages/core/src/hooks/useFloor.ts:18
Show floors up to and including ordinal n.
Parameters
n
number
Returns
void