EmbedRegistry
Defined in: src/obsidian/internals/EmbedRegistry/EmbedRegistry.d.ts:13
Extends
Section titled “Extends”Properties
Section titled “Properties”_:
Record<string,EventsEntry[]>
Defined in: src/obsidian/augmentations/Events.d.ts:12
Inherited from
Section titled “Inherited from”embedByExtension
Section titled “embedByExtension”embedByExtension:
EmbedRegistryEmbedByExtensionRecord
Defined in: src/obsidian/internals/EmbedRegistry/EmbedRegistry.d.ts:17
Mapping of file extensions to constructors for embeddable widgets.
Methods
Section titled “Methods”getEmbedCreator()
Section titled “getEmbedCreator()”getEmbedCreator(
file):null|EmbeddableConstructor
Defined in: src/obsidian/internals/EmbedRegistry/EmbedRegistry.d.ts:22
Get the embed constructor for a specific file type.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”null | EmbeddableConstructor
isExtensionRegistered()
Section titled “isExtensionRegistered()”isExtensionRegistered(
extension):boolean
Defined in: src/obsidian/internals/EmbedRegistry/EmbedRegistry.d.ts:27
Check whether a file extension has a registered embed constructor.
Parameters
Section titled “Parameters”extension
Section titled “extension”string
Returns
Section titled “Returns”boolean
Call Signature
Section titled “Call Signature”off(
name,callback):void
Defined in: obsidian.d.ts:1480
Parameters
Section titled “Parameters”string
callback
Section titled “callback”(…data) => unknown
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”off(
name,callback):void
Defined in: src/obsidian/augmentations/Events.d.ts:25
Remove an event listener.
Parameters
Section titled “Parameters”string
The name of the event.
callback
Section titled “callback”(…data) => unknown
The callback to remove.
Returns
Section titled “Returns”void
Example
Section titled “Example”events.off('my-event', myListener);Inherited from
Section titled “Inherited from”offref()
Section titled “offref()”Call Signature
Section titled “Call Signature”offref(
ref):void
Defined in: obsidian.d.ts:1484
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”offref(
ref):void
Defined in: src/obsidian/augmentations/Events.d.ts:37
Remove an event listener by reference.
Parameters
Section titled “Parameters”The reference to the event listener.
Returns
Section titled “Returns”void
Example
Section titled “Example”events.offref(myRef);Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”on(
name,callback,ctx?):EventRef
Defined in: obsidian.d.ts:1476
Parameters
Section titled “Parameters”string
callback
Section titled “callback”(…data) => unknown
any
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”on(
name,callback,ctx?):EventRef
Defined in: src/obsidian/augmentations/Events.d.ts:54
Add an event listener.
Parameters
Section titled “Parameters”string
The name of the event.
callback
Section titled “callback”(…data) => unknown
The callback to call when the event is triggered.
any
The context passed as this to the callback.
Returns
Section titled “Returns”A reference to the event listener.
Example
Section titled “Example”events.on('my-event', (arg1, arg2) => { console.log(arg1, arg2);});Inherited from
Section titled “Inherited from”registerExtension()
Section titled “registerExtension()”registerExtension(
extension,embedCreator):void
Defined in: src/obsidian/internals/EmbedRegistry/EmbedRegistry.d.ts:32
Register an embed constructor for a specific file extension.
Parameters
Section titled “Parameters”extension
Section titled “extension”string
embedCreator
Section titled “embedCreator”Returns
Section titled “Returns”void
registerExtensions()
Section titled “registerExtensions()”registerExtensions(
extensions,embedCreator):void
Defined in: src/obsidian/internals/EmbedRegistry/EmbedRegistry.d.ts:37
Register an embed constructor for a list of file extensions.
Parameters
Section titled “Parameters”extensions
Section titled “extensions”string[]
embedCreator
Section titled “embedCreator”Returns
Section titled “Returns”void
trigger()
Section titled “trigger()”Call Signature
Section titled “Call Signature”trigger(
name, …data):void
Defined in: obsidian.d.ts:1488
Parameters
Section titled “Parameters”string
…unknown[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”trigger(
name, …data):void
Defined in: src/obsidian/augmentations/Events.d.ts:67
Trigger an event, executing all the listeners in order even if some of them throw an error.
Parameters
Section titled “Parameters”string
The name of the event.
…unknown[]
The data to pass to the event listeners.
Returns
Section titled “Returns”void
Example
Section titled “Example”events.trigger('my-event', 'arg1', 'arg2');Inherited from
Section titled “Inherited from”tryTrigger()
Section titled “tryTrigger()”Call Signature
Section titled “Call Signature”tryTrigger(
evt,args):void
Defined in: obsidian.d.ts:1492
Parameters
Section titled “Parameters”unknown[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”tryTrigger(
evt,args):void
Defined in: src/obsidian/augmentations/Events.d.ts:80
Try to trigger an event, executing all the listeners in order even if some of them throw an error.
Parameters
Section titled “Parameters”The event reference.
unknown[]
The data to pass to the event listeners.
Returns
Section titled “Returns”void
Example
Section titled “Example”events.tryTrigger(myRef, ['arg1', 'arg2']);Inherited from
Section titled “Inherited from”unregisterExtension()
Section titled “unregisterExtension()”unregisterExtension(
extension):void
Defined in: src/obsidian/internals/EmbedRegistry/EmbedRegistry.d.ts:42
Unregister an embed constructor for a specific file extension.
Parameters
Section titled “Parameters”extension
Section titled “extension”string
Returns
Section titled “Returns”void
unregisterExtensions()
Section titled “unregisterExtensions()”unregisterExtensions(
extensions):void
Defined in: src/obsidian/internals/EmbedRegistry/EmbedRegistry.d.ts:47
Unregister an embed constructor for a list of file extensions.
Parameters
Section titled “Parameters”extensions
Section titled “extensions”string[]
Returns
Section titled “Returns”void