Importer

Importer components.

Classes

ImporterAddEvent

Dispatched when an importer has added asset objects.

Extends CustomEvent<ImporterAddEventDetail>.

new ImporterAddEvent(media): ImporterAddEvent

Parameter	Type	Description
`media`	`StorableMedia`

Returns ImporterAddEvent. Overrides CustomEvent<ImporterAddEventDetail>.constructor.

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

ImporterCompleteEvent

Dispatched when an importer has finished importing.

Extends StringEvent.

new ImporterCompleteEvent(): ImporterCompleteEvent

Returns ImporterCompleteEvent. Overrides StringEvent.constructor.

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

ImporterContentElement

Extends ContentElementBase.

new ImporterContentElement(): ImporterContentElement

Returns ImporterContentElement. Inherited from ContentElementBase.constructor.

Property	Modifier	Type
`chromeCss`	`static`	`CSSResult`
`connected`	`public`	`boolean`
`contentCss`	`static`	`CSSResult`
`cssBorderBoxSizing`	`static`	`CSSResult`
`cssHostDropping`	`static`	`CSSResult`
`cssHostFlex`	`static`	`CSSResult`
`cssShared`	`static`	`CSSResult`
`defaultContent`	`public readonly`	`OptionalContent`
`exportParts`	`public`	`undefined` \| `string`
`iconNodes`	`public`	`Node`[]
`masher`	`public readonly`	`Masher`
`masherOrNot`	`public`	`undefined` \| `Masher`
`parts`	`public`	`string`
`partSeparator`	`static`	`string`
`selected`	`public`	`number`
`signals`	`public readonly`	`SignalsRecord`
`styles`	`static`	`CSSResult`

Methods

partContent(part, slots): OptionalContent

Parameter	Type	Description
`part`	`string`
`slots`	`Element`[]

Returns OptionalContent. Inherited from ContentElementBase.partContent.

refreshParts(): string

Returns string. Inherited from ContentElementBase.refreshParts.

templateContent(contents): TemplateContent

Parameter	Type	Description
`contents`	`TemplateContents`

Returns TemplateContent. Inherited from ContentElementBase.templateContent.

unsubscribe(arg, name?, type?): void

Parameter	Type	Description
`arg`	`string` \| `PropertyObject`
`name`?	`string`
`type`?	`string`

Returns void. Inherited from ContentElementBase.unsubscribe.

willUpdate(values): void

Parameter	Type	Description
`values`	`PropertyValueMap`<`ImporterContentElement`>

Returns void. Overrides ContentElementBase.willUpdate.

ImporterElement

Extends PanelElementBase.

new ImporterElement(): ImporterElement

Returns ImporterElement. Inherited from PanelElementBase.constructor.

Property	Modifier	Type
`connected`	`public`	`boolean`
`cssBorderBoxSizing`	`static`	`CSSResult`
`cssHostDropping`	`static`	`CSSResult`
`cssHostFlex`	`static`	`CSSResult`
`defaultContent`	`public readonly`	`OptionalContent`
`exportParts`	`public`	`undefined` \| `string`
`masher`	`public readonly`	`Masher`
`masherOrNot`	`public`	`undefined` \| `Masher`
`parts`	`public`	`string`
`partSeparator`	`static`	`string`
`signals`	`public readonly`	`SignalsRecord`
`styles`	`static`	`CSSResult`

Methods

contentContent(slots): OptionalContent

Parameter	Type	Description
`slots`	`Element`[]

Returns OptionalContent. Inherited from PanelElementBase.contentContent.

footerContent(slots): OptionalContent

Parameter	Type	Description
`slots`	`Element`[]

Returns OptionalContent. Inherited from PanelElementBase.footerContent.

headerContent(slots): OptionalContent

Parameter	Type	Description
`slots`	`Element`[]

Returns OptionalContent. Inherited from PanelElementBase.headerContent.

partContent(part, slots): OptionalContent

Parameter	Type	Description
`part`	`string`
`slots`	`Element`[]

Returns OptionalContent. Inherited from PanelElementBase.partContent.

refreshParts(): string

Returns string. Inherited from PanelElementBase.refreshParts.

templateContent(contents): TemplateContent

Parameter	Type	Description
`contents`	`TemplateContents`

Returns TemplateContent. Inherited from PanelElementBase.templateContent.

unsubscribe(arg, name?, type?): void

Parameter	Type	Description
`arg`	`string` \| `PropertyObject`
`name`?	`string`
`type`?	`string`

Returns void. Inherited from PanelElementBase.unsubscribe.

ImporterErrorEvent

Dispatched when an importer has encountered an error.

Extends CustomEvent<ImporterErrorEventDetail>.

new ImporterErrorEvent(errored): ImporterErrorEvent

Parameter	Type	Description
`errored`	`Errored`

Returns ImporterErrorEvent. Overrides CustomEvent<ImporterErrorEventDetail>.constructor.

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

ImporterFooterElement

Extends FooterElementBase.

new ImporterFooterElement(): ImporterFooterElement

Returns ImporterFooterElement. Inherited from FooterElementBase.constructor.

Property	Modifier	Type
`chromeCss`	`static`	`CSSResult`
`connected`	`public`	`boolean`
`contentCss`	`static`	`CSSResult`
`count`	`public`	`number`
`cssBorderBoxSizing`	`static`	`CSSResult`
`cssHostDropping`	`static`	`CSSResult`
`cssHostFlex`	`static`	`CSSResult`
`cssShared`	`static`	`CSSResult`
`defaultContent`	`public readonly`	`OptionalContent`
`exportParts`	`public`	`undefined` \| `string`
`masher`	`public readonly`	`Masher`
`masherOrNot`	`public`	`undefined` \| `Masher`
`parts`	`public`	`string`
`partSeparator`	`static`	`string`
`signals`	`public readonly`	`SignalsRecord`
`styles`	`static`	`CSSResult`

Methods

partContent(part, slots): OptionalContent

Parameter	Type	Description
`part`	`string`
`slots`	`Element`[]

Returns OptionalContent. Inherited from FooterElementBase.partContent.

refreshParts(): string

Returns string. Inherited from FooterElementBase.refreshParts.

templateContent(contents): TemplateContent

Parameter	Type	Description
`contents`	`TemplateContents`

Returns TemplateContent. Inherited from FooterElementBase.templateContent.

unsubscribe(arg, name?, type?): void

Parameter	Type	Description
`arg`	`string` \| `PropertyObject`
`name`?	`string`
`type`?	`string`

Returns void. Inherited from FooterElementBase.unsubscribe.

ImporterHeaderElement

Extends HeaderElementBase.

new ImporterHeaderElement(): ImporterHeaderElement

Returns ImporterHeaderElement. Inherited from HeaderElementBase.constructor.

Property	Modifier	Type
`chromeCss`	`static`	`CSSResult`
`connected`	`public`	`boolean`
`contentCss`	`static`	`CSSResult`
`cssBorderBoxSizing`	`static`	`CSSResult`
`cssHostDropping`	`static`	`CSSResult`
`cssHostFlex`	`static`	`CSSResult`
`cssShared`	`static`	`CSSResult`
`defaultContent`	`public readonly`	`OptionalContent`
`exportParts`	`public`	`undefined` \| `string`
`masher`	`public readonly`	`Masher`
`masherOrNot`	`public`	`undefined` \| `Masher`
`parts`	`public`	`string`
`partSeparator`	`static`	`string`
`signals`	`public readonly`	`SignalsRecord`
`styles`	`static`	`CSSResult`

Methods

partContent(part, slots): OptionalContent

Parameter	Type	Description
`part`	`string`
`slots`	`Element`[]

Returns OptionalContent. Inherited from HeaderElementBase.partContent.

refreshParts(): string

Returns string. Inherited from HeaderElementBase.refreshParts.

templateContent(contents): TemplateContent

Parameter	Type	Description
`contents`	`TemplateContents`

Returns TemplateContent. Inherited from HeaderElementBase.templateContent.

unsubscribe(arg, name?, type?): void

Parameter	Type	Description
`arg`	`string` \| `PropertyObject`
`name`?	`string`
`type`?	`string`

Returns void. Inherited from HeaderElementBase.unsubscribe.

ImporterNodeFunctionEvent

Dispatch to retrieve a map with icon node and corresponding ui node promise.

Extends CustomEvent<ImporterNodeFunctionEventDetail>.

new ImporterNodeFunctionEvent(types?, sources?, map?): ImporterNodeFunctionEvent

Parameter	Type	Description
`types`?	`MediaType`[]
`sources`?	`string`[]
`map`?	`NodeFunctionMap`

Returns ImporterNodeFunctionEvent. Overrides CustomEvent<ImporterNodeFunctionEventDetail>.constructor.

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

ImporterRawElement

Extends ImporterRawElement_base.

new ImporterRawElement(): ImporterRawElement

Returns ImporterRawElement. Inherited from ImporterRawElement_base.constructor.

Property	Modifier	Type
`acceptsClip`	`public`	`boolean`
`connected`	`public`	`boolean`
`cssBorderBoxSizing`	`static`	`CSSResult`
`cssHostDropping`	`static`	`CSSResult`
`cssHostFlex`	`static`	`CSSResult`
`defaultContent`	`public readonly`	`OptionalContent`
`masher`	`public readonly`	`Masher`
`masherOrNot`	`public`	`undefined` \| `Masher`
`signals`	`public readonly`	`SignalsRecord`
`sources`	`public`	`string`[]
`styles`	`static`	`CSSResult`

Methods

dropValid(dataTransfer?): boolean

Parameter	Type
`dataTransfer`?	`Not` \| `DataTransfer`

Returns boolean. Inherited from ImporterRawElement_base.dropValid.

handleDragged(): void

Returns void. Inherited from ImporterRawElement_base.handleDragged.

handleDropped(dataTransfer?, clientX?): void

Parameter	Type
`dataTransfer`?	`Not` \| `DataTransfer`
`clientX`?	`number`

Returns void. Inherited from ImporterRawElement_base.handleDropped.

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

Parameter	Type
`dataTransfer`?	`Not` \| `DataTransfer`
`clientX`?	`number`

Returns undefined | ClipLocation. Inherited from ImporterRawElement_base.mashIndex.

templateContent(contents): TemplateContent

Parameter	Type	Description
`contents`	`TemplateContents`

Returns TemplateContent. Inherited from ImporterRawElement_base.templateContent.

unsubscribe(arg, name?, type?): void

Parameter	Type	Description
`arg`	`string` \| `PropertyObject`
`name`?	`string`
`type`?	`string`

Returns void. Inherited from ImporterRawElement_base.unsubscribe.

ImporterRemoveEvent

Dispatched when an importer has removed asset objects.

Extends StringEvent.

new ImporterRemoveEvent(detail): ImporterRemoveEvent

Parameter	Type	Description
`detail`	`string`

Returns ImporterRemoveEvent. Overrides StringEvent.constructor.

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

ImporterTextElement

Extends LoaderElementBase.

new ImporterTextElement(): ImporterTextElement

Returns ImporterTextElement. Inherited from LoaderElementBase.constructor.

Property	Modifier	Type
`connected`	`public`	`boolean`
`cssBorderBoxSizing`	`static`	`CSSResult`
`cssHostDropping`	`static`	`CSSResult`
`cssHostFlex`	`static`	`CSSResult`
`defaultContent`	`public readonly`	`OptionalContent`
`masher`	`public readonly`	`Masher`
`masherOrNot`	`public`	`undefined` \| `Masher`
`signals`	`public readonly`	`SignalsRecord`
`styles`	`static`	`CSSResult`

Methods

templateContent(contents): TemplateContent

Parameter	Type	Description
`contents`	`TemplateContents`

Returns TemplateContent. Inherited from LoaderElementBase.templateContent.

unsubscribe(arg, name?, type?): void

Parameter	Type	Description
`arg`	`string` \| `PropertyObject`
`name`?	`string`
`type`?	`string`

Returns void. Inherited from LoaderElementBase.unsubscribe.

ImportersEvent

Dispatch to retrieve an array of importers.

Extends CustomEvent<ImportersEventDetail>.

new ImportersEvent(importers?): ImportersEvent

Parameter	Type	Description
`importers`?	`Importer`[]

Returns ImportersEvent. Overrides CustomEvent<ImportersEventDetail>.constructor.

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

TextClientImporter

new TextClientImporter(): TextClientImporter

Returns TextClientImporter.

Property	Modifier	Type
`canImport`	`public readonly`	`boolean`
`icon`	`public readonly`	`Node`
`id`	`public`	`string`
`instance`	`static readonly`	`TextClientImporter`
`label`	`public`	`string`
`styles`	`static`	`CSSResult`

Methods

import(): void

Returns void.

ui(): Node

Returns Node.

static handleImport(event): void

Parameter	Type	Description
`event`	`Event`

Returns void.

static handleImporters(evt): void

Parameter	Type
`evt`	`Event`

Returns void.

Interfaces

ClientImporter

Extends Importer.

Property	Type
`id`	`string`
`label?`	`string`

Importer

Extends Identified.Labeled. Extended by ClientImporter.

Property	Type
`id`	`string`
`label?`	`string`

ImporterAddEventDetail

Property	Type
`media`	`StorableMedia`
`promise?`	`Promise`<`DataOrError`<`StoredMedia`>>

ImporterErrorEventDetail

Extends Object.

Property	Type
`errored`	`Errored`

ImporterNodeFunctionEventDetail

Property	Type
`map`	`NodeFunctionMap`
`sources`	`string`[]
`types`	`MediaType`[]

ImportersEventDetail

Property	Type
`importers`	`Importer`[]

Variables

ImporterContentTag

const ImporterContentTag: "media-masher-importer-content"

ImporterFooterTag

const ImporterFooterTag: "media-masher-importer-footer"

ImporterHeaderTag

const ImporterHeaderTag: "media-masher-importer-header"

ImporterRawTag

const ImporterRawTag: "media-masher-importer-raw"

ImporterTag

const ImporterTag: "media-masher-importer"

ImporterTextTag

const ImporterTextTag: "media-masher-importer-text"