Skip to main content
The plan shows the footprint of each element. It does not cut the building at a height.

Import

Example

Notes

  • The output uses metres.
  • entities selects elements by id. Without it, all elements are drawn.
  • The top view is the supported view. A request for a cut plan or a section throws an error.
  • For a cut plan, a section or an elevation of a saved building, use drawProjectView.
  • Start the geometry kernel before you create this object. See Floorkit.
Inheritance: implements DrawingExtractor

Constructor

Methods

extract

assertPlanDrawingRequest

Shared validation for extractors that compose authored plan primitives.

Types

BuildingSourceRef

ElementSourceRef

Authored identity carried independently of a drawing primitive’s visual style. The package does not export this type by name.
'element'
required
A whole saved element: a slab, a room, a mass and the like.
string
required
The saved model.
string
The building of the element; absent for an element of the site.
string
The storey of the element; absent for an element of no storey, such as a mass.
string
required
The saved id of the element.
string
The saved id of the part (segment) of the mass elementId that a plan region draws. Only the plan drawing of a mass sets it; the part resolves to its mass, and a press on it selects the part.

WallSegmentSourceRef

The package does not export this type by name.
'wall-segment'
required
string
required
string
required
string
required
string
required
The saved wall run, shared by every compiled segment.
number
required
Zero-based segment index in the saved wall run.
number
required
number
required

OpeningSourceRef

The package does not export this type by name.
'opening'
required
string
required
string
required
string
required
string
required
string
Present only while the saved opening belongs to a wall run.

ModelObjectSourceRef

A saved basic object; its current drawing can be inspected before an edit gesture exists. The package does not export this type by name.
Last modified on October 13, 2026