BookmarksPluginInstance

Extends

• InternalPluginInstance<BookmarksPlugin>.Events

Properties

_

_: Record<string, EventsEntry[]>

Inherited from

Events._

---

app

app: App

---

bookmarkedViews

bookmarkedViews: WeakMap<View, HTMLElement>

---

bookmarkLookup

bookmarkLookup: Record<string, BookmarkItem>

---

defaultOn

defaultOn: boolean

---

description

description: string

Inherited from

InternalPluginInstance.description

---

hasValidData

hasValidData: boolean

---

id

id: string

Inherited from

InternalPluginInstance.id

---

items

items: BookmarkItem[]

---

name

name: string

Inherited from

InternalPluginInstance.name

---

onItemsChanged

onItemsChanged: Debouncer<[boolean], void>

---

plugin

plugin: BookmarksPlugin

---

urlBookmarkLookup

urlBookmarkLookup: Record<string, BookmarkItem>

Methods

_onItemsChanged()

_onItemsChanged(arg1): void

Parameters

• arg1: boolean

Returns

void

---

addItem()

addItem(item, instance): void

Parameters

• item: BookmarkItem

• instance: BookmarksPluginInstance

Returns

void

---

editItem()

editItem(item): void

Parameters

• item: BookmarkItem

Returns

void

---

findBookmarkByView()

findBookmarkByView(view): undefined | null | BookmarkItem

Parameters

• view: FileView

Returns

undefined | null | BookmarkItem

---

getBookmarks()

getBookmarks(): BookmarkItem[]

Returns

BookmarkItem[]

---

getItemTitle()

getItemTitle(item): string

Parameters

• item: BookmarkItem

Returns

string

---

init()

init(app, plugin): void

Parameters

• app: App

• plugin: BookmarksPlugin

Returns

void

Inherited from

InternalPluginInstance.init

---

initLeaf()

initLeaf(): void

Returns

void

---

loadData()

loadData(): Promise<boolean>

Returns

Promise<boolean>

---

moveItem()

moveItem(item, instance, arg3): void

Parameters

• item: BookmarkItem

• instance: BookmarksPluginInstance

• arg3: number

Returns

void

---

off()

off(name, callback): void

Parameters

• name: string

• callback

Returns

void

Inherited from

Events.off

---

offref()

offref(ref): void

Parameters

• ref: EventRef

Returns

void

Inherited from

Events.offref

---

on()

on(name, callback, ctx?): EventRef

Parameters

• name: string

• callback

• ctx?: any

Returns

EventRef

Inherited from

Events.on

---

onEditorMenu()

onEditorMenu(menu, editor, info): void

Parameters

• menu: Menu

• editor: Editor

• info: MarkdownView | MarkdownFileInfo

Returns

void

---

onEnable()

onEnable(app, plugin): Promise<void>

Parameters

• app: App

• plugin: BookmarksPlugin

Returns

Promise<void>

---

onExternalSettingsChange()

onExternalSettingsChange(): Promise<void>

Returns

Promise<void>

---

onFileMenu()

onFileMenu(menu, files, source, leaf?): void

Parameters

• menu: Menu

• files: TAbstractFile[]

• source: string

• leaf?: WorkspaceLeaf

Returns

void

---

onFileRename()

onFileRename(file, oldPath): void

Parameters

• file: TFile

• oldPath: string

Returns

void

---

onFilesMenu()

onFilesMenu(menu, files, source, leaf?): void

Parameters

• menu: Menu

• files: TAbstractFile[]

• source: string

• leaf?: WorkspaceLeaf

Returns

void

---

onLeafMenu()

onLeafMenu(menu, leaf): void

Parameters

• menu: Menu

• leaf: WorkspaceLeaf

Returns

void

---

onSearchResultsMenu()

onSearchResultsMenu(menu, search): void

Parameters

• menu: Menu

• search: GlobalSearchLeaf

Returns

void

---

onTabGroupMenu()

onTabGroupMenu(menu, tabsLeaf): void

Parameters

• menu: Menu

• tabsLeaf: WorkspaceTabs

Returns

void

---

onUserEnable()

onUserEnable(): void

Returns

void

---

openBookmark()

openBookmark(item, newLeaf, newLeaf2?): Promise<void>

Parameters

• item: BookmarkItem

• newLeaf: boolean | PaneType

• newLeaf2?: boolean | PaneType

Returns

Promise<void>

---

openBookmarkInLeaf()

openBookmarkInLeaf(item, leaf, newLeaf?): Promise<void>

Parameters

• item: BookmarkItem

• leaf: WorkspaceLeaf

• newLeaf?: boolean | PaneType

Returns

Promise<void>

---

openBookmarks()

openBookmarks(items, newLeaf?): Promise<void>

Parameters

• items: BookmarkItem[]

• newLeaf?: boolean | PaneType

Returns

Promise<void>

---

rebuildBookmarkCache()

rebuildBookmarkCache(): void

Returns

void

---

removeItem()

removeItem(item): void

Parameters

• item: BookmarkItem

Returns

void

---

saveData()

saveData(): void

Returns

void

---

trigger()

trigger(name, …data): void

Parameters

• name: string

• …data: unknown[]

Returns

void

Inherited from

Events.trigger

---

tryTrigger()

tryTrigger(evt, args): void

Parameters

• evt: EventRef

• args: unknown[]

Returns

void

Inherited from

Events.tryTrigger

---

updateTabHeaders()

updateTabHeaders(): void

Returns

void