Skip to main content

Class: OverlayType

obs-utils/src/utils/api.OverlayType

Constructors

constructor

new OverlayType(overlayClass): OverlayType

Parameters

NameType
overlayClassSvelteComponentConstructor

Returns

OverlayType

Properties

compactEditorButtons

compactEditorButtons: Map<string, boolean>


overlayClass

overlayClass: SvelteComponentConstructor


overlayComponentEditors

overlayComponentEditors: Map<string, SvelteComponentConstructor>


overlayComponentNames

overlayComponentNames: Map<string, string>


overlayComponents

overlayComponents: Map<string, SvelteComponentConstructor>


overlayEditor

overlayEditor: SvelteComponentConstructor

Methods

registerComponent

registerComponent(key, readableName, type): void

Parameters

NameType
keystring
readableNamestring
typeSvelteComponentConstructor

Returns

void


registerComponentEditor

registerComponentEditor(key, editor, compactButtons?): void

Parameters

NameTypeDefault value
keystringundefined
editorSvelteComponentConstructorundefined
compactButtonsbooleanfalse

Returns

void


registerOverlayEditor

registerOverlayEditor(editor): void

Parameters

NameType
editorSvelteComponentConstructor

Returns

void