Interface: ISetRemoteMockup
Provides properties to change mockups by using direct URLs. Provides properties to change mockups by using direct URLs.
For details, you can refer to the ChangeMockup command.
{
"type": "canvas",
"name": "editor",
"params": {
"initial": { ... },
"setRemoteMockup": [{
"surfaceIndex": 0,
"mockup": "down",
"url": "http://example.com/mockup.png"
}]
}
}
For details, you can refer to the ChangeMockup command.
{
"type": "design-editor",
"name": "editor",
"params": {
"initial": { ... },
"setRemoteMockup": [{
"surfaceIndex": 0,
"mockup": "down",
"url": "http://example.com/mockup.png"
}]
}
}
Hierarchy
-
IDesignEditorCommandDefinition
↳ ISetRemoteMockup
Index
Properties
Properties
Optional
after
• after? : string | string[]
Inherited from ICanvasCommandDefinition.after
Overrides IDesignEditorCommandDefinition.after
The next commands to be executed after this command completes.
mockup
• mockup: "up" | "down"
up
for overlay mockups, and down
for background mockups. up
for overlay mockups, and down
for background mockups.
Optional
showPreloader
• showPreloader? : boolean
Inherited from IDesignEditorCommandDefinition.showPreloader
If true
, displays the preloader while executing this command.
surfaceIndex
• surfaceIndex: number
The index of a surface that should be modified (the current surface if omitted). The index of a surface that should be modified (the current surface if omitted).
url
• url: string
A URL that links to the mockup image. A URL that links to the mockup image.