Skip to main content
Each sheet becomes one page with vector linework.

Import

Example

Notes

  • Without sheetIds, Floorkit exports all sheets.
  • The result is a Blob. Your app downloads it or uploads it.
  • If a sheet shows raster views, prepare the images first and pass them in rasterViews.
  • If Floorkit cannot draw a view, the promise rejects. You do not get a partial PDF.
  • A deployed site needs a valid hostname key, including a non-commercial demo. See Licensing.

Signature

Parameters

ProjectFile
required
string[]
ProjectExportOptions
Default: {}.

Returns

sheetsToPdf

Every sheet as one multi-page PDF, in document order.

Types

ProjectExportOptions

RasterViewBatch
Prepared committed raster content for named isometric, section and elevation views.
ExportOptions['style']
Per-call paper style override.
string
Title-block auto fields; the project model’s name or id supplies the default name.
string
PaperRenderDeps['templates']
Custom templates and style presets for this export.
PaperRenderDeps['paperStyles']

ExportOptions

Per-call options for the exporter’s methods.
PaperStyleInput
Draw this export in a paper style — a builtin id ("ink-sketch"), a document-registered id, or an inline overlay — for this call only, without touching the document. Outranks the document’s, the sheet’s and the viewport’s own style; absent means “as the document says”.
Last modified on October 12, 2026