NoteComposerPluginInstance

Defined in: src/obsidian/internals/InternalPlugins/NoteComposer/NoteComposerPluginInstance.d.ts:15

Extends

• InternalPluginInstance<NoteComposerPlugin>

Properties

app

app: App

Defined in: src/obsidian/internals/InternalPlugins/NoteComposer/NoteComposerPluginInstance.d.ts:16

---

defaultOn

defaultOn: true

Defined in: src/obsidian/internals/InternalPlugins/NoteComposer/NoteComposerPluginInstance.d.ts:17

---

description

description: string

Defined in: src/obsidian/internals/InternalPlugins/InternalPluginInstance.d.ts:5

Inherited from

InternalPluginInstance.description

---

id

id: string

Defined in: src/obsidian/internals/InternalPlugins/InternalPluginInstance.d.ts:6

Inherited from

InternalPluginInstance.id

---

name

name: string

Defined in: src/obsidian/internals/InternalPlugins/InternalPluginInstance.d.ts:7

Inherited from

InternalPluginInstance.name

---

onDisable()?

optional onDisable: (app, plugin) => void

Defined in: src/obsidian/internals/InternalPlugins/InternalPluginInstance.d.ts:8

Parameters

app

App

plugin

NoteComposerPlugin

Returns

void

Inherited from

InternalPluginInstance.onDisable

---

onEnable()

onEnable: (app, plugin) => Promise<void>

Defined in: src/obsidian/internals/InternalPlugins/NoteComposer/NoteComposerPluginInstance.d.ts:18

Parameters

app

App

plugin

NoteComposerPlugin

Returns

Promise<void>

Overrides

InternalPluginInstance.onEnable

---

onUserDisable()?

optional onUserDisable: (app) => void

Defined in: src/obsidian/internals/InternalPlugins/InternalPluginInstance.d.ts:10

Parameters

app

App

Returns

void

Inherited from

InternalPluginInstance.onUserDisable

---

onUserEnable()?

optional onUserEnable: (app) => void

Defined in: src/obsidian/internals/InternalPlugins/InternalPluginInstance.d.ts:11

Parameters

app

App

Returns

void

Inherited from

InternalPluginInstance.onUserEnable

---

options

options: NoteComposerPluginOptions

Defined in: src/obsidian/internals/InternalPlugins/NoteComposer/NoteComposerPluginInstance.d.ts:19

---

pluginInstance

pluginInstance: NoteComposerPlugin

Defined in: src/obsidian/internals/InternalPlugins/NoteComposer/NoteComposerPluginInstance.d.ts:20

Methods

applyTemplate()

applyTemplate(content, fromTitle, newTitle): Promise<string>

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

Parameters

content

string

fromTitle

string

newTitle

string

Returns

Promise<string>

---

extractHeading()

extractHeading(file, editor): void

Defined in: src/obsidian/internals/InternalPlugins/NoteComposer/NoteComposerPluginInstance.d.ts:23

Parameters

file

TFile

editor

Editor

Returns

void

---

getSelectionUnderHeading()

getSelectionUnderHeading(file, editor, line): null | HeadingInfo

Defined in: src/obsidian/internals/InternalPlugins/NoteComposer/NoteComposerPluginInstance.d.ts:24

Parameters

file

TFile

editor

Editor

line

number

Returns

null | HeadingInfo

---

init()

init(app, plugin): void

Defined in: src/obsidian/internals/InternalPlugins/InternalPluginInstance.d.ts:13

Parameters

app

App

plugin

NoteComposerPlugin

Returns

void

Inherited from

InternalPluginInstance.init

---

onEditorMenu()

onEditorMenu(menu, editor, info): void

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

Parameters

menu

Menu

editor

Editor

info

MarkdownView | MarkdownFileInfo

Returns

void

---

onExternalSettingsChange()

onExternalSettingsChange(): Promise<void>

Defined in: src/obsidian/internals/InternalPlugins/NoteComposer/NoteComposerPluginInstance.d.ts:26

Returns

Promise<void>

---

onFileMenu()

onFileMenu(menu, file, source): void

Defined in: src/obsidian/internals/InternalPlugins/NoteComposer/NoteComposerPluginInstance.d.ts:27

Parameters

menu

Menu

file

TFile

source

string

Returns

void