Class AuWidgetProductInformationAJAX

Package: ui-framework

Constructors

AuWidgetProductInformationAJAX()

Declaration

new AuWidgetProductInformationAJAX()

Properties

backOfficeUrl

Declaration

string backOfficeUrl

Property Value

Type	Description
string

costDetails

Declaration

ProductCostDetailsDto costDetails

Property Value

Type	Description
ProductCostDetailsDto

currencyCode

Declaration

string currencyCode

Property Value

Type	Description
string

currentChoices

Declaration

Record<string, number[]> currentChoices

Property Value

Type	Description
Record<string, number[]>

designs

Declaration

ProductInformationDesign[] designs

Property Value

Type	Description
ProductInformationDesign[]

designsSettings

Declaration

ApiParams designsSettings

Property Value

Type	Description
ApiParams

driverChoices

Declaration

Record<string, number[]> driverChoices

Property Value

Type	Description
Record<string, number[]>

isPreselectSelectionStrategy

Declaration

boolean isPreselectSelectionStrategy

Property Value

Type	Description
boolean

mockups

Declaration

ProductInformationMockup[] mockups

Property Value

Type	Description
ProductInformationMockup[]

mockupsSettings

Declaration

ApiParams mockupsSettings

Property Value

Type	Description
ApiParams

options

Declaration

ProductInformationOption[] options

Property Value

Type	Description
ProductInformationOption[]

params

Compiled widget configuration.

Declaration

params: any

Property Value

Type	Description
any	Compiled widget configuration.

price

Declaration

number price

Property Value

Type	Description
number

priceIsFetching

Declaration

boolean priceIsFetching

Property Value

Type	Description
boolean

productId

Declaration

string | number productId

Property Value

Type	Description
string | number

productLinkId

Declaration

string | number productLinkId

Property Value

Type	Description
string | number

productVersionId

Declaration

string | number productVersionId

Property Value

Type	Description
string | number

quantity

Declaration

number quantity

Property Value

Type	Description
number

reference

Declaration

string reference

Property Value

Type	Description
string

selectedVariantSku

Declaration

string selectedVariantSku

Property Value

Type	Description
string

selectionStrategy

Declaration

SelectionStrategy selectionStrategy

Property Value

Type	Description
SelectionStrategy

storefrontId

Declaration

string storefrontId

Property Value

Type	Description
string

storefrontUserId

Declaration

string storefrontUserId

Property Value

Type	Description
string

summary

Declaration

any summary

Property Value

Type	Description
any

template

Declaration

static any template

Property Value

Type	Description
any

tenantId

Declaration

number tenantId

Property Value

Type	Description
number

token

Declaration

string token

Property Value

Type	Description
string

variants

Declaration

ProductInformationVariant[] variants

Property Value

Type	Description
ProductInformationVariant[]

variantsHashMap

Declaration

Record<string, number[]>[] variantsHashMap

Property Value

Type	Description
Record<string, number[]>[]

variantsSettings

Declaration

ApiParams variantsSettings

Property Value

Type	Description
ApiParams

Methods

checkInitDependenciesWidgets()

Returns an array of widget names, due to which the current widget cannot receive parameters.

Declaration

function checkInitDependenciesWidgets()

Returns

Type	Description
string[]

exportWidgetData(boolean)

Declaration

function exportWidgetData(force: boolean)

Parameters

Type	Name	Description
boolean	force

Returns

Type	Description
Promise<any>

getDesignVariants(number, ApiParams)

Declaration

function getDesignVariants(productId: number, params: ApiParams)

Parameters

Type	Name	Description
number	productId
ApiParams	params

Returns

Type	Description
Promise<PagedOfProductVariantDesignDto>

getMockupVariants(number, ApiParams)

Declaration

function getMockupVariants(productId: number, params: ApiParams)

Parameters

Type	Name	Description
number	productId
ApiParams	params

Returns

Type	Description
Promise<PagedOfProductVariantDesignDto>

getProductVariants(number, ApiParams)

Declaration

function getProductVariants(productId: number, params: ApiParams)

Parameters

Type	Name	Description
number	productId
ApiParams	params

Returns

Type	Description
Promise<PagedOfProductVariantDto>

resetPreloaderState()

Declaration

function resetPreloaderState()

restoreWidgetFromData(any, boolean)

Declaration

function restoreWidgetFromData(data: any, force: boolean)

Parameters

Type	Name	Description
any	data
boolean	force

Returns

Type	Description
Promise<void>

showPreloader(boolean, string | string[], number)

Shows a preloader.

"onClick": [
  "{{#function main.showPreloader(true, 'Creating print files...')}}",
  "{{#function $['editor'].getHiResImages(800,800)}}",
  "{{#function main.showPreloader(false)}}"
]

Declaration

function showPreloader(isPreload: boolean, message: string | string[], timeout: number)

Parameters

Type	Name	Description
boolean	isPreload	If true, enables the preloader.
string | string[]	message	A text message that appears next to the preloader.
number	timeout

showToast(string, number)

Shows a toast.

return editor.loadUserInfo(data)
    .catch(err => {
        this.widget.showToast("Error: Invalid data");
        console.log(err);
    });

Declaration

function showToast(data?: string, duration?: number)

Parameters

Type	Name	Description
string	data	A string message to display in the toast.
number	duration	Defines how long to show the toast for.