Layers and Layer Groups
If you were to show every single piece of data that PlanStudio allows you to collect in a single image, that image would be too cluttered to be understandable. When presenting plans to people, it’s useful to only show the things that are relevant to those people.
PlanStudio achieves this by presenting plans as a stack of layers and lets you show/hide layers based on what you’re working on.
Layers are very fine-grained. Things like walls, hinged doors, sliding doors, and roller doors are all presented by different layers. While this allows for precise control over what is and isn’t visible, this can sometimes be overwhelming to manage. For this reason, PlanStudio associates each layer with a layer group, such as “Structure”, “Equipment”, or “Navigation”. When you enable a layer group, you enable all layers that are part of that group.
This page contains a listing of all layer groups and layers. When using a layer/group with the API, be sure to use its Layer ID.
- Layer groups
- Layers
- The Satellite layer is not available in the Plans Static API
- Regarding new layers and API stability
Layer groups
| Layer group name (in PlanStudio) | Layer ID |
|---|---|
| Satellite (not available in Plan Static API) | satellite |
| Graphic | graphic |
| Grid | grid |
| Site | site |
| Structure | structure |
| Fire Resistance | indicators |
| Zones | zone |
| Evacuation | navigation |
| Equipment | equipment |
| Annotations | annotations |
| Nav Mesh | navMesh |
| Networks | network |
| Diagrams | sign |
Layers
This list of layers is in bottom-to-top display order. That is, layers at the end of the list are always shown on top of layers at the beginning of the list.
| Layer name (in PlanStudio) | Layer Id | Layer Group ID |
|---|---|---|
| Satellite (not available in Plan Static API) | satellite |
satellite |
Graphics (Show in Diagrams must be enabled per graphic) |
graphic |
graphic |
| Interior Zones | interiorZone |
zone |
| Common Zones | commonZone |
zone |
| Tenanted Zones | tenantedZone |
zone |
| Other Tenanted Zones | otherTenantedZone |
zone |
| Identified Zones | identifiedZone |
zone |
| Presentation Zones | presentationZone |
zone |
| Fire Alarm Zones | alarmZone |
zone |
| Zoned Icon Fills | zonedIconFill |
equipment |
| Grid | grid |
grid |
| Rooms | room |
zone |
| Terrain | terrain |
structure |
| Fixtures | fixture |
structure |
| Walls | wall |
structure |
| Smoke Walls | smokeWallIndicator |
indicators |
| Fire Walls | fireWallIndicator |
indicators |
| Details | detail |
structure |
| Frames | frame |
structure |
| Smoke Doors | smokeDoorIndicator |
indicators |
| Fire Doors | fireDoorIndicator |
indicators |
| Hinged Doors | hingedDoor |
structure |
| Sliding Doors | slidingDoor |
structure |
| Folding Doors | foldingDoor |
structure |
| Roller Doors | rollerDoor |
structure |
| Windows | window |
structure |
| Stairways | stairway |
structure |
| Nav Mesh | navMesh |
navMesh |
| Networks | network |
network |
| Portals | portal |
navigation |
| Annotations | annotation |
annotations |
| Security Cameras | securityCamera |
equipment |
| Evacuation Targets | evacuationTarget |
navigation |
| Evac Signs | evacSign |
equipment |
| Assembly Areas | assemblyArea |
navigation |
| Leader Line Icons | leaderLineIcon |
equipment |
| Fire Alarm Zone Icons | alarmZoneLeaderLine |
zone |
| Zoned Icons | zonedIcon |
equipment |
| Draft Watermark | draftWatermark |
sign |
| Floor & Plan Footprints | footprints |
site |
| Path Labels | pathLabel |
structure |
| Final Exits | finalExit |
navigation |
| Notes and Photos | notesAndPhotos |
annotations |
| North Indicator | northIndicator |
sign |
| You Are Here Indicator | yahIndicator |
sign |
| Fixed Icons | fixedIcon |
equipment |
| Exit Signs | exitSign |
equipment |
The Satellite layer is not available in the Plans Static API
For licensing reasons, the Satellite layer is not available for site plans rendered by the Plans Static API. We support two alternatives:
- Use the Plans Embed API (which supports the Satellite layer) to embed an interactive rendering of a site plan instead of using a static image.
- Render your own satellite imagery and use the georeferencing endpoint to get coordinates that will allow you to overlay Static API renderings onto your own imagery.
Regarding new layers and API stability
As new layers are added to PlanStudio over time, they will be added to the appropriate layer groups. This means that existing Static API usages that refer to those layer groups will automatically start showing new layers.
This is not considered a breaking API change.
If you want to only show a specific set of layers and do not want things to change even as new layers are added, you should explicitly list all of those layers in your request, instead of using layer groups.