OutlinePlugin

Defined in: src/obsidian/internals/InternalPlugins/Outline/OutlinePlugin.d.ts:9

Extends

InternalPlugin<OutlinePluginInstance>

Properties

_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

InternalPlugin._children

_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

InternalPlugin._events

_loaded

_loaded: boolean

Defined in: src/obsidian/augmentations/Components/Component.d.ts:27

Whether the component and its children are loaded.

Inherited from

InternalPlugin._loaded

addedButtonEls

addedButtonEls: HTMLDivElement[]

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:22

Inherited from

InternalPlugin.addedButtonEls

app

app: App

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:25

Inherited from

InternalPlugin.app

commands

commands: Command[]

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:28

Inherited from

InternalPlugin.commands

enabled

enabled: boolean

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:31

Inherited from

InternalPlugin.enabled

hasStatusBarItem

hasStatusBarItem: boolean

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:34

Inherited from

InternalPlugin.hasStatusBarItem

instance

instance: OutlinePluginInstance

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:37

Inherited from

InternalPlugin.instance

lastSave

lastSave: number

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:40

Inherited from

InternalPlugin.lastSave

manager

manager: InternalPlugins

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:43

Inherited from

InternalPlugin.manager

mobileFileInfo

mobileFileInfo: MobileFileInfo[]

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:46

Inherited from

InternalPlugin.mobileFileInfo

onConfigFileChange

onConfigFileChange: Debouncer<[], Promise<void>>

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:49

Inherited from

InternalPlugin.onConfigFileChange

ribbonItems

ribbonItems: RibbonItem[]

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:52

Inherited from

InternalPlugin.ribbonItems

statusBarEl

statusBarEl: null | HTMLDivElement

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:55

Inherited from

InternalPlugin.statusBarEl

views

views: Record<string, ViewCreator>

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:58

Inherited from

InternalPlugin.views

Methods

addChild()

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

T

T extends Component

Parameters

component

T

Returns

T

Inherited from

InternalPlugin.addChild

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

T

T extends Component

The type of the component to add.

Parameters

component

T

The component to add.

Returns

T

The added component.

Example

component.addChild(childComponent);

Inherited from

InternalPlugin.addChild

addSettingTab()

addSettingTab(settingTab): void

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:61

Parameters

settingTab

PluginSettingTab

Returns

void

Inherited from

InternalPlugin.addSettingTab

deleteData()

deleteData(): Promise<void>

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:64

Returns

Promise<void>

Inherited from

InternalPlugin.deleteData

disable()

disable(isDisabledByUser?): void

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:67

Parameters

isDisabledByUser?

boolean

Returns

void

Inherited from

InternalPlugin.disable

enable()

enable(isEnabledByUser?): Promise<void>

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:70

Parameters

isEnabledByUser?

boolean

Returns

Promise<void>

Inherited from

InternalPlugin.enable

getModifiedTime()

getModifiedTime(): Promise<undefined | number>

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:73

Returns

Promise<undefined | number>

Inherited from

InternalPlugin.getModifiedTime

handleConfigFileChange()

handleConfigFileChange(): Promise<void>

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:76

Returns

Promise<void>

Inherited from

InternalPlugin.handleConfigFileChange

init()

init(): void

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:79

Returns

void

Inherited from

InternalPlugin.init

load()

Call Signature

load(): void

Defined in: obsidian.d.ts:889

Load this component and its children

Returns

void

Inherited from

InternalPlugin.load

Call Signature

load(): void

Defined in: src/obsidian/augmentations/Components/Component.d.ts:48

Load this component and its children.

Returns

void

Inherited from

InternalPlugin.load

loadData()

loadData(): Promise<null | object>

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:82

Returns

Promise<null | object>

Inherited from

InternalPlugin.loadData

onload()

Call Signature

onload(): void

Defined in: obsidian.d.ts:895

Override this to load your component

Returns

void

Inherited from

InternalPlugin.onload

Call Signature

onload(): void

Defined in: src/obsidian/augmentations/Components/Component.d.ts:64

Override this to load your component.

Returns

void

Example

class MyComponent extends Component {
  public override onload(): void {
    console.log('MyComponent loaded');
  }
}

Inherited from

InternalPlugin.onload

onunload()

onunload(): void

Defined in: obsidian.d.ts:906

Override this to unload your component

Returns

void

Inherited from

InternalPlugin.onunload

register()

Call Signature

register(cb): void

Defined in: obsidian.d.ts:921

Registers a callback to be called when unloading

Parameters

cb

() => any

Returns

void

Inherited from

InternalPlugin.register

Call Signature

register(cb): void

Defined in: src/obsidian/augmentations/Components/Component.d.ts:78

Registers a callback to be called when unloading.

Parameters

cb

() => any

The callback to be called when unloading.

Returns

void

Example

component.register(() => {
  console.log('MyComponent unloaded');
});

Inherited from

InternalPlugin.register

registerDomEvent()

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

K

K extends keyof WindowEventMap

Parameters

el

Window

type

K

callback

(this, ev) => any

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

InternalPlugin.registerDomEvent

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

K

K extends keyof DocumentEventMap

Parameters

el

Document

type

K

callback

(this, ev) => any

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

InternalPlugin.registerDomEvent

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

K

K extends keyof HTMLElementEventMap

Parameters

el

HTMLElement

type

K

callback

(this, ev) => any

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

InternalPlugin.registerDomEvent

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

K

K extends keyof DocumentEventMap

The type of the event to register.

Parameters

el

Document

The element to register the event on.

type

K

The type of the event to register.

callback

(this, ev) => any

The callback to be called when the event is triggered.

options?

The options for the event.

boolean | AddEventListenerOptions

Returns

void

Example

component.registerDomEvent(document, 'click', () => {
  console.log('Document clicked');
});

Inherited from

InternalPlugin.registerDomEvent

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

K

K extends keyof HTMLElementEventMap

The type of the event to register.

Parameters

el

HTMLElement

The element to register the event on.

type

K

The type of the event to register.

callback

(this, ev) => any

The callback to be called when the event is triggered.

options?

The options for the event.

boolean | AddEventListenerOptions

Returns

void

Example

component.registerDomEvent(document.body, 'click', () => {
  console.log('Body clicked');
});

Inherited from

InternalPlugin.registerDomEvent

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

K

K extends keyof WindowEventMap

The type of the event to register.

Parameters

el

Window

The element to register the event on.

type

K

The type of the event to register.

callback

(this, ev) => any

The callback to be called when the event is triggered.

options?

The options for the event.

boolean | AddEventListenerOptions

Returns

void

Example

component.registerDomEvent(window, 'click', () => {
  console.log('Window clicked');
});

Inherited from

InternalPlugin.registerDomEvent

registerEvent()

Call Signature

registerEvent(eventRef): void

Defined in: obsidian.d.ts:926

Registers an event to be detached when unloading

Parameters

eventRef

EventRef

Returns

void

Inherited from

InternalPlugin.registerEvent

Call Signature

registerEvent(eventRef): void

Defined in: src/obsidian/augmentations/Components/Component.d.ts:159

Registers an event to be detached when unloading.

Parameters

eventRef

EventRef

The event to be registered.

Returns

void

Example

component.registerEvent(eventRef);

Inherited from

InternalPlugin.registerEvent

registerGlobalCommand()

registerGlobalCommand(command): void

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:85

Parameters

command

Command

Returns

void

Inherited from

InternalPlugin.registerGlobalCommand

registerInterval()

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

id

number

Returns

number

Inherited from

InternalPlugin.registerInterval

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

id

number

The id of the interval to register.

Returns

number

The id of the interval.

Example

component.registerInterval(window.setInterval(() => {
  console.log('Interval');
}, 1000));

Inherited from

InternalPlugin.registerInterval

registerMobileFileInfo()

registerMobileFileInfo(renderCallback): void

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:88

Parameters

renderCallback

(el) => void

Returns

void

Inherited from

InternalPlugin.registerMobileFileInfo

registerRibbonItem()

registerRibbonItem(title, icon, callback): void

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:91

Parameters

title

string

icon

string

callback

() => Promise<void>

Returns

void

Inherited from

InternalPlugin.registerRibbonItem

registerScopeEvent()

registerScopeEvent(keymapEventHandler): void

Defined in: src/obsidian/augmentations/Components/Component.d.ts:181

Parameters

keymapEventHandler

KeymapEventHandler

Returns

void

Inherited from

InternalPlugin.registerScopeEvent

registerStatusBarItem()

registerStatusBarItem(): void

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:94

Returns

void

Inherited from

InternalPlugin.registerStatusBarItem

registerViewType()

registerViewType(type, creator): void

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:97

Parameters

type

string

creator

ViewCreator

Returns

void

Inherited from

InternalPlugin.registerViewType

removeChild()

Call Signature

removeChild<T>(component): T

Defined in: obsidian.d.ts:916

Removes a child component, unloading it

Type Parameters

T

T extends Component

Parameters

component

T

Returns

T

Inherited from

InternalPlugin.removeChild

Call Signature

removeChild<T>(component): T

Defined in: src/obsidian/augmentations/Components/Component.d.ts:195

Removes a child component, unloading it.

Type Parameters

T

T extends Component

The type of the component to remove.

Parameters

component

T

The component to remove.

Returns

T

The removed component.

Example

component.removeChild(childComponent);

Inherited from

InternalPlugin.removeChild

saveData()

saveData(data): Promise<void>

Defined in: src/obsidian/internals/InternalPlugins/InternalPlugin.d.ts:100

Parameters

data

object

Returns

Promise<void>

Inherited from

InternalPlugin.saveData

unload()

Call Signature

unload(): void

Defined in: obsidian.d.ts:900

Unload this component and its children

Returns

void

Inherited from

InternalPlugin.unload

Call Signature

unload(): void

Defined in: src/obsidian/augmentations/Components/Component.d.ts:211

Override this to unload your component.

Returns

void

Example

class MyComponent extends Component {
  public override onunload(): void {
    console.log('MyComponent unloaded');
  }
}

Inherited from

InternalPlugin.unload