Mypixia Widget Properties
The Mypixia widget is a powerful product customization component that allows users to create personalized designs on products.
Properties Reference
| Property | Type | Required | Description |
|---|---|---|---|
canvasId | string | Yes | Unique identifier for the canvas element |
apiKey | string | No | Authentication key for the Mypixia API |
apiEndpoint | string | No | URL of the API endpoint |
initInstance | object | No | Initial canvas instance to load (default: null) |
isFromScratch | boolean | No | Whether to start with a blank canvas (default: false) |
initProductName | string | No | Initial product name to load (default: null) |
isPlainColor | string | No | Set to 'Y' if product has plain color options (default: 'N') |
instance.getDesignFormats('targetFormat') | function | No | get current design in different formats. You will get 2 files from this call. Print ready and the full design |
theme | object | Yes | Theme configuration for the widget appearance |
product | object | Yes | Product configuration for customization |
enabledModules | array of strings | No | List of enabled design modules |
actionButtons | object | No | Configure default action buttons visibility |
additionalActionButton | object | No | Add a custom action button |