CanvasPluginInstance

Defined in: src/obsidian/internals/InternalPlugins/Canvas/CanvasPluginInstance.d.ts:12

Extends

• InternalPluginInstance<CanvasPlugin>

Properties

app

app: App

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

---

defaultOn

defaultOn: true

Defined in: src/obsidian/internals/InternalPlugins/Canvas/CanvasPluginInstance.d.ts:14

---

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

---

index

index: CanvasIndex

Defined in: src/obsidian/internals/InternalPlugins/Canvas/CanvasPluginInstance.d.ts:15

---

localDataManager

localDataManager: CanvasDataManager

Defined in: src/obsidian/internals/InternalPlugins/Canvas/CanvasPluginInstance.d.ts:16

---

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

CanvasPlugin

Returns

void

Inherited from

InternalPluginInstance.onDisable

---

onEnable()?

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

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

Parameters

app

App

plugin

CanvasPlugin

Returns

Promise<void>

Inherited from

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: object

Defined in: src/obsidian/internals/InternalPlugins/Canvas/CanvasPluginInstance.d.ts:17

cardLabelVisibility?

optional cardLabelVisibility: "always" | "hover" | "never"

defaultModDragBehavior?

optional defaultModDragBehavior: "menu" | "card" | "group" | "media" | "note" | "webpage"

defaultWheelBehavior?

optional defaultWheelBehavior: "pan" | "zoom"

newFileFolderPath?

optional newFileFolderPath: string

newFileLocation?

optional newFileLocation: "folder" | "root" | "current"

snapToGrid?

optional snapToGrid: boolean

snapToObjects?

optional snapToObjects: boolean

zoomBreakpoint?

optional zoomBreakpoint: number

---

plugin

plugin: CanvasPlugin

Defined in: src/obsidian/internals/InternalPlugins/Canvas/CanvasPluginInstance.d.ts:27

---

renameQueue

renameQueue: PromisedQueue

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

---

renames

renames: unknown[]

Defined in: src/obsidian/internals/InternalPlugins/Canvas/CanvasPluginInstance.d.ts:29

---

requestProcessRename

requestProcessRename: Debouncer<[], unknown>

Defined in: src/obsidian/internals/InternalPlugins/Canvas/CanvasPluginInstance.d.ts:30

Methods

init()

init(app, plugin): void

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

Parameters

app

App

plugin

CanvasPlugin

Returns

void

Inherited from

InternalPluginInstance.init