Exports related to drag and drop functionality.

Interfaces

DragAssetObject

PropertyType
assetObjectStorableMedia
offsetnumber

DropTarget

PropertyType
acceptsClipboolean

Methods

dropValid(dataTransfer?): boolean

ParameterType
dataTransfer?Not | DataTransfer

Returns boolean.

handleDragged(): void

Returns void.

handleDropped(dataTransfer?, clientX?): void

ParameterType
dataTransfer?Not | DataTransfer
clientX?number

Returns void.

mashIndex(dataTransfer?, clientX?): undefined | ClipLocation

ParameterType
dataTransfer?Not | DataTransfer
clientX?number

Returns undefined | ClipLocation.

Droppable

PropertyType
selectedboolean

Type Aliases

DropType

DropType: MediaType | _font

TransferType

TransferType: `${string}/x-masher`

Variables

$dragging

const $dragging: "dragging"

DROP_TARGET_CSS

const DROP_TARGET_CSS: CSSResult

DROP_TYPES

const DROP_TYPES: string[]

Functions

dragTypeValid

dragTypeValid(dataTransfer?, allowClip?): dataTransfer is DataTransfer

ParameterType
dataTransfer?Not | DataTransfer
allowClip?boolean

Returns dataTransfer is DataTransfer.

dragTypes

dragTypes(dataTransfer?): string[]

ParameterType
dataTransfer?Not | DataTransfer

Returns string[].

dropFile

dropFile(framework, file, source?): Promise<DataOrError<StorableMedia>>

ParameterType
frameworkFramework
fileFile
source?string

Returns Promise<DataOrError<StorableMedia>>.

dropRawFiles

dropRawFiles(framework, fileList): Promise<StorableMedia[]> | undefined

ParameterType
frameworkFramework
fileListFileList

Returns Promise<StorableMedia[]> | undefined.

dropped

dropped(framework, dataTransfer?, clipLocation?): Promise<void>

ParameterType
frameworkFramework
dataTransfer?Not | DataTransfer
clipLocation?ClipLocation

Returns Promise<void>.

droppedMashIndex

droppedMashIndex(dataTransfer, track?, scale?, framePixels?, clipId?): ClipLocation

ParameterType
dataTransferDataTransfer
track?Track
scale?number
framePixels?number
clipId?string

Returns ClipLocation.

droppingFiles

droppingFiles(dataTransfer?): boolean

ParameterType
dataTransfer?Not | DataTransfer

Returns boolean.

isDragAssetObject

isDragAssetObject(value): value is DragAssetObject

ParameterType
valueany

Returns value is DragAssetObject.

isDropType

isDropType(value): value is DropType

ParameterType
valueany

Returns value is DropType.