Skip to main content
Do this before you export a sheet that shows such a view.

Import

Example

Notes

  • Give a provider that renders the image. createProjectRasterViewProvider makes one from your renderer.
  • The image size follows the largest viewport that shows the view, and the DPI that you set.
  • Prepare the images again after a change of the model, the view or the assets. A change of the sheet layout does not need new images.
  • The export rejects a missing or old image with ProjectRasterError.
  • For section and elevation images, use prepareProjectPhysicalRasterViews.

Signature

Parameters

ProjectFile
required
RasterViewProvider
required
PrepareProjectRasterViewsOptions
Default: {}.

Returns

createProjectRasterViewProvider

Render detached committed model inputs in a disposable scene using the app’s renderer.

createProjectRasterViewResolver

Resolve prepared content, rejecting missing or stale raster images at call time.

isProjectRasterViewCurrent

Check current committed model/view/assets each time; placement changes do not stale pixels.

ProjectRasterError

Stable failure codes for preparation, rendering and stale sheet content.

Types

RasterViewProvider

Apps supply browser/WebGL execution; importing Floorkit does not start a browser.

PrepareProjectRasterViewsOptions

RasterViewBatch

Derived images for sheet resolution.

ProjectRasterViewOptions

BuildOptions['assetSources']
BuildOptions['massColors']
The colours of mass parts by use; see BuildOptions.massColors. Part of the identity.

RasterDrawing

Derived PNG content with camera-plane bounds converted to paper’s Y-down convention.
'raster'
required
'meters'
required
string
required
number
required
number
required
{ min: Point2; max: Point2; }
required
readonly DrawingPrimitive[]
Derived camera-plane vectors in metres, placed above pixels using the same fixed bounds.

ProjectRasterErrorCode

RasterViewRequest

Detached committed inputs.
Readonly<BuildingModel>
required
Readonly<SavedRasterIsometricView>
required
number
required
number
required
string
required
Exact model/view/asset input identity, issued by preparation and echoed by the provider.
BuildOptions['assetSources']
BuildOptions['massColors']
The colours of mass parts by use; see BuildOptions.massColors.

RasterViewImage

Encoded browser rendering.

PreparedRasterView

Last modified on October 13, 2026