Instant Design Components

PVSystemDesigner props ​

API context ​

rooftopGeometryResponse ​

  • Type: RooftopGeometryResponse
  • Default: —

The response from the POST Find or Create a Rooftop Geometry endpoint.

pvSystemResponse ​

  • Type: PVSystemResponse
  • Default: —

The response from the POST PV System endpoint.

pvSystemRequestParams ​

  • Type: PVSystemRequestParams
  • Default: {}

The request body for the POST PV System endpoint.

onPVSystemRequestParamsChange ​

  • Type: (pvSystemRequestParams: PVSystemRequestParams) => void
  • Default: —

A callback function to be performed when one of the POST PV System parameters is changed.

Designer configuration ​

options ​

  • Type: Options
  • Default: {}

User interface options for the PV System Designer.

Fields ​

FieldType
alignmentOffset{ xOffset: number, yOffset: number }
alignmentMode'intro' | 'lightweight'
interactionMode'default' | 'roof_faces' | 'panel_orientation' | 'toggle_panels'
initialTargetNumPanelsnumber
initialTargetSystemSizenumber
setbackEditableboolean
suppressLoadingSpinnerboolean

showPresentationView ​

  • Type: boolean
  • Default: false

If true, show a non-editable version of the PV system.

showImagesOnly ​

  • Type: boolean
  • Default: false

If true, show only the satellite and SVG images, without sidebars. This will behave like presentation view, but without the left bar or the bottom system information.

theme ​

  • Type: glow | original
  • Default: glow

The theme to use for the PV System Designer.

Options: glow | `original

gradient ​

  • Type: yellow-brown | yellow-orange-black | yellow-red-purple
  • Default: yellow-orange-black

The gradient to use for the PV System Designer.

Options: yellow-brown | yellow-orange-black | `yellow-red-purple

Other props ​

className ​

  • Type: string
  • Default: —

Class names to apply to the PV System Designer's container.

hideAttribution ​

  • Type: boolean
  • Default: false

If true, hide satellite imagery attribution.

minPanels ​

  • Type: number
  • Default: 1

The minimum number of panels allowed. Defaults to 1. Set to 0 to allow zero panels (useful for labeling mode).

onAlignmentOffsetComplete ​

  • Type: (options: Options) => void
  • Default: —

A callback function invoked when the user completes adjusting the alignment offset.

onOptionsChange ​

  • Type: (options: Options) => void
  • Default: —

A callback function to be performed when one of the user interface options changes.

qaScoreThreshold ​

  • Type: number
  • Default: 0.8

The QA score threshold for applying the high QA score styling. Defaults to 0.8. Set to 0 to disable QA score filtering (useful for labeling mode).

showDisabledPanelsInPresentation ​

  • Type: boolean
  • Default: false

When true, disabled panels will be visible in presentation mode. Useful for labeling mode where you want to see all panel areas.

showIrradiance ​

  • Type: boolean
  • Default: —

To show the irradiance view in the PV System Designer

suppressLoadingSpinner ​

  • Type: boolean
  • Default: false

If true, hide the PV System Designer's loading spinner.

Deprecated props ​

alternateTheme ​

  • Type: boolean
  • Default: false

DEPRECATED: Use gradient instead (and consider combining with theme). If true, use the alternate theme for the PV System Designer.