ui.startDragToCursor
Adds the specified element or content to responsive documents, which slot things into a text stream at the end of a drag event.
Parameters
event
DragStartEvent<E>
RequiredA drag start event.
currentTarget
E
RequireddragData
object
RequiredElement or content to be added to the design at the end of the drag event.
Embed element to be added to the design at the end of a drag event.
type
string
RequiredThe type of element.
This must be "embed"
.
previewSize
Dimensions
RequiredThe dimensions of the preview image.
width
number
RequiredA width, in pixels.
height
number
RequiredA height, in pixels.
previewUrl
string
RequiredThe URL of an image to display under the user's cursor during the drag and drop event.
embedUrl
string
RequiredThe URL of media that can be embedded, such as the URL of a YouTube video.
This URL must be supported by the Iframely API.
Video element or content to be added to the design at the end of a drag event.
type
string
RequiredThe type of element.
This must be "video"
.
resolveVideoRef
function
RequiredA function that returns a reference (ref) to a video asset in Canva's backend.
Returns
A Promise
that resolves with the following object:
ref
VideoRef
A unique identifier that references a video asset in Canva's backend.
previewSize
Dimensions
RequiredThe dimensions of the preview image.
width
number
RequiredA width, in pixels.
height
number
RequiredA height, in pixels.
previewUrl
string
RequiredThe URL of an image to display under the user's cursor during the drag and drop event.
fullSize
Dimensions
OptionalThe dimensions of the full-size video.
- These dimensions are used when adding the video to the design
- If omitted, the
previewSize
dimensions are used as a fallback.
width
number
RequiredA width, in pixels.
height
number
RequiredA height, in pixels.
Image element or content to be added to the design at the end of a drag event.
type
string
RequiredThe type of element.
This must be "image"
.
previewSize
Dimensions
RequiredThe dimensions of the preview image.
width
number
RequiredA width, in pixels.
height
number
RequiredA height, in pixels.
resolveImageRef
function
RequiredA function that returns a reference (ref) to an audio asset in Canva's backend.
Returns
A Promise
that resolves with the following object:
ref
ImageRef
A unique identifier that references an image asset in Canva's backend.
previewUrl
string
RequiredThe URL of an image to display under the user's cursor during the drag and drop event.
fullSize
Dimensions
OptionalThe dimensions of the full-size image.
width
number
RequiredA width, in pixels.
height
number
RequiredA height, in pixels.
Returns
Promise<void>