Class AssemblyCustomisationStepData

Brief

Represents an individual customisation step.

Hierarchy

CustomisationStepData<StyleProductAssembly>
- AssemblyCustomisationStepData

Index

Constructors

Properties

_productDataProvider description imageSrc internalData preventClick text

Methods

generateAssemblyCustomisationOptionData generateOptionData getFilteredOptionIds getGridInfos getSelectedOptionIds

Constructors

constructor

new AssemblyCustomisationStepData(text: string, imageSrc: string, description: string, internalData: StyleProductAssembly): AssemblyCustomisationStepData
Parameters
- text: string
- imageSrc: string
- description: string
- internalData: StyleProductAssembly
Returns AssemblyCustomisationStepData
Inherited from CustomisationStepData.constructor
- Defined in js/modularconfig/model/CustomisationData.ts:78

Properties

_productDataProvider

_productDataProvider: ProductDataProvider = ...

description

description: string

Brief

Additional text shown on each step (ex: selected product)

imageSrc

imageSrc: string

Brief

The string url of the image shown on the step.

internalData

internalData: StyleProductAssembly

preventClick

preventClick: boolean

text

text: string

Brief

The text shown on the step.

Methods

`Protected` generateAssemblyCustomisationOptionData

generateAssemblyCustomisationOptionData(productInfo: ProductInfo): Promise<CustomisationOptionData<{}>>
Parameters
- productInfo: ProductInfo
Returns Promise<CustomisationOptionData<{}>>
- Defined in js/modularconfig/model/AssemblyCustomisationData.ts:59

generateOptionData

generateOptionData(): Promise<CustomisationOptionScreenData>
Returns Promise<CustomisationOptionScreenData>
Overrides CustomisationStepData.generateOptionData
- Defined in js/modularconfig/model/AssemblyCustomisationData.ts:43

getFilteredOptionIds

getFilteredOptionIds(options: ICustomisationOptionData[], optionToFilter: Map<string, IFilter>, filterToOptions: Map<IFilter, string[]>): string[]
Parameters
- options: ICustomisationOptionData[]
- optionToFilter: Map<string, IFilter>
- filterToOptions: Map<IFilter, string[]>
Returns string[]
Overrides CustomisationStepData.getFilteredOptionIds
- Defined in js/modularconfig/model/AssemblyCustomisationData.ts:24

getGridInfos

getGridInfos(optionIds: string[]): GridInfo[]
Parameters
- optionIds: string[]
Returns GridInfo[]
Overrides CustomisationStepData.getGridInfos
- Defined in js/modularconfig/model/AssemblyCustomisationData.ts:14

getSelectedOptionIds

getSelectedOptionIds(): string[]
Get the main selected option id

Returns string[]
Overrides CustomisationStepData.getSelectedOptionIds
- Defined in js/modularconfig/model/AssemblyCustomisationData.ts:20

Generated using TypeDoc