Skip to content

Commit 96635ff

Browse files
committed
getDefinition
1 parent e003f5a commit 96635ff

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/api-reference/space/space.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,14 @@ To check if the viewer has finished initializing and is ready for API methods to
8686
space.isViewerStarted() => boolean
8787
```
8888

89+
### Zero-latency space definition query
90+
91+
To get the space definition, we typically advise to use the [QueryClient](/api-reference/queryclient/spaces#getspace), but you can also get the currently loaded definition with zero latency using the method below:
92+
93+
```ts
94+
space.getDefinition() => object
95+
```
96+
8997
## Picking mode
9098

9199
In order to know where a user clicks or taps in the floor plan, you can enable picking mode. For example, this is useful if you have an admin interface to configure floor plans and position sensors on it, or if you want to let users point to the location of an issue they are reporting. Enabling picking mode is done as follows.

0 commit comments

Comments
 (0)