ViewRegistry
Defined in: src/obsidian/internals/ViewRegistry/ViewRegistry.d.ts:17
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”typeByExtension
Section titled “typeByExtension”typeByExtension:
ViewRegistryTypeByExtensionRecord
Defined in: src/obsidian/internals/ViewRegistry/ViewRegistry.d.ts:21
Mapping of file extensions to view type.
viewByType
Section titled “viewByType”viewByType:
ViewRegistryViewByTypeRecord
Defined in: src/obsidian/internals/ViewRegistry/ViewRegistry.d.ts:26
Mapping of view type to view constructor.
Methods
Section titled “Methods”getTypeByExtension()
Section titled “getTypeByExtension()”getTypeByExtension(
extension):undefined|string
Defined in: src/obsidian/internals/ViewRegistry/ViewRegistry.d.ts:33
Get the view type associated with a file extension.
Parameters
Section titled “Parameters”extension
Section titled “extension”string
File extension.
Returns
Section titled “Returns”undefined | string
getViewCreatorByType()
Section titled “getViewCreatorByType()”Call Signature
Section titled “Call Signature”getViewCreatorByType(
type):undefined|ViewCreator
Defined in: src/obsidian/internals/ViewRegistry/ViewRegistry.d.ts:36
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”undefined | ViewCreator
Call Signature
Section titled “Call Signature”getViewCreatorByType<
TViewType>(type):undefined|TypedViewCreator<ViewTypeViewMapping[TViewType]>
Defined in: src/obsidian/internals/ViewRegistry/ViewRegistry.d.ts:41
Get the view constructor associated with a view type.
Type Parameters
Section titled “Type Parameters”TViewType
Section titled “TViewType”TViewType extends ViewTypeType
Parameters
Section titled “Parameters”TViewType
Returns
Section titled “Returns”undefined | TypedViewCreator<ViewTypeViewMapping[TViewType]>
isExtensionRegistered()
Section titled “isExtensionRegistered()”isExtensionRegistered(
extension):boolean
Defined in: src/obsidian/internals/ViewRegistry/ViewRegistry.d.ts:48
Check whether a view type is registered.
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):EventRef
Defined in: src/obsidian/internals/ViewRegistry/ViewRegistry.d.ts:53
Called when the file extensions mapping has been updated.
Parameters
Section titled “Parameters”"extensions-updated"
callback
Section titled “callback”() => void
Returns
Section titled “Returns”Overrides
Section titled “Overrides”Call Signature
Section titled “Call Signature”on(
name,callback):EventRef
Defined in: src/obsidian/internals/ViewRegistry/ViewRegistry.d.ts:58
Called when a view of type has been registered into the registry.
Parameters
Section titled “Parameters”"view-registered"
callback
Section titled “callback”(type) => void
Returns
Section titled “Returns”Overrides
Section titled “Overrides”Call Signature
Section titled “Call Signature”on(
name,callback):EventRef
Defined in: src/obsidian/internals/ViewRegistry/ViewRegistry.d.ts:63
Called when a view of type has been unregistered from the registry.
Parameters
Section titled “Parameters”"view-unregistered"
callback
Section titled “callback”(type) => void
Returns
Section titled “Returns”Overrides
Section titled “Overrides”Events.on
registerExtensions()
Section titled “registerExtensions()”registerExtensions(
extension,type):void
Defined in: src/obsidian/internals/ViewRegistry/ViewRegistry.d.ts:72
Register a view type for a file extension.
Parameters
Section titled “Parameters”extension
Section titled “extension”string[]
File extension.
string
View type.
Returns
Section titled “Returns”void
registerView()
Section titled “registerView()”registerView(
type,viewCreator):void
Defined in: src/obsidian/internals/ViewRegistry/ViewRegistry.d.ts:77
Register a view constructor for a view type.
Parameters
Section titled “Parameters”string
viewCreator
Section titled “viewCreator”Returns
Section titled “Returns”void
registerViewWithExtensions()
Section titled “registerViewWithExtensions()”registerViewWithExtensions(
extensions,type,viewCreator):void
Defined in: src/obsidian/internals/ViewRegistry/ViewRegistry.d.ts:82
Register a view and its associated file extensions.
Parameters
Section titled “Parameters”extensions
Section titled “extensions”string[]
string
viewCreator
Section titled “viewCreator”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”unregisterExtensions()
Section titled “unregisterExtensions()”unregisterExtensions(
extension):void
Defined in: src/obsidian/internals/ViewRegistry/ViewRegistry.d.ts:87
Unregister extensions for a view type.
Parameters
Section titled “Parameters”extension
Section titled “extension”string[]
Returns
Section titled “Returns”void
unregisterView()
Section titled “unregisterView()”unregisterView(
type):void
Defined in: src/obsidian/internals/ViewRegistry/ViewRegistry.d.ts:92
Unregister a view type.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void