BookmarksPluginInstance

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:24

Extends

• InternalPluginInstance<BookmarksPlugin>.Events

Properties

_

_: Record<string, EventsEntry[]>

Defined in: src/obsidian/augmentations/Events.d.ts:5

Inherited from

Events._

---

app

app: App

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

---

bookmarkedViews

bookmarkedViews: WeakMap<View, HTMLElement>

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:26

---

bookmarkLookup

bookmarkLookup: Record<string, BookmarkItem>

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:27

---

defaultOn

defaultOn: true

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

---

description

description: string

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

Inherited from

InternalPluginInstance.description

---

hasValidData

hasValidData: boolean

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:29

---

id

id: string

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

Inherited from

InternalPluginInstance.id

---

items

items: BookmarkItem[]

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:30

---

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

BookmarksPlugin

Returns

void

Inherited from

InternalPluginInstance.onDisable

---

onItemsChanged

onItemsChanged: Debouncer<[boolean], void>

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

---

onUserDisable()?

optional onUserDisable: (app) => void

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

Parameters

app

App

Returns

void

Inherited from

InternalPluginInstance.onUserDisable

---

plugin

plugin: BookmarksPlugin

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:32

---

urlBookmarkLookup

urlBookmarkLookup: Record<string, BookmarkItem>

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:33

Methods

_onItemsChanged()

_onItemsChanged(shouldSave): void

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:35

Parameters

shouldSave

boolean

Returns

void

---

addItem()

addItem(item, instance?): void

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:36

Parameters

item

BookmarkItem

instance?

BookmarksPluginInstance

Returns

void

---

editItem()

editItem(item): void

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

Parameters

item

BookmarkItem

Returns

void

---

findBookmarkByView()

findBookmarkByView(view): undefined | null | BookmarkItem

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:38

Parameters

view

FileView

Returns

undefined | null | BookmarkItem

---

getBookmarks()

getBookmarks(): BookmarkItem[]

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:39

Returns

BookmarkItem[]

---

getItemTitle()

getItemTitle(item): string

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

Parameters

item

BookmarkItem

Returns

string

---

init()

init(app, plugin): void

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

Parameters

app

App

plugin

BookmarksPlugin

Returns

void

Inherited from

InternalPluginInstance.init

---

initLeaf()

initLeaf(): void

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:41

Returns

void

---

loadData()

loadData(): Promise<boolean>

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:42

Returns

Promise<boolean>

---

moveItem()

moveItem(item, instance, index): void

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

Parameters

item

BookmarkItem

instance

undefined | BookmarksPluginInstance

index

number

Returns

void

---

off()

off(name, callback): void

Defined in: obsidian.d.ts:1441

Parameters

name

string

callback

(…data) => unknown

Returns

void

Inherited from

Events.off

---

offref()

offref(ref): void

Defined in: obsidian.d.ts:1445

Parameters

ref

EventRef

Returns

void

Inherited from

Events.offref

---

on()

on(name, callback, ctx?): EventRef

Defined in: obsidian.d.ts:1437

Parameters

name

string

callback

(…data) => unknown

ctx?

any

Returns

EventRef

Inherited from

Events.on

---

onEditorMenu()

onEditorMenu(menu, editor, info): void

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:44

Parameters

menu

Menu

editor

Editor

info

MarkdownView | MarkdownFileInfo

Returns

void

---

onEnable()

onEnable(app, plugin): Promise<void>

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:45

Parameters

app

App

plugin

BookmarksPlugin

Returns

Promise<void>

Overrides

InternalPluginInstance.onEnable

---

onExternalSettingsChange()

onExternalSettingsChange(): Promise<void>

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

Returns

Promise<void>

---

onFileMenu()

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

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:47

Parameters

menu

Menu

files

TAbstractFile[]

source

string

leaf?

WorkspaceLeaf

Returns

void

---

onFileRename()

onFileRename(file, oldPath): void

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:48

Parameters

file

TFile

oldPath

string

Returns

void

---

onFilesMenu()

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

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

Parameters

menu

Menu

files

TAbstractFile[]

source

string

leaf?

WorkspaceLeaf

Returns

void

---

onLeafMenu()

onLeafMenu(menu, leaf): void

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:50

Parameters

menu

Menu

leaf

WorkspaceLeaf

Returns

void

---

onSearchResultsMenu()

onSearchResultsMenu(menu, search): void

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:51

Parameters

menu

Menu

search

TypedWorkspaceLeaf<SearchView>

Returns

void

---

onTabGroupMenu()

onTabGroupMenu(menu, tabsLeaf): void

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

Parameters

menu

Menu

tabsLeaf

WorkspaceTabs

Returns

void

---

onUserEnable()

onUserEnable(): void

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:53

Returns

void

Overrides

InternalPluginInstance.onUserEnable

---

openBookmark()

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

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:54

Parameters

item

BookmarkItem

newLeaf

boolean | PaneType

newLeaf2?

boolean | PaneType

Returns

Promise<void>

---

openBookmarkInLeaf()

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

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

Parameters

item

BookmarkItem

leaf

WorkspaceLeaf

newLeaf?

boolean | PaneType

Returns

Promise<void>

---

openBookmarks()

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

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:56

Parameters

items

BookmarkItem[]

newLeaf?

boolean | PaneType

Returns

Promise<void>

---

rebuildBookmarkCache()

rebuildBookmarkCache(): void

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:57

Returns

void

---

removeItem()

removeItem(item): void

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

Parameters

item

BookmarkItem

Returns

void

---

saveData()

saveData(): void

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:59

Returns

void

---

trigger()

trigger(name, …data): void

Defined in: obsidian.d.ts:1449

Parameters

name

string

data

…unknown[]

Returns

void

Inherited from

Events.trigger

---

tryTrigger()

tryTrigger(evt, args): void

Defined in: obsidian.d.ts:1453

Parameters

evt

EventRef

args

unknown[]

Returns

void

Inherited from

Events.tryTrigger

---

updateTabHeaders()

updateTabHeaders(): void

Defined in: src/obsidian/internals/InternalPlugins/Bookmarks/BookmarksPluginInstance.d.ts:60

Returns

void