ConfiguratorOptions | idearoom

Optional settings to initialize the configurator with

Hierarchy

ConfiguratorOptions

Index

Properties

Optional dealer

dealer: string

An optional dealer key to be used by vendors with dealer networks.

Optional hash

hash: string

A hash value that references a previous save to be loaded at startup

Optional header

header: boolean

Toggle the header section on/off

Optional initializeWithVisibleFrame

initializeWithVisibleFrame: boolean

Instantiates the configurator with the frame visible from the start, rather than waiting the page to load first.

This is a workaround for when the configurator page fails to load the initial payload on time (2.5 seconds) for Postmate handshake, you probably don't need to enable this flag.

Optional menuSaveButtons

menuSaveButtons: boolean

Toggle the save buttons in the right menu on/off

Optional postalCode

postalCode: string

A postal code to initialize with. Might be ignored when loading a previous save from a hash saved with a different postal code.

Optional previewMode

previewMode: boolean

Toggle preview mode on/off

Optional timeout

timeout: number

Timeout in miliseconds. How long we'll wait for the configurator to answer before throwing a Timeout error.

Default is 60000 (60 seconds).

Optional uuid

uuid: string

A uuid that can be included with a hash value to reference a previous save.

Optional verbose

verbose: boolean

Provide additonal logging in the console

Optional viewerOnly

viewerOnly: boolean

Hide all elements of the interface except for the 3D view.

Generated using TypeDoc