> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ploterr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> The Floorkit API in 13 sections, from the first wall to the exported PDF.

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.

<Tip>
  All names come from one package root: `@opengeometry/floorkit`. Lengths are in metres and the Y
  axis points up. Paper sizes are in millimetres.
</Tip>

## Sections

<CardGroup cols={2}>
  <Card title="Runtime" icon="power-off" href="/floorkit/api/runtime/floorkit">
    Start the geometry kernel and prepare text labels.
  </Card>

  <Card title="Primitives" icon="vector-square" href="/floorkit/api/primitives/line-primitive">
    Lines, arcs and closed profiles that you draw in 2D.
  </Card>

  <Card title="Shapes" icon="shapes" href="/floorkit/api/shapes/cuboid-shape">
    Solid boxes and cylinders for furniture, massing and custom parts.
  </Card>

  <Card title="Architecture" icon="building" href="/floorkit/api/architecture/validate-building-model">
    The building document and every building element that it makes.
  </Card>

  <Card title="Datums" icon="crosshairs" href="/floorkit/api/datums/level">
    Levels, grids and reference planes that locate the building.
  </Card>

  <Card title="Annotations" icon="pen-to-square" href="/floorkit/api/annotations/line-dimension">
    Dimensions, labels and sheet symbols.
  </Card>

  <Card title="Drawings" icon="compass-drafting" href="/floorkit/api/drawings/draw-project-view">
    Turn a saved view into vector linework and place it on a sheet.
  </Card>

  <Card title="Views" icon="eye" href="/floorkit/api/views/create-project-physical-view">
    Saved views, cameras and the renderers that show them.
  </Card>

  <Card title="World" icon="globe" href="/floorkit/api/world/world-graph">
    The place around the building: the world graph, the site and its zoning.
  </Card>

  <Card title="Exports" icon="file-export" href="/floorkit/api/exports/export-project-pdf">
    Take your design out as a PDF, a GLB or a project file.
  </Card>

  <Card title="Editor" icon="pen-ruler" href="/floorkit/api/editor/building-session">
    Edit the building in the plan and in 3D, with undo and redo.
  </Card>

  <Card title="Integration (coming soon)" icon="plug" href="/floorkit/api/integration/speckle">
    Connectors to other platforms.
  </Card>

  <Card title="Licensing" icon="key" href="/floorkit/api/licensing/license-key">
    Apply a license key for a deployed hostname.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.