ui.startDragToCursor

API reference for the ui.startDrag method.

Adds the specified element or content to responsive documents, which slot things into a text stream at the end of a drag event.

#eventDragStartEvent<E>
Required

A drag start event.

Properties of event
#currentTargetE
Required
#dragDataobject
Required

Element 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.

#embedUrlstring
Required

The URL of media that can be embedded, such as the URL of a YouTube video.

This URL must be supported by the Iframely API.

#previewSizeDimensions
Required

The dimensions of the preview image.

Properties of previewSize
#heightnumber
Required

A height, in pixels.

#widthnumber
Required

A width, in pixels.

#previewUrlstring
Required

The URL of an image to display under the user's cursor during the drag and drop event.

#typestring
Required

The type of element.

This must be "embed".

Promise<void>