interface ExportImageParams {
    background?: string | boolean;
    cameraPositioning?: ExportImageCameraPositioning;
    dimensions?: ExportImageDimensions;
    fronts?: boolean;
    measurement?: boolean;
    type: ExportImageType;
}

Properties

background?: string | boolean

Defines the background of the rendered images.

Pass false to render an image with a transparent background.

Pass true to render an image with the default background color.

Pass an hex color string to render an image with a custom background color.

true
cameraPositioning?: ExportImageCameraPositioning

The size of the image in pixels

fronts?: boolean

Wether to show fronts in the image.

Note: This expects the layer Front to be configured for all graphical front objects.

true
measurement?: boolean

Wether to show measurement in the image.

false

The type of image to render.

See the definition of the RenderImageType enum for possible values and their meaning.