Skip to content
Obsidian Typings
Search
Ctrl
K
Cancel
GitHub
Start Here
Getting Started
Usage
Disclaimer
Contributing
Attribution
Guides
Adding New Typings
Analyzing minified source code
Debugging your code
Resources
Electron Changelog
Obsidian Typings Changelog
Showcase
API
namespaces
canvas
interfaces
CanvasData
CanvasEdgeData
CanvasFileData
CanvasGroupData
CanvasLinkData
CanvasNodeData
CanvasTextData
type-aliases
AllCanvasNodeData
BackgroundStyle
CanvasColor
EdgeEnd
NodeSide
codemirror__view
interfaces
EditorView
global
interfaces
DomElementInfo
internals
interfaces
AbstractSearchComponent
Account
AllPropertiesView
AppMenuBarManager
AppSetting
AppVaultConfig
AppVaultConfigHotkeysRecord
AudioRecorderPlugin
AudioRecorderPluginInstance
AudioView
BacklinkPlugin
BacklinkPluginInstance
BacklinkView
BaseEditor
BookmarkItem
BookmarksPlugin
BookmarksPluginInstance
BookmarksView
BrowserHistoryView
BrowserView
CanvasConnection
CanvasDataManager
CanvasEmbed
CanvasIndex
CanvasIndexEntry
CanvasLeaf
CanvasLinkUpdater
CanvasNode
CanvasPlugin
CanvasPluginInstance
CanvasView
CapacitorAdapterFs
ClipBoardManager
CommandPalettePlugin
CommandPalettePluginInstance
Commands
CommandsCommandsRecord
CommandsEditorCommandsRecord
CustomArrayDict
CustomCSS
CustomCSSThemesRecord
CustomCSSUpdatesRecord
DailyNotesPlugin
DailyNotesPluginInstance
DataAdapterFilesRecord
DataAdapterWatchersRecord
Database
Draggable
DragManager
DragStartEvent
DropResult
EditorSearchComponent
EditorStatusPlugin
EditorStatusPluginInstance
EditorSuggests
ElectronWindow
EmbedContext
EmbeddedEditorView
EmbedRegistry
EmbedRegistryEmbedByExtensionRecord
EmptyView
EventsEntry
FileCacheEntry
FileEntry
FileExplorerLeaf
FileExplorerPlugin
FileExplorerPluginInstance
FileExplorerView
FileExplorerViewFileItemsRecord
FilePropertiesView
FileRecoveryPlugin
FileRecoveryPluginInstance
FileSuggest
FileSuggestManager
FileTreeItem
FoldInfo
FoldManager
FrameDom
GlobalSearchLeaf
GlobalSearchPlugin
GlobalSearchPluginInstance
GraphPlugin
GraphPluginInstance
GraphView
HotkeyManager
HotkeyManagerCustomKeysRecord
HotkeyManagerDefaultKeysRecord
HotkeysSettingTab
HoverLinkEvent
IFramedMarkdownEditor
ImageView
ImportedAttachments
InfinityScroll
InfoFileView
InternalPlugin
InternalPluginInstance
InternalPlugins
InternalPluginsConfigRecord
KeyScope
LeafEntry
LinkChangeUpdate
LinkResolverQueue
LinkSuggestion
LinkUpdate
LinkUpdater
LinkUpdaters
LoadProgress
LocalGraphView
Localization
MarkdownBaseView
MarkdownImporterPlugin
MarkdownImporterPluginInstance
MarkdownScrollableEditView
MenuSubmenuConfigRecord
MetadataCacheFileCacheRecord
MetadataCacheMetadataCacheRecord
MetadataEditor
MetadataEditorProperty
MetadataTypeManager
MetadataTypeManagerPropertiesRecord
MetadataTypeManagerRegisteredTypeWidgetsRecord
MetadataTypeManagerTypesRecord
MetadataWidget
MobileFileInfo
MobileNavbar
MobileTabSwitcher
MobileToolbar
NoteComposerPlugin
NoteComposerPluginInstance
ObsidianDOM
ObsidianTouchEvent
OutgoingLinkPlugin
OutgoingLinkPluginInstance
OutgoingLinkView
OutlinePlugin
OutlinePluginInstance
OutlineView
PagePreviewPlugin
PagePreviewPluginInstance
PdfView
Plugins
PluginsManifestsRecord
PluginsPluginsRecord
PluginUpdateManifest
PositionedReference
PromisedQueue
PropertiesPlugin
PropertiesPluginInstance
PropertyEntryData
PropertyInfo
PropertyRenderContext
PropertyWidget
PublishPlugin
PublishPluginInstance
QueueItems
RandomNotePlugin
RandomNotePluginInstance
ReadViewRenderer
RecentFileTracker
ReleaseNotesView
RendererSection
RibbonItem
Runnable
SearchCursor
SearchView
SerializedWorkspace
SerializedWorkspaceItem
SerializedWorkspaceLeftRibbonHiddenItemsRecord
SerializedWorkspaceSidedock
SharedFile
ShareReceiver
SlashCommandPlugin
SlashCommandPluginInstance
SlidesPlugin
SlidesPluginInstance
SQLError
SQLResultSet
SQLResultSetRowList
SQLTransaction
StateHistory
SuggestionContainer
SwitcherPlugin
SwitcherPluginInstance
SyncPlugin
SyncPluginInstance
TableCell
TableCellEditor
TableEditor
TagPanePlugin
TagPanePluginInstance
TagView
TemplatesPlugin
TemplatesPluginInstance
ThemeManifest
Token
Tree
UnknownView
VaultFileMapRecord
VideoView
ViewRegistryTypeByExtensionRecord
ViewRegistryViewByTypeRecord
WeakMapWrapper
WidgetEditorView
WindowSelection
WordCountPlugin
WordCountPluginInstance
WorkspaceHoverLinkSourcesRecord
WorkspacesPlugin
WorkspacesPluginInstance
ZkPrefixerPlugin
ZkPrefixerPluginInstance
type-aliases
CodeBlockPostProcessorHandler
ConfigItem
EmbeddableConstructor
FileSystemWatchHandler
InternalPluginNameInstancesMapping
InternalPluginNamePluginsMapping
InternalPluginNameType
LinkUpdateHandler
PropertyWidgetType
TreeItem
TreeNode
variables
InternalPluginName
obsidian
classes
AbstractInputSuggest
AbstractTextComponent
App
BaseComponent
ButtonComponent
CapacitorAdapter
ColorComponent
Component
DropdownComponent
EditableFileView
Editor
EditorSuggest
Events
ExtraButtonComponent
FileManager
FileSystemAdapter
FileView
FuzzySuggestModal
HoverPopover
ItemView
Keymap
MarkdownEditView
MarkdownPreviewRenderer
MarkdownPreviewView
MarkdownRenderChild
MarkdownRenderer
MarkdownView
Menu
MenuItem
MenuSeparator
MetadataCache
Modal
MomentFormatComponent
Notice
Plugin
PluginSettingTab
PopoverSuggest
ProgressBarComponent
Scope
SearchComponent
Setting
SettingTab
SliderComponent
SuggestModal
TAbstractFile
Tasks
TextAreaComponent
TextComponent
TextFileView
TFile
TFolder
ToggleComponent
ValueComponent
Vault
View
Workspace
WorkspaceContainer
WorkspaceFloating
WorkspaceItem
WorkspaceLeaf
WorkspaceMobileDrawer
WorkspaceParent
WorkspaceRibbon
WorkspaceRoot
WorkspaceSidedock
WorkspaceSplit
WorkspaceTabs
WorkspaceWindow
enumerations
PopoverState
functions
addIcon
arrayBufferToBase64
arrayBufferToHex
base64ToArrayBuffer
debounce
finishRenderMath
getAllTags
getBlobArrayBuffer
getFrontMatterInfo
getIcon
getIconIds
getLinkpath
hexToArrayBuffer
htmlToMarkdown
iterateCacheRefs
iterateRefs
loadMathJax
loadMermaid
loadPdfJs
loadPrism
normalizePath
parseFrontMatterAliases
parseFrontMatterEntry
parseFrontMatterStringArray
parseFrontMatterTags
parseLinktext
parseYaml
prepareFuzzySearch
prepareSimpleSearch
removeIcon
renderMatches
renderMath
renderResults
request
requestUrl
requireApiVersion
resolveSubpath
sanitizeHTMLToDom
setIcon
setTooltip
sortSearchResults
stringifyYaml
stripHeading
stripHeadingForLink
interfaces
BlockCache
BlockSubpathResult
CachedMetadata
CacheItem
CloseableComponent
Command
DataAdapter
DataWriteOptions
Debouncer
EditorChange
EditorPosition
EditorRange
EditorRangeOrCaret
EditorScrollInfo
EditorSelection
EditorSelectionOrCaret
EditorSuggestContext
EditorSuggestTriggerInfo
EditorTransaction
EmbedCache
EventRef
FileStats
FootnoteCache
FootnoteSubpathResult
FrontMatterCache
FrontMatterInfo
FrontmatterLinkCache
FuzzyMatch
HeadingCache
HeadingSubpathResult
Hotkey
HoverLinkSource
HoverParent
HSL
Instruction
ISuggestOwner
KeymapContext
KeymapEventHandler
KeymapInfo
LinkCache
ListedFiles
ListItemCache
livePreviewState
LivePreviewState
Loc
MarkdownFileInfo
MarkdownPostProcessor
MarkdownPostProcessorContext
MarkdownPreviewEvents
MarkdownPreviewSection
MarkdownSectionInformation
MarkdownSubView
MenuPositionDef
ObsidianProtocolData
OpenViewState
Platform
PluginManifest
Point
Pos
PreparedQuery
Reference
ReferenceCache
RequestUrlParam
RequestUrlResponse
RequestUrlResponsePromise
RGB
SearchResult
SearchResultContainer
SectionCache
Stat
SubpathResult
TagCache
TooltipOptions
ViewRegistry
ViewState
ViewStateResult
WorkspaceWindowInitData
namespaces
App
functions
getOverrideConfigDir
MarkdownPreviewRenderer
functions
unregisterCodeBlockPostProcessor
variables
codeBlockPostProcessors
type-aliases
Constructor
EditorCommandName
HexString
IconName
KeymapEventListener
MarkdownViewModeType
Modifier
ObsidianProtocolHandler
PaneType
SearchMatches
SearchMatchPart
Side
SplitDirection
TooltipPlacement
UserEvent
ViewCreator
variables
apiVersion
editorEditorField
editorInfoField
editorLivePreviewField
editorViewField
livePreviewState
moment
Platform
publish
classes
Component
Events
MarkdownPreviewRenderer
MarkdownRenderChild
Publish
interfaces
EventRef
MarkdownPostProcessor
MarkdownPostProcessorContext
MarkdownSectionInformation
GitHub
Obsidian Typings
On this page
Overview
Properties
command
purpose
Instruction
Properties
command
command
:
string
purpose
purpose
:
string