UI Framework ReferenceIWidgetOptionParam

Interface: IWidgetOptionParam

Provides advanced settings for options.

Hierarchy

  • IOption

    IWidgetOptionParam

Index

Properties

Methods

Properties

description

description: string

Inherited from void

Defined in src/shared/ecommerce-drivers/src/Base/Interfaces/IOption.ts:9


hidden

hidden: boolean

Defined in src/widgets/au-widget-option/au-widget-option.ts:201

If true, hides this option.


id

id: number

Inherited from void

Defined in src/shared/ecommerce-drivers/src/Base/Interfaces/IOption.ts:7


onAvailableOptionValueChange

onAvailableOptionValueChange: IEvent‹IOption, IOptionValue[]›

Inherited from void

Defined in src/shared/ecommerce-drivers/src/Base/Interfaces/IOption.ts:23

Available option values change event


Optional onChange

onChange? : Function | Function[]

Defined in src/widgets/au-widget-option/au-widget-option.ts:205

A single function or an array of functions that will be executed when the option value is changed.


onOptionValueChange

onOptionValueChange: IEvent‹IOption, IOptionValue[]›

Inherited from void

Defined in src/shared/ecommerce-drivers/src/Base/Interfaces/IOption.ts:20

Option value change event


orderIndex

orderIndex: number

Defined in src/widgets/au-widget-option/au-widget-option.ts:203

The order index.


prompt

prompt: string

Inherited from void

Defined in src/shared/ecommerce-drivers/src/Base/Interfaces/IOption.ts:10


props

props: any

Inherited from void

Defined in src/shared/ecommerce-drivers/src/Base/Interfaces/IOption.ts:14


required

required: boolean

Inherited from void

Defined in src/shared/ecommerce-drivers/src/Base/Interfaces/IOption.ts:13


subType

subType: string

Inherited from void

Defined in src/shared/ecommerce-drivers/src/Base/Interfaces/IOption.ts:12


title

title: string

Inherited from void

Defined in src/shared/ecommerce-drivers/src/Base/Interfaces/IOption.ts:8


type

type: string

Inherited from void

Defined in src/shared/ecommerce-drivers/src/Base/Interfaces/IOption.ts:11


values

values: PointedArray‹IWidgetOptionValue

Overrides void

Defined in src/widgets/au-widget-option/au-widget-option.ts:207

the option values as defined in the ecommerce-driver.

Methods

clone

clone(): IInitiable

Inherited from void

Defined in src/shared/ecommerce-drivers/src/Base/Interfaces/IInitiable.ts:3

Returns:IInitiable


init

init(model: any): void

Inherited from void

Defined in src/shared/ecommerce-drivers/src/Base/Interfaces/IInitiable.ts:2

Parameters:

Name Type
model any

Returns:void


matchesModel

matchesModel(model: any): boolean

Inherited from void

Defined in src/shared/ecommerce-drivers/src/Base/Interfaces/IInitiable.ts:7

Parameters:

Name Type
model any

Returns:boolean


matchesPartial

matchesPartial(model: Partial‹IInitiable›): boolean

Inherited from void

Defined in src/shared/ecommerce-drivers/src/Base/Interfaces/IInitiable.ts:8

Parameters:

Name Type
model Partial‹IInitiable›

Returns:boolean


mergeWithModel

mergeWithModel(other: any): IInitiable

Inherited from void

Defined in src/shared/ecommerce-drivers/src/Base/Interfaces/IInitiable.ts:4

Parameters:

Name Type
other any

Returns:IInitiable


mergeWithPartial

mergeWithPartial(other: Partial‹IInitiable›): IInitiable

Inherited from void

Defined in src/shared/ecommerce-drivers/src/Base/Interfaces/IInitiable.ts:5

Parameters:

Name Type
other Partial‹IInitiable›

Returns:IInitiable


updateAvailableOptionValues

updateAvailableOptionValues(availableValues: IOptionValue[]): void

Inherited from void

Defined in src/shared/ecommerce-drivers/src/Base/Interfaces/IOption.ts:29

Update available option values

Parameters:

Name Type
availableValues IOptionValue[]

Returns:void


updateOptionValue

updateOptionValue(values: Array‹IOptionValue | string›): void

Inherited from void

Defined in src/shared/ecommerce-drivers/src/Base/Interfaces/IOption.ts:26

Update option selected value

Parameters:

Name Type
values Array‹IOptionValue | string›

Returns:void


validateModel

validateModel(model: any): boolean

Inherited from void

Defined in src/shared/ecommerce-drivers/src/Base/Interfaces/IInitiable.ts:6

Parameters:

Name Type
model any

Returns:boolean