Events

Event Handlers.

Classes

EditedEvent

Dispatched when a mash Edit has been done or undone.

Extends CustomEvent<UndoableEdit>.

new EditedEvent(detail): EditedEvent

Parameter	Type	Description
`detail`	`UndoableEdit`

Returns EditedEvent. Overrides CustomEvent<UndoableEdit>.constructor.

Property	Modifier	Type
`Type`	`static`	`string`

ImportEvent

Dispatch to import file(s) and get promise for corresponding asset objects.

Extends CustomEvent<ImportEventDetail>.

new ImportEvent(fileList): ImportEvent

Parameter	Type	Description
`fileList`	`FileList`

Returns ImportEvent. Overrides CustomEvent<ImportEventDetail>.constructor.

Property	Modifier	Type
`Type`	`static`	`string`

ImportFileEvent

Dispatch to import a file and get promise for corresponding asset object.

Extends CustomEvent<ImportEventFileDetail>.

new ImportFileEvent(file, source?): ImportFileEvent

Parameter	Type	Description
`file`	`File`
`source`?	`string`

Returns ImportFileEvent. Overrides CustomEvent<ImportEventFileDetail>.constructor.

Property	Modifier	Type
`Type`	`static`	`"import"`

PickedEvent

Dispatch to retrieve the browser content.

Extends CustomEvent<EventPickedDetail>.

new PickedEvent(picker): PickedEvent

Parameter	Type	Description
`picker`	`string`

Returns PickedEvent. Overrides CustomEvent<EventPickedDetail>.constructor.

Property	Modifier	Type
`Type`	`static`	`string`

ScalarPropertyEvent

Dispatch to retrieve selected properties.

Extends CustomEvent<ScalarPropertyEventDetail>.

new ScalarPropertyEvent(propertyId): ScalarPropertyEvent

Parameter	Type	Description
`propertyId`	`string`

Returns ScalarPropertyEvent. Overrides CustomEvent<ScalarPropertyEventDetail>.constructor.

Property	Modifier	Type
`Type`	`static`	`string`

ScrollRootEvent

Dispatch to retrieve the root element that is scrolled.

Extends CustomEvent<object>.

new ScrollRootEvent(…args): ScrollRootEvent

Parameter	Type	Description
…`args`	`any`[]

Returns ScrollRootEvent. Overrides CustomEvent<{ root?: Element; }>.constructor.

Property	Modifier	Type
`Type`	`static`	`string`

SignalIdsEvent

Dispatch to retreve the property ids of the mash's current targets.

Extends CustomEvent<SignalIdsEventDetail>.

new SignalIdsEvent(target, signalIds?): SignalIdsEvent

Parameter	Type	Description
`target`	`string`
`signalIds`?	`${string}.${string}`[]

Returns SignalIdsEvent. Overrides CustomEvent<SignalIdsEventDetail>.constructor.

Property	Modifier	Type
`Type`	`static`	`string`

Interfaces

EventDispatcherListeners<T>

Extends Record<string, EventDispatcherListener<T>>.

Type Parameter	Default type
`T`	`MixinArg`

EventHandler<T>

Type Parameter	Default type
`T`	`Event`

EventHandler(event): void

Parameter	Type
`event`	`T`

Returns void.

EventPickedDetail

Property	Type
`picked?`	`string`
`picker`	`string`

ImportEventDetail

Property	Type
`fileList`	`FileList`
`promise?`	`Promise`<`StorableMedia`[]>

ImportEventFileDetail

Property	Type
`file`	`File`
`promise?`	`Promise`<`DataOrError`<`StorableMedia`>>
`source?`	`string`

ScalarPropertyEventDetail

Property	Type
`propertyId`	`string`
`scalarProperty?`	`ScalarProperty`

SignalIdsEventDetail

Property	Type
`signalIds`	`${string}.${string}`[]
`target`	`string`

Type Aliases

EventDispatcherListener<T>

EventDispatcherListener<T>: (event) => void

Type Parameter	Default type
`T`	`MixinArg`

Parameter	Type
`event`	`CustomEvent`<`T`>

Returns void.

EventListeners

EventListeners: Record<string, EventListener>

ListenersFunction

ListenersFunction: () => EventDispatcherListeners

Returns EventDispatcherListeners.

Variables

$CustomEvent

const $CustomEvent: "CustomEvent"

Functions

ClientRawImportListeners

ClientRawImportListeners(): EventListeners

Returns EventListeners.

ClientTextImportListeners

ClientTextImportListeners(): EventListeners

Returns EventListeners.

stopEvent

stopEvent(event): void

Parameter	Type
`event`	`Event`

Returns void.