Class Configurator

Readonlyidentifier

StaticCOLOR_CODE_MISSING

configurationState

• get configurationState(): undefined | ConfigurationAPIModel

  Current state of configuration

  Returns undefined | ConfigurationAPIModel

countries

• get countries(): { code: string; name: string }[]

  List of available countries

  Returns { code: string; name: string }[]

currency

• get currency(): null | string

  Currency used for prices

  Returns null | string

dataProcessingAgreementUrl

• get dataProcessingAgreementUrl(): null | string

  URL of data-processing agreement

  Returns null | string

defaultCountryCode

• get defaultCountryCode(): null | string

  Default country code

  Returns null | string

demandFormContactRequirements

• get demandFormContactRequirements(): DemandFormContactRequirements

  Contact requirements during checkout

  Returns DemandFormContactRequirements

demandFormType

• get demandFormType(): DemandFormType

  Type of form displayed during checkout

  Returns DemandFormType

extraData

• get extraData(): Record<string, unknown>

  Miscellaneous extra data for the configurator

  Returns Record<string, unknown>

fileName

• get fileName(): string

  File-suitable name for the configurator's output

  Returns string

language

• get language(): string

  Language of the configurator

  Returns string

name

• get name(): string

  Human-readable name of the configurator

  Returns string

parameters

• get parameters(): Parameter[]

  All available parameters of the configurator

  Returns Parameter[]

preferPricesWithoutVat

• get preferPricesWithoutVat(): boolean

  Whether prices without VAT should be preferred over prices with VAT

  Returns boolean

preferredPriceKey

• get preferredPriceKey(): "with_vat" | "without_vat"

  Preferred key of PriceAPIModel based on preferPricesWithoutVat

  Returns "with_vat" | "without_vat"

selectedOptions

• get selectedOptions(): ParameterOptions

  Selected options of each parameter

  Returns ParameterOptions

viewerSceneUrl

• get viewerSceneUrl(): ComputedRef<null | string>

  Returns ComputedRef<null | string>

getColor

• getColor(identifier: string): ColorAPIModel

  Get color by its identifier

  Parameters

  • identifier: string

  Returns ColorAPIModel

  Throws

  When color is not found

getColorCode

• getColorCode(identifier?: null | string): Color

  Get HTML color code by color's identifier

  Returns COLOR_CODE_MISSING when color is not found

  Parameters

  • Optionalidentifier: null | string

  Returns Color