Skip to main content
The reference has 103 pages. Each page shows one class, one function or one small group of related functions. A page gives you the import line, a short example, the full signature and the types that the API uses. Types and enums do not have their own pages. You find each one on the page of the API that uses it.
All names come from one package root: @opengeometry/floorkit. Lengths are in metres and the Y axis points up. Paper sizes are in millimetres.

​
Sections

Runtime

Start the geometry kernel and prepare text labels.

Primitives

Lines, arcs and closed profiles that you draw in 2D.

Shapes

Solid boxes and cylinders for furniture, massing and custom parts.

Architecture

The building document and every building element that it makes.

Datums

Levels, grids and reference planes that locate the building.

Annotations

Dimensions, labels and sheet symbols.

Drawings

Turn a saved view into vector linework and place it on a sheet.

Views

Saved views, cameras and the renderers that show them.

World

The place around the building: the world graph, the site and its zoning.

Exports

Take your design out as a PDF, a GLB or a project file.

Editor

Edit the building in the plan and in 3D, with undo and redo.

Integration (coming soon)

Connectors to other platforms.

Licensing

Apply a license key for a deployed hostname.
Last modified on October 12, 2026