Floor and Unit data extraction

josepht21 — Thu, 20 Mar 2025 12:57:34 GMT

Hi! I am new to Forma API and I am trying to get the data of the floor and units in the floor.

What would be the best way to get the Floor Data and also the units in it (like type, geometry and such).

Thanks in advance!

Re: Floor and Unit data extraction

havard.hoiby — Tue, 01 Apr 2025 19:16:52 GMT

Hi Joseph 🙂

What you can do is to inspect the grossFloorAreaPolygons:
https://app.autodeskforma.com/forma-embedded-view-sdk/docs/classes/elements.RepresentationsApi.html#grossfloorareapolygons

interface GrossFloorAreaPolygon { areaType?: GrossFloorAreaType; elevation: number; grossFloorPolygon: MultiRingPolygon; }

You will need to get the element hierarchy recursively from the building level and call this on each returned element and aggregate them.

The simples way is to call `Forma.elements.getByPath` with the recursive argument set: https://app.autodeskforma.com/forma-embedded-view-sdk/docs/classes/elements.ElementsApi.html#getbypath

There is no standard way to read out floors, but grouping the gross floor areas by elevation would be one approximation. The reason for this is that we do not have a single source of buildings in Forma, and you will need to rely on the representation only to interpret what the elements are.

- Håvard

topic Floor and Unit data extraction in Forma Site Design Developer Forum

Floor and Unit data extraction

Re: Floor and Unit data extraction