API reference
warning
This documentation has been generated from the Obsidian API.
The script used to generate the documentation is still relatively untested. If you spot any errors or inconsistencies with the official API, let me know.
Classes#
- AbstractTextComponent
- App
- BaseComponent
- ButtonComponent
- Component
- DropdownComponent
- EditableFileView
- Editor
- EditorSuggest
- Events
- ExtraButtonComponent
- FileManager
- FileSystemAdapter
- FileView
- FuzzySuggestModal
- HoverPopover
- ItemView
- Keymap
- MarkdownEditView
- MarkdownPreviewRenderer
- MarkdownPreviewView
- MarkdownRenderChild
- MarkdownRenderer
- MarkdownSourceView
- MarkdownView
- Menu
- MenuItem
- MetadataCache
- Modal
- MomentFormatComponent
- Notice
- Plugin_2
- PluginSettingTab
- PopoverSuggest
- Scope
- SearchComponent
- Setting
- SettingTab
- SliderComponent
- SuggestModal
- TAbstractFile
- Tasks
- TextAreaComponent
- TextComponent
- TextFileView
- TFile
- TFolder
- ToggleComponent
- ValueComponent
- Vault
- View
- Workspace
- WorkspaceItem
- WorkspaceLeaf
- WorkspaceMobileDrawer
- WorkspaceParent
- WorkspaceRibbon
- WorkspaceSidedock
- WorkspaceSplit
- WorkspaceTabs
Enums#
Functions#
- addIcon
- debounce
- finishRenderMath
- fuzzySearch
- getAllTags
- getLinkpath
- htmlToMarkdown
- iterateCacheRefs
- iterateRefs
- loadMathJax
- loadMermaid
- loadPdfJs
- loadPrism
- normalizePath
- parseFrontMatterAliases
- parseFrontMatterEntry
- parseFrontMatterStringArray
- parseFrontMatterTags
- parseLinktext
- parseYaml
- prepareFuzzySearch
- prepareQuery
- prepareSimpleSearch
- renderMatches
- renderMath
- renderResults
- request
- requestUrl
- requireApiVersion
- resolveSubpath
- sanitizeHTMLToDom
- setIcon
- sortSearchResults
- stringifyYaml
- stripHeading
Interfaces#
- EventListenerInfo
- AjaxOptions
- BlockCache
- BlockSubpathResult
- CachedMetadata
- CacheItem
- CloseableComponent
- Command
- Constructor
- DataAdapter
- DataWriteOptions
- Debouncer
- EditorChange
- EditorPosition
- EditorRange
- EditorRangeOrCaret
- EditorSelection
- EditorSelectionOrCaret
- EditorSuggestContext
- EditorSuggestTriggerInfo
- EditorTransaction
- EmbedCache
- EventRef
- FileStats
- FrontMatterCache
- FuzzyMatch
- HeadingCache
- HeadingSubpathResult
- Hotkey
- HoverParent
- Instruction
- ISuggestOwner
- KeymapContext
- KeymapEventHandler
- KeymapInfo
- LinkCache
- ListedFiles
- ListItemCache
- Loc
- MarkdownPostProcessor
- MarkdownPostProcessorContext
- MarkdownPreviewEvents
- MarkdownSectionInformation
- MarkdownSubView
- ObsidianProtocolData
- OpenViewState
- PluginManifest
- Point
- Pos
- PreparedQuery
- Rect_2
- ReferenceCache
- RequestUrlParam
- RequestUrlResponse
- SearchResult
- SearchResultContainer
- SectionCache
- Stat
- SubpathResult
- TagCache
- ViewState
- ViewStateResult