BacklinkComponent
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:16
Extends
Section titled “Extends”Properties
Section titled “Properties”_children
Section titled “_children”_children:
Component[]
Defined in: src/obsidian/augmentations/Components/Component.d.ts:13
Child Components attached to current component, will be unloaded on unloading parent component.
Inherited from
Section titled “Inherited from”_events
Section titled “_events”_events:
EventRef[]
Defined in: src/obsidian/augmentations/Components/Component.d.ts:20
Events that are attached to the current component, will be detached on unloading parent component.
Inherited from
Section titled “Inherited from”_loaded
Section titled “_loaded”_loaded:
boolean
Defined in: src/obsidian/augmentations/Components/Component.d.ts:27
Whether the component and its children are loaded.
Inherited from
Section titled “Inherited from”app:
App
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:18
backlinkCollapsed
Section titled “backlinkCollapsed”backlinkCollapsed:
boolean
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:21
backlinkCountEl
Section titled “backlinkCountEl”backlinkCountEl:
HTMLSpanElement
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:24
backlinkDom
Section titled “backlinkDom”backlinkDom:
ResultDom
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:27
backlinkFile
Section titled “backlinkFile”backlinkFile:
null|TFile
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:30
backlinkHeaderEl
Section titled “backlinkHeaderEl”backlinkHeaderEl:
HTMLDivElement
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:33
backlinkQueue
Section titled “backlinkQueue”Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:36
collapseAll
Section titled “collapseAll”collapseAll:
boolean
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:39
collapseAllButtonEl
Section titled “collapseAllButtonEl”collapseAllButtonEl:
HTMLDivElement
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:42
extraContext
Section titled “extraContext”extraContext:
boolean
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:45
extraContextButtonEl
Section titled “extraContextButtonEl”extraContextButtonEl:
HTMLDivElement
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:48
file:
null|TFile
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:51
headerDom
Section titled “headerDom”headerDom:
HeaderDom
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:54
isShowingSearch
Section titled “isShowingSearch”isShowingSearch:
boolean
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:57
searchComponent
Section titled “searchComponent”searchComponent:
SearchComponent
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:60
searchQuery
Section titled “searchQuery”searchQuery:
null
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:63
showSearchButtonEl
Section titled “showSearchButtonEl”showSearchButtonEl:
HTMLDivElement
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:66
sortOrder
Section titled “sortOrder”sortOrder:
string
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:69
tooltipPlacement
Section titled “tooltipPlacement”tooltipPlacement:
string
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:72
unlinkedAliases
Section titled “unlinkedAliases”unlinkedAliases:
string
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:75
unlinkedCollapsed
Section titled “unlinkedCollapsed”unlinkedCollapsed:
boolean
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:78
unlinkedCountEl
Section titled “unlinkedCountEl”unlinkedCountEl:
HTMLSpanElement
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:81
unlinkedDom
Section titled “unlinkedDom”unlinkedDom:
ResultDom
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:84
unlinkedFile
Section titled “unlinkedFile”unlinkedFile:
null
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:87
unlinkedHeaderEl
Section titled “unlinkedHeaderEl”unlinkedHeaderEl:
HTMLDivElement
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:90
unlinkedQueue
Section titled “unlinkedQueue”unlinkedQueue:
null
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:93
Methods
Section titled “Methods”addChild()
Section titled “addChild()”Call Signature
Section titled “Call Signature”addChild<
T>(component):T
Defined in: obsidian.d.ts:911
Adds a child component, loading it if this component is loaded
Type Parameters
Section titled “Type Parameters”T extends Component
Parameters
Section titled “Parameters”component
Section titled “component”T
Returns
Section titled “Returns”T
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”addChild<
T>(component):T
Defined in: src/obsidian/augmentations/Components/Component.d.ts:41
Adds a child component, loading it if this component is loaded.
Type Parameters
Section titled “Type Parameters”T extends Component
The type of the component to add.
Parameters
Section titled “Parameters”component
Section titled “component”T
The component to add.
Returns
Section titled “Returns”T
The added component.
Example
Section titled “Example”component.addChild(childComponent);Inherited from
Section titled “Inherited from”addLinkFunction()
Section titled “addLinkFunction()”addLinkFunction(
arg1,arg2,arg3):unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:96
Parameters
Section titled “Parameters”unknown
unknown
unknown
Returns
Section titled “Returns”unknown
getState()
Section titled “getState()”getState():
unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:99
Returns
Section titled “Returns”unknown
load()
Section titled “load()”Call Signature
Section titled “Call Signature”load():
void
Defined in: obsidian.d.ts:889
Load this component and its children
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”load():
void
Defined in: src/obsidian/augmentations/Components/Component.d.ts:48
Load this component and its children.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”onFileChanged()
Section titled “onFileChanged()”onFileChanged(
arg1):unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:102
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”unknown
onFileDeleted()
Section titled “onFileDeleted()”onFileDeleted(
arg1):unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:105
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”unknown
onFileRename()
Section titled “onFileRename()”onFileRename(
arg1):unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:108
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”unknown
onload()
Section titled “onload()”onload():
unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:111
Returns
Section titled “Returns”unknown
Overrides
Section titled “Overrides”onMetadataChanged()
Section titled “onMetadataChanged()”onMetadataChanged(
arg1):unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:114
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”unknown
onResize()
Section titled “onResize()”onResize():
unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:117
Returns
Section titled “Returns”unknown
onToggleCollapseClick()
Section titled “onToggleCollapseClick()”onToggleCollapseClick():
unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:120
Returns
Section titled “Returns”unknown
onToggleMoreContextClick()
Section titled “onToggleMoreContextClick()”onToggleMoreContextClick():
unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:123
Returns
Section titled “Returns”unknown
onToggleShowSearch()
Section titled “onToggleShowSearch()”onToggleShowSearch():
unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:126
Returns
Section titled “Returns”unknown
onunload()
Section titled “onunload()”onunload():
void
Defined in: obsidian.d.ts:906
Override this to unload your component
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”passSearchFilter()
Section titled “passSearchFilter()”passSearchFilter(
arg1,arg2):unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:129
Parameters
Section titled “Parameters”unknown
unknown
Returns
Section titled “Returns”unknown
recomputeBacklink()
Section titled “recomputeBacklink()”recomputeBacklink(
backlinkFile):void
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:132
Parameters
Section titled “Parameters”backlinkFile
Section titled “backlinkFile”null | TFile
Returns
Section titled “Returns”void
recomputeUnlinked()
Section titled “recomputeUnlinked()”recomputeUnlinked(
arg1):unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:135
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”unknown
register()
Section titled “register()”Call Signature
Section titled “Call Signature”register(
cb):void
Defined in: obsidian.d.ts:921
Registers a callback to be called when unloading
Parameters
Section titled “Parameters”() => any
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”register(
cb):void
Defined in: src/obsidian/augmentations/Components/Component.d.ts:78
Registers a callback to be called when unloading.
Parameters
Section titled “Parameters”() => any
The callback to be called when unloading.
Returns
Section titled “Returns”void
Example
Section titled “Example”component.register(() => { console.log('MyComponent unloaded');});Inherited from
Section titled “Inherited from”registerDomEvent()
Section titled “registerDomEvent()”Call Signature
Section titled “Call Signature”registerDomEvent<
K>(el,type,callback,options?):void
Defined in: obsidian.d.ts:931
Registers an DOM event to be detached when unloading
Type Parameters
Section titled “Type Parameters”K extends keyof WindowEventMap
Parameters
Section titled “Parameters”K
callback
Section titled “callback”(this, ev) => any
options?
Section titled “options?”boolean | AddEventListenerOptions
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”registerDomEvent<
K>(el,type,callback,options?):void
Defined in: obsidian.d.ts:936
Registers an DOM event to be detached when unloading
Type Parameters
Section titled “Type Parameters”K extends keyof DocumentEventMap
Parameters
Section titled “Parameters”K
callback
Section titled “callback”(this, ev) => any
options?
Section titled “options?”boolean | AddEventListenerOptions
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”registerDomEvent<
K>(el,type,callback,options?):void
Defined in: obsidian.d.ts:941
Registers an DOM event to be detached when unloading
Type Parameters
Section titled “Type Parameters”K extends keyof HTMLElementEventMap
Parameters
Section titled “Parameters”K
callback
Section titled “callback”(this, ev) => any
options?
Section titled “options?”boolean | AddEventListenerOptions
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”registerDomEvent<
K>(el,type,callback,options?):void
Defined in: src/obsidian/augmentations/Components/Component.d.ts:96
Registers an DOM event to be detached when unloading.
Type Parameters
Section titled “Type Parameters”K extends keyof DocumentEventMap
The type of the event to register.
Parameters
Section titled “Parameters”The element to register the event on.
K
The type of the event to register.
callback
Section titled “callback”(this, ev) => any
The callback to be called when the event is triggered.
options?
Section titled “options?”The options for the event.
boolean | AddEventListenerOptions
Returns
Section titled “Returns”void
Example
Section titled “Example”component.registerDomEvent(document, 'click', () => { console.log('Document clicked');});Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”registerDomEvent<
K>(el,type,callback,options?):void
Defined in: src/obsidian/augmentations/Components/Component.d.ts:119
Registers an DOM event to be detached when unloading.
Type Parameters
Section titled “Type Parameters”K extends keyof HTMLElementEventMap
The type of the event to register.
Parameters
Section titled “Parameters”The element to register the event on.
K
The type of the event to register.
callback
Section titled “callback”(this, ev) => any
The callback to be called when the event is triggered.
options?
Section titled “options?”The options for the event.
boolean | AddEventListenerOptions
Returns
Section titled “Returns”void
Example
Section titled “Example”component.registerDomEvent(document.body, 'click', () => { console.log('Body clicked');});Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”registerDomEvent<
K>(el,type,callback,options?):void
Defined in: src/obsidian/augmentations/Components/Component.d.ts:142
Registers an DOM event to be detached when unloading.
Type Parameters
Section titled “Type Parameters”K extends keyof WindowEventMap
The type of the event to register.
Parameters
Section titled “Parameters”The element to register the event on.
K
The type of the event to register.
callback
Section titled “callback”(this, ev) => any
The callback to be called when the event is triggered.
options?
Section titled “options?”The options for the event.
boolean | AddEventListenerOptions
Returns
Section titled “Returns”void
Example
Section titled “Example”component.registerDomEvent(window, 'click', () => { console.log('Window clicked');});Inherited from
Section titled “Inherited from”registerEvent()
Section titled “registerEvent()”Call Signature
Section titled “Call Signature”registerEvent(
eventRef):void
Defined in: obsidian.d.ts:926
Registers an event to be detached when unloading
Parameters
Section titled “Parameters”eventRef
Section titled “eventRef”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”registerEvent(
eventRef):void
Defined in: src/obsidian/augmentations/Components/Component.d.ts:159
Registers an event to be detached when unloading.
Parameters
Section titled “Parameters”eventRef
Section titled “eventRef”The event to be registered.
Returns
Section titled “Returns”void
Example
Section titled “Example”component.registerEvent(eventRef);Inherited from
Section titled “Inherited from”registerInterval()
Section titled “registerInterval()”Call Signature
Section titled “Call Signature”registerInterval(
id):number
Defined in: obsidian.d.ts:948
Registers an interval (from setInterval) to be cancelled when unloading Use setInterval instead of setInterval to avoid TypeScript confusing between NodeJS vs Browser API
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”registerInterval(
id):number
Defined in: src/obsidian/augmentations/Components/Component.d.ts:175
Registers an interval (from setInterval) to be cancelled when unloading. Use setInterval instead of setInterval to avoid TypeScript confusing between NodeJS vs Browser API
Parameters
Section titled “Parameters”number
The id of the interval to register.
Returns
Section titled “Returns”number
The id of the interval.
Example
Section titled “Example”component.registerInterval(window.setInterval(() => { console.log('Interval');}, 1000));Inherited from
Section titled “Inherited from”registerScopeEvent()
Section titled “registerScopeEvent()”registerScopeEvent(
keymapEventHandler):void
Defined in: src/obsidian/augmentations/Components/Component.d.ts:181
Parameters
Section titled “Parameters”keymapEventHandler
Section titled “keymapEventHandler”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”removeChild()
Section titled “removeChild()”Call Signature
Section titled “Call Signature”removeChild<
T>(component):T
Defined in: obsidian.d.ts:916
Removes a child component, unloading it
Type Parameters
Section titled “Type Parameters”T extends Component
Parameters
Section titled “Parameters”component
Section titled “component”T
Returns
Section titled “Returns”T
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”removeChild<
T>(component):T
Defined in: src/obsidian/augmentations/Components/Component.d.ts:195
Removes a child component, unloading it.
Type Parameters
Section titled “Type Parameters”T extends Component
The type of the component to remove.
Parameters
Section titled “Parameters”component
Section titled “component”T
The component to remove.
Returns
Section titled “Returns”T
The removed component.
Example
Section titled “Example”component.removeChild(childComponent);Inherited from
Section titled “Inherited from”setBacklinkCollapsed()
Section titled “setBacklinkCollapsed()”setBacklinkCollapsed(
arg1,arg2):Promise<unknown>
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:138
Parameters
Section titled “Parameters”unknown
unknown
Returns
Section titled “Returns”Promise<unknown>
setCollapseAll()
Section titled “setCollapseAll()”setCollapseAll(
arg1):unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:141
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”unknown
setExtraContext()
Section titled “setExtraContext()”setExtraContext(
arg1):unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:144
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”unknown
setSectionCollapsed()
Section titled “setSectionCollapsed()”setSectionCollapsed(
arg1,arg2,arg3,arg4):Promise<unknown>
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:147
Parameters
Section titled “Parameters”unknown
unknown
unknown
unknown
Returns
Section titled “Returns”Promise<unknown>
setShowSearch()
Section titled “setShowSearch()”setShowSearch(
arg1):unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:150
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”unknown
setSortOrder()
Section titled “setSortOrder()”setSortOrder(
arg1):unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:153
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”unknown
setState()
Section titled “setState()”setState(
arg1):Promise<unknown>
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:156
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”Promise<unknown>
setUnlinkedCollapsed()
Section titled “setUnlinkedCollapsed()”setUnlinkedCollapsed(
arg1,arg2):Promise<unknown>
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:159
Parameters
Section titled “Parameters”unknown
unknown
Returns
Section titled “Returns”Promise<unknown>
stopBacklinkSearch()
Section titled “stopBacklinkSearch()”stopBacklinkSearch():
void
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:162
Returns
Section titled “Returns”void
stopUnlinkedSearch()
Section titled “stopUnlinkedSearch()”stopUnlinkedSearch():
unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:165
Returns
Section titled “Returns”unknown
toggleBacklinkCollapsed()
Section titled “toggleBacklinkCollapsed()”toggleBacklinkCollapsed():
unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:168
Returns
Section titled “Returns”unknown
toggleUnlinkedCollapsed()
Section titled “toggleUnlinkedCollapsed()”toggleUnlinkedCollapsed():
unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:171
Returns
Section titled “Returns”unknown
unload()
Section titled “unload()”Call Signature
Section titled “Call Signature”unload():
void
Defined in: obsidian.d.ts:900
Unload this component and its children
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”unload():
void
Defined in: src/obsidian/augmentations/Components/Component.d.ts:211
Override this to unload your component.
Returns
Section titled “Returns”void
Example
Section titled “Example”class MyComponent extends Component { public override onunload(): void { console.log('MyComponent unloaded'); }}Inherited from
Section titled “Inherited from”update()
Section titled “update()”update():
unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:174
Returns
Section titled “Returns”unknown
updateHeaderTooltip()
Section titled “updateHeaderTooltip()”updateHeaderTooltip(
arg1,arg2):unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:177
Parameters
Section titled “Parameters”unknown
unknown
Returns
Section titled “Returns”unknown
updateSearch()
Section titled “updateSearch()”updateSearch():
unknown
Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkComponent.d.ts:180
Returns
Section titled “Returns”unknown
Documentation incomplete.