Name Value Type  
Description and default value
The key must be provided so that DVS knows what site it's running on. This is the key that you were given we you created an account with this.
Your ID in DaVinci Service.
If you provide a template id, that id will be used to initialize the design with. You should not include a `designId` if you want to use `templateId`. If both are present, `designId` will be used instead. If neither are present, a blank template will be used.
If you provide a design id, that id will be used to initialize the design with. You should not include a `templateId` if you want to use `designId`. If both are present, `designId` will be used instead of `templateId`. If neither are present, a blank template will be used.
An object that represents design dimensions for a blank template in pixels. `width` and `height` should NOT include bleed and should be more than 150. Bleed and safe zones margins should be positive numbers.
Use this parameter to set a design's shape. Supported diecuts: `rect`, `ellipse`. This parameter is only used when you pull blank product template or create blank template by dimensions. Default: rect
Use this parameter to create a design based on an image. Design image dimensions is used as design size if parameter `designSize` isn't passed. If you are using this parameter, please make sure that your server (the server being used to store image file) allows cross-domain resource sharing with DVS website domain.
If no `designId` or `templateId` is given, you can specify a `productType` to create a blank design using that product's size.
Designates an orientation for newly created templates (`0` for portrait | `1` for landscape). Default: 1
Use this to specify the face you want to start on. Default: front
Use this parameter to pass in XML to build design from. Can be either xml (as string) or file location. If you are using this parameter to specify xml file location, please make sure that your server (the server being used to store xml file) allows cross-domain resource sharing with DVS website domain.
This parameter allows you to create multipage design. Works only with parameter `designSize` where expected size is for single page. Value should be even, no less than 4 and no more than 48 pages. Non-integer number will be rounded off to the nearest integer.
Include this if you want to use a custom style from your account.
This tells DaVinci Designer what type of mode to run the artboard in. Available modes: `basic` | `advanced`. Default: advanced
This tells DaVinci Designer what layout to use: `none` | `basic` | `classic` | `advanced` | `uploader`.
`none`: no UI except for the artboard.
`basic`: sidebar with just layers mode and possible fxMode (if enabled, only in advanced mode).
`classic`: top toolbar and sidebar without edit mode.
`advanced`: full-featured sidebar, with edit mode. No top toolbar.
For basic mode the default value is `basic`, for advanced mode - `advanced`.
`uploader`: no sidebar or toolbar. Uploader-like UI. Default: advanced | basic
This parameter allows you to specify needed locale. Supported locales: `en` | `es`. Default: en
This parameter allows you to specify where graphical assets are uploaded to if you want to store these assets on your own server. You may add {clientId}, {templateId}, and/or {designId} to the url string for those values to be auto inserted. The response should be valid XML. Check the correct XML format in the 'Asset Storage' section in the docs.
This parameter allows you to specify where fonts are uploaded to if you want to store these assets on your own server. You may add {clientId}, {templateId}, and/or {designId} to the url string for those values to be auto inserted. The response should be valid XML. Check the correct XML format in the 'Asset Storage' section in the docs.
This parameter allows you to specify a path to your image library. If no path is added, DaVinci will default to tracking user's uploaded images using browser's local storage. If the path does exist, DaVinci will make a GET call and will pass `page` and `per_page` as parameters. The response should be valid XML specifying list of images. Check the correct XML format in the 'Asset Storage' section in the docs.
Logging level to use. Available levels: `log` | `debug` | `info` | `warn` | `error` | `off`. Default: error
If set to true, DaVinci Designer will use the last design token when loading IF the template id matches and there is no design id given. Default: false
If set to false, you must manually call `saveDesign` API to save. Default: true
If set to false, DaVinci Designer will not use previous token values to populate text fields. Default: true
Use this to attach a callback method which is called once DaVinci Designer is initiated and app is ready. No parameters are returned in the method.
Use this parameter to specify what type of overlay will be used. If set to `true` overlay will cover the whole page instead of DaVinci container. Default: false
Use this parameter to enable 'Mapping Sets' feature. This feature will allow user to upload contact list and apply chosen design to all contact sets at once. Default: false
Use this to specify the mapped set you want to start on. `enableMappingSets` must be `true`, otherwise it will be default to 1. Default: 1
Use this parameter to enable uploading of fonts. Default: false
Use this parameter to specify fonts available in the designer. If you want to include font from the list of DVD default fonts, include only it's name as `name` property of an object. If you want to use your own font include `src` property as well. `src` property must be either a string (will be regarded as a source for the regular typeface) or an object with the following available properties: `regular`, `bold`, `italic` and `boldItalic` (in which case `regular` is required).
Use this parameter to enable feature of toggling layer processes. Use `true` if you want to enable Processes (Fx) Mode for all faces. If you want to enable it only for certain faces, pass in an object and specify those faces in `faces` property of this object. The list of avaiable processes can be modified via `availableProcesses` initial parameter. Default: false
Use this parameter to specify what print processes you want to enable in designer. Available options: `spotUV`, `KRE8-3D`, `glitter`, `metallic`, `foil`, `opaqueWhite`. Note that `Regular` (aka `Normal`) process will always be enabled in the designer. If you want to set available processes for certain faces, pass in an object and specify processes in object's properties. Each process can be specified by an object with the following fields: `name` - process name; and `filterOptions` - array of filters names. Default: Array
Use this parameter to specify what full coating print processes you want to enable in designer. Available option: `fullUV`. If you want to set available full coating processes for certain faces, pass in an object and specify processes in object's properties.
Use this parameter to enable the layer tools. Default: false
Use this parameter to enable feature of ordering layers in sidebar via drag and drop. Default: false
Use this parameter to change what server you are wanting to use as a template server.
Use this parameter to specify a list of enabled sources of image uploading. Available sources: `my_computer`, `library`, `facebook`, `flickr`, `instagram`. The `library` option will use `assetLibraryPath` if given or will use browser's local storage. Default: [ "flickr", "library", "my_computer" ]
Use this parameter to enable feature of scaling artboard by dragging. Default: false
Use this parameter to specify the path to the backend version of DaVinci that is desired.
Use this parameter to specify the path for the service URL.
Use this parameter to specify client ID of your facebook application.
Use this parameter to specify client ID of your instagram application.
Use this parameter to specify client ID of your flickr application.
Use this parameter to enable real time DVV in tab. Default: false
An object that describes trim and safe lines colors, thickness and style. Use this object to change style of trim and safe lines (style: 'solid', style: 'dash', style: 'none' or an array with two values [5, 5] - dashed line params), hide trim or safe lines (style: 'none'), change line color (possible to use hex code, rgb value or color names), change thickness (value in px default: 1).
Use this parameter to enable initial help background. You may just turn on default Help Overlay by passing `true` value or specify the appearance using an object. Object must contain `type` property. Only `uploader` type is available for now. Default: false
Use this parameter to set acceptable ppi for design images. `lowLimit` property of the object designates the limit of really bad image quality, images with ppi lower than that are marked with red exclamation mark. `sufficient` property of the object designates sufficient ppi for image, images with ppi lower than that are marked with yellow exclamation mark. Both `lowLimit` and `sufficient` can be static number or percentage. Static number means that image should be checked against this ppi. Percentage string means that image should be checked against ppi that is calculated as given percentage of current design ppi. Default: { "lowLimit": 100, "sufficient": 200 }
Use this parameter to show notifications to user when assets go out of safe zone. Default: false
Use this parameter to hide button `Shapes & Colors` in Add/Change Image panel for background. Default: true
Use this parameter to hide Image Filters in Crop Panel. Default: true