Customer's Canvas is honored with a 2020 InterTech Technology Award! Learn more UI Framework Reference
Index
Enumerations
- ButtonsPosition
- Direction
- GroupWidgetType
- NavigationMode
- ResizeMode
- SurfaceDimensionsValue
- modelType
Classes
- ActionsErrorToastConfig
- AuBaseSelectorWidget
- AuBaseWidget
- AuCanvas
- AuDesignEditor
- AuOptionBase
- AuWidget3DViewer
- AuWidgetAjax
- AuWidgetButton
- AuWidgetCanvas
- AuWidgetCart
- AuWidgetCheckbox
- AuWidgetColorPicker
- AuWidgetDataSheet
- AuWidgetDesignAtoms
- AuWidgetDesignEditor
- AuWidgetDndController
- AuWidgetFinishButton
- AuWidgetFinishGroup
- AuWidgetGallery
- AuWidgetGroup
- AuWidgetHelp
- AuWidgetHtml
- AuWidgetImageCarousel
- AuWidgetInputText
- AuWidgetOption
- AuWidgetOrder
- AuWidgetPreflight
- AuWidgetPreflightConfig
- AuWidgetSlider
- AuWidgetStaticText
- AuWidgetSteps
- AuWidgetUploader
- AuWizard
- AuWizardConfig
- CameraButtonDefinition
- CanvasImageItemData
- CanvasItemChanges
- CanvasItemData
- CanvasTextItemData
- CanvasWidgetCommand
- ChangeMockupCommand
- ChangedSurface
- CmykColor
- ColumnScheme
- DataSheetCellError
- DataSheetFieldData
- DataSheetTableTexts
- DesignEditorItemChanges
- DesignEditorWidgetCommand
- DownloadingModel
- ErrorModel
- FailedChecksModel
- FinishModel
- Initial
- InitialCommand
- ModifyItemsCommand
- OrigamiViewerParams
- OriginModel
- PreviewModel
- ResizeItemsCommand
- ResponseErrorContext
- RgbColor
- RuleDisplayResult
- RuleResult
- SerializedLayout
- SetBackgroundCommand
- SetPrintAreaCommand
- SetProductModel
- SetRemoteMockupCommand
- SetSerializedProduct
- SetSurfacesCommand
- SetThemeCommand
- SetViewerSettings
- StepConditionConfig
- TranslateItemsCommand
- UpdateContainerSettingsCommand
- UpdateItems
- UpdateSurfacesCommand
- VariableManager
Interfaces
- AdvancedISliderConfig
- AuWidgetGroupParam
- I3DItem
- I3DViewerParams
- IAuWidgetAjaxConfig
- IAuWidgetFinishGroupConfig
- IAuWidgetHelpParams
- IButtonConfig
- ICanvasCommandDefinition
- ICanvasDefinitionChangeLayout
- ICanvasDefinitionChangeMockup
- ICanvasDefinitionInitial
- ICanvasDefinitionModifyItems
- ICanvasDefinitionParams
- ICanvasDefinitionSetBackground
- ICanvasDefinitionSetPrintArea
- ICanvasDefinitionSetTheme
- ICanvasDefinitionSetViewerSettings
- ICartConfig
- ICheckboxConfig
- IColor
- IColorPickerConfig
- IConfiglResizeArgs
- IDepositPhotosItem
- IDesignAtomsWidgetConfig
- IDesignEditorCommandDefinition
- IDesignEditorDefinitionChangeLayout
- IDesignEditorDefinitionChangeMockup
- IDesignEditorDefinitionInitial
- IDesignEditorDefinitionModifyItems
- IDesignEditorDefinitionParams
- IDesignEditorDefinitionResizeItems
- IDesignEditorDefinitionSetBackground
- IDesignEditorDefinitionSetPrintArea
- IDesignEditorDefinitionSetTheme
- IDesignEditorDefinitionSetViewerSettings
- IDesignEditorDefinitionTranslateItems
- IDndControllerConfig
- IEditorElement
- IFinishButtonConfig
- IGalleryConfig
- IGalleryItem
- IHtmlConfig
- IImage
- IImageCarouselConfig
- IImagesSlider
- IInitialConfig
- IInputTextConfig
- ILineItem
- IOrderConfig
- IOrderInitModel
- IRequestModel
- IRestorableWidget
- ISetBackgroundParam
- ISetPrintAreaOptions
- ISetProductModelConfig
- ISetRemoteMockup
- ISetSerializedProductConfig
- ISetSurfacesOptions
- ISetViewerSettingsConfig
- ISliderConfig
- IStaticTextConfig
- ITemplateConfig
- ITranslateItemCommandConfigArgs
- IUpdateItemsCommandDefinition
- IUpdateItemsConfig
- IUpdateSurfacesCommandDefinition
- IUploaderConfig
- IVariableManager
- IViewerSettings
- IWidget
- IWidgetDataSheetColumnScheme
- IWidgetDataSheetConfig
- IWidgetDataSheetTexts
- IWidgetOptionParam
- IWidgetOptionValue
- IWidgetStepsConfig
- ItemChangeObject
- StepData
- StepHelpConfig
- Tab
- ThumbRenderResult
Type aliases
- DataSheetRow
- DownloadPosition
- ErrorsCallback
- HelpType
- ISetRemoteMockupParams
- PreflightToolStep
- ResponseType
Variables
Type aliases
DataSheetRow
Ƭ DataSheetRow: object
Type declaration:
- [ id: string]: string
DownloadPosition
Ƭ DownloadPosition: "left" | "right"
ErrorsCallback
Ƭ ErrorsCallback: function
Defines a function that should work when a request fails.
Type declaration:
▸ (errorData: ResponseErrorContext): void
Parameters:
| Name | Type |
|---|---|
errorData |
ResponseErrorContext |
HelpType
Ƭ HelpType: "modal" | "page"
A help style.
modal Represents a modal window.
page Represents a web page.
ISetRemoteMockupParams
Ƭ ISetRemoteMockupParams: ISetRemoteMockup[]
PreflightToolStep
Ƭ PreflightToolStep: "uploader" | "editor"
A preflight step.
uploader A step when users upload their images.
editor A step when users perform the preflight check, fix their files, and get previews of print-ready files.
ResponseType
Ƭ ResponseType: "text" | "blob" | "json" | "blob_url" | "status_code"
A response type specifying how to interpret the response received from the server.
text - a raw text string. The Ajax widget does not try to interpret it.
json - a JSON object. When you refer the response in your config, you can access its properties.
blob - binary data. It makes sense to use it along with some widgets that can work with binary data directly.
blob_url - binary data, but it is converted to the Blob URL, which can be used with HTML markup.
status_code - an HTTP code.
Variables
Const TOAST_DURATION
• TOAST_DURATION: 5000 = 5000
The number of milliseconds before the toast is dismissed.
Const mixed
• mixed: any = AuTranslationMixin(AuWizardConfig as any as Constructor<AuWizardConfig>)
Let promise
• promise: any