Skip to content

Obsidian Typings

Start Here
Guides
Resources
API
- obsidian-typings
  - namespaces
    
    canvas
    
    interfaces
    
    CanvasData
    CanvasEdgeData
    CanvasFileData
    CanvasGroupData
    CanvasLinkData
    CanvasNodeData
    CanvasTextData
    
    type-aliases
    
    AllCanvasNodeData
    BackgroundStyle
    CanvasColor
    EdgeEnd
    NodeSide
    
    codemirror__language
    
    interfaces
    
    StringStream
    
    namespaces
    
    Language
    
    variables
    
    setState TODO
    state TODO
    
    variables
    
    ignoreSpellcheckToken TODO
    lineClassNodeProp
    lineHighlighter
    tokenClassNodeProp
    
    codemirror__state
    
    interfaces
    
    Transaction
    
    codemirror__view
    
    interfaces
    
    EditorView
    WidgetType
    
    global
    
    interfaces
    
    AjaxOptions
    Array
    ArrayConstructor
    Document
    DocumentFragment
    DomElementInfo
    Element
    EventListenerInfo
    HTMLElement
    Math
    Node
    NumberConstructor
    ObjectConstructor
    String
    StringConstructor
    SVGElement
    SvgElementInfo
    Touch
    UIEvent
    Window
    
    variables
    
    app
    
    i18next
    
    variables
    
    isLanguageChangingTo TODO
    logger TODO
    observers TODO
    translator TODO
    
    internals
    
    classes
    
    CustomArrayDictImpl TODO
    HighlightOutline TODO
    HighlightOutliner TODO
    Outline TODO
    
    functions
    
    createTFileInstance
    createTFolderInstance
    getAppConstructor
    getInternalPluginConstructor
    getInternalPluginsConstructor
    getTFileConstructor
    getTFolderConstructor
    getViewConstructorByViewType
    isEmbedCache
    isFrontmatterLinkCache
    isLinkCache
    isReferenceCache
    parentFolderPath
    
    interfaces
    
    AbsFunction TODO
    AbstractFileTreeItem TODO
    AbstractSearchComponent TODO
    Account TODO
    AliasesPropertyWidgetComponent TODO
    AllPropertiesView TODO
    AllPropertiesViewConstructor TODO
    AppConstructor
    AppMenuBarManager TODO
    AppMenuBarManagerConstructor TODO
    AppSetting TODO
    AppVaultConfig TODO
    AppVaultConfigHotkeysRecord TODO
    AudioRecorderPlugin TODO
    AudioRecorderPluginInstance TODO
    AudioView TODO
    AudioViewConstructor TODO
    BacklinkComponent TODO
    BacklinkPlugin TODO
    BacklinkPluginInstance TODO
    BacklinkPluginInstanceOptions TODO
    BacklinkPluginViews TODO
    BacklinkView TODO
    BacklinkViewConstructor TODO
    BaseEditor TODO
    BasesFunction TODO
    BasesFunctionArg TODO
    BasesFunctions TODO
    BasesHandlers TODO
    BasesPlugin TODO
    BasesPluginInstance TODO
    BBox TODO
    Bezier TODO
    BookmarkItem TODO
    BookmarksPlugin TODO
    BookmarksPluginInstance TODO
    BookmarksPluginViews TODO
    BookmarksView TODO
    BookmarksViewConstructor TODO
    Btime TODO
    CanvasConnection TODO
    CanvasDataManager TODO
    CanvasEmbed TODO
    CanvasIndex TODO
    CanvasIndexEntry TODO
    CanvasLinkUpdater TODO
    CanvasMenu TODO
    CanvasNode TODO
    CanvasPlugin TODO
    CanvasPluginInstance TODO
    CanvasPluginInstanceOptions TODO
    CanvasRectEx TODO
    CanvasSelection TODO
    CanvasView TODO
    CanvasViewCanvas TODO
    CanvasViewCanvasEdge TODO
    CanvasViewCanvasEdgeLineEnd TODO
    CanvasViewCanvasEdgeLink TODO
    CanvasViewCanvasEdgePath TODO
    CanvasViewCanvasNode TODO
    CanvasViewCanvasNodeBase TODO
    CanvasViewCanvasNodeBaseBase TODO
    CanvasViewCanvasNodeBaseBaseBase TODO
    CanvasViewCanvasNodeUnknownData TODO
    CanvasViewConfig TODO
    CanvasViewConstructor TODO
    CanvasViewData TODO
    CanvasViewDataEdge TODO
    CanvasViewDataNode TODO
    CanvasViewHistory TODO
    CapacitorAdapterFs TODO
    CapacitorFileEntry TODO
    CeilFunction TODO
    CheckboxPropertyWidgetComponent TODO
    ClickableToken TODO
    ClipboardManager TODO
    CommandPaletteModal TODO
    CommandPaletteOptions TODO
    CommandPalettePlugin TODO
    CommandPalettePluginInstance TODO
    Commands TODO
    CommandsCommandsRecord TODO
    CommandsEditorCommandsRecord TODO
    ConcatFunction TODO
    ConstructorBase TODO
    ContainsAllFunction TODO
    ContainsAnyFunction TODO
    ContainsFunction TODO
    ContainsNoneFunction TODO
    CoordsLeftTop TODO
    CustomArrayDict TODO
    CustomCSS TODO
    CustomCSSThemesRecord TODO
    CustomCSSUpdatesRecord TODO
    DailyNotesOptions TODO
    DailyNotesPlugin TODO
    DailyNotesPluginInstance TODO
    DataAdapterFilesRecord TODO
    DataAdapterWatchersRecord
    DataAdapterWatchersRecordEntry TODO
    Database TODO
    DateAfterFunction TODO
    DateBeforeFunction TODO
    DateDiffFunction TODO
    DateEqualsFunction TODO
    DateModifyFunction TODO
    DateNotEqualsFunction TODO
    DateOnOrAfterFunction TODO
    DateOnOrBeforeFunction TODO
    DatePropertyWidgetComponent TODO
    DatetimePropertyWidgetComponent TODO
    DayFunction TODO
    DeferredView TODO
    Dimensions TODO
    DownloadLegacyThemeOptions TODO
    Draggable TODO
    DragManager TODO
    DragStartEvent TODO
    DropResult TODO
    EdgeIndex TODO
    EdgeIndexBase TODO
    EdgeIndexBaseBase TODO
    EdgeIndexData TODO
    EditorSearchComponent TODO
    EditorStatusPlugin TODO
    EditorStatusPluginInstance TODO
    EditorSuggestEx TODO
    EditorSuggests TODO
    ElectronWindow TODO
    EmbedAudioComponent
    EmbedCanvasComponent
    EmbedComponent
    EmbedContext
    EmbeddedEditorView TODO
    EmbedImageComponent
    EmbedMarkdownComponent
    EmbedPdfComponent
    EmbedRegistry
    EmbedRegistryEmbedByExtensionRecord
    EmbedVideoComponent
    EmptyFunction TODO
    EmptyView TODO
    EmptyViewConstructor TODO
    EnsureSideLeafOptions TODO
    EqualFunction TODO
    EventsEntry TODO
    ExtendedMetrics TODO
    FileBookmarkItem TODO
    FileCacheEntry TODO
    FileEntry TODO
    FileExplorerPlugin TODO
    FileExplorerPluginInstance TODO
    FileExplorerView TODO
    FileExplorerViewConstructor TODO
    FileExplorerViewFileItemsRecord TODO
    FilePropertiesView TODO
    FilePropertiesViewConstructor TODO
    FilePropertyWidgetComponent TODO
    FileRecoveryPlugin TODO
    FileRecoveryPluginInstance TODO
    FileSuggest TODO
    FileSuggestManager TODO
    FileSystemWatchHandler TODO
    FileTreeItem TODO
    FlatFunction TODO
    FloorFunction TODO
    FocusMetadataOptions TODO
    Fold TODO
    FolderBookmarkItem TODO
    FolderPropertyWidgetComponent TODO
    FolderTreeItem TODO
    FoldInfo TODO
    FoldManager TODO
    FootnotesPlugin TODO
    FootnotesPluginInstance TODO
    FrameDom TODO
    GetRecentFilesOptions TODO
    GetTypeInfoOptions TODO
    GlobalSearchPlugin TODO
    GlobalSearchPluginInstance TODO
    GraphBookmarkItem TODO
    GraphColorAttributes
    GraphColorGroup
    GraphColorGroupOptions TODO
    GraphColorGroupOptionsGroup TODO
    GraphData
    GraphDisplayOptions TODO
    GraphEngine
    GraphFileFilter TODO
    GraphFilterOptions TODO
    GraphForceOptions TODO
    GraphForces
    GraphLink
    GraphNode
    GraphNodeData
    GraphOptions TODO
    GraphPlugin TODO
    GraphPluginInstance TODO
    GraphPluginInstanceOptions TODO
    GraphRenderer TODO
    GraphView
    GraphViewConstructor TODO
    GreaterFunction TODO
    GreaterOrEqualFunction TODO
    GroupBookmarkItem TODO
    HasCompare TODO
    HasExtract TODO
    HasGetDisplayName TODO
    HasGetRHSWidgetType TODO
    HeaderDom TODO
    HeadingInfo TODO
    HotkeyManager TODO
    HotkeyManagerCustomKeysRecord TODO
    HotkeyManagerDefaultKeysRecord TODO
    HotkeysSettingTab TODO
    HourFunction TODO
    HoverLinkEvent TODO
    HoverLinkEventState TODO
    IfFunction TODO
    IFramedMarkdownEditor TODO
    ImageView TODO
    ImageViewConstructor TODO
    ImportedAttachments TODO
    IndexFunction TODO
    InfinityScroll TODO
    InfoFileView TODO
    InFolderFunction TODO
    InstallThemeOptions TODO
    InternalPlugin TODO
    InternalPluginConstructor
    InternalPluginInstance TODO
    InternalPlugins TODO
    InternalPluginsConfigRecord TODO
    InternalPluginsConstructor
    ItemQueue TODO
    ItemQueueItems TODO
    JoinFunction TODO
    KeyboardActions
    KeyScope TODO
    LeafEntry TODO
    LenFunction TODO
    LessFunction TODO
    LessOrEqualFunction TODO
    LinkChangeUpdate TODO
    LinksToFunction TODO
    LinkSuggestion
    LinkUpdate TODO
    LinkUpdater TODO
    LinkUpdaters TODO
    LoadProgress TODO
    LocalGraphView
    LocalGraphViewConstructor TODO
    Localization TODO
    MapOfSets TODO
    MarkdownBaseView TODO
    MarkdownEditViewEphemeralState TODO
    MarkdownImporterPlugin TODO
    MarkdownImporterPluginInstance TODO
    MarkdownScrollableEditView TODO
    MarkdownViewConstructor TODO
    MarkdownViewEphemeralState TODO
    MarkdownViewModes TODO
    MarkdownViewSourceMode TODO
    MathJax TODO
    MenuSubmenuConfigRecord TODO
    MetadataCacheFileCacheRecord TODO
    MetadataCacheMetadataCacheRecord TODO
    MetadataCacheWorkerMessage TODO
    MetadataEditor TODO
    MetadataEditorProperty TODO
    MetadataEditorPropertyTypeInfo TODO
    MetadataTypeManager TODO
    MetadataTypeManagerPropertiesRecord TODO
    MetadataTypeManagerRegisteredTypeWidgetsRecord TODO
    MetadataTypeManagerTypesRecord TODO
    MetadataWidget TODO
    MinFunction TODO
    MinuteFunction TODO
    MobileFileInfo TODO
    MobileNavbar TODO
    MobileTabSwitcher TODO
    MobileToolbar TODO
    MonthFunction TODO
    Multiselect TODO
    MultitextPropertyWidgetComponent TODO
    NodeInteractionLayer TODO
    NotContainsFunction TODO
    NoteComposerPlugin TODO
    NoteComposerPluginInstance TODO
    NoteComposerPluginOptions TODO
    NotEmptyFunction TODO
    NotEqualFunction TODO
    NotFunction TODO
    NowFunction TODO
    NumberPropertyWidgetComponent TODO
    ObsidianDOM TODO
    ObsidianTouchEvent TODO
    ObsidianTouchEventRegisterCallback TODO
    OptionContext TODO
    OutgoingLinkPlugin TODO
    OutgoingLinkPluginInstance TODO
    OutgoingLinkView TODO
    OutgoingLinkViewConstructor TODO
    OutlinePlugin TODO
    OutlinePluginInstance TODO
    OutlineView TODO
    OutlineViewConstructor TODO
    PagePreviewPlugin TODO
    PagePreviewPluginInstance TODO
    PdfExportSettings TODO
    PdfJsTestingUtils TODO
    PdfView TODO
    PdfViewConstructor TODO
    PlatformEx
    Plugins TODO
    PluginsManifestsRecord TODO
    PluginsPluginsRecord TODO
    PluginUpdateManifest TODO
    Pointer TODO
    PositionedReference TODO
    PowerTag
    PromisedQueue TODO
    PropertiesPlugin TODO
    PropertiesPluginInstance TODO
    PropertyEntryData TODO
    PropertyInfo TODO
    PropertyRenderContext TODO
    PropertyWidget TODO
    PropertyWidgetComponentBase TODO
    PropertyWidgetEntry TODO
    PublishPlugin TODO
    PublishPluginInstance TODO
    RandomNotePlugin TODO
    RandomNotePluginInstance TODO
    ReadViewRenderer TODO
    RecentFileTracker TODO
    ReleaseNotesView TODO
    ReleaseNotesViewConstructor TODO
    RendererSection TODO
    ResultDom TODO
    ResultDomItem TODO
    ResultDomItemChild TODO
    ResultDomResult TODO
    ResultProperty TODO
    RibbonItem TODO
    RoundFunction TODO
    Runnable TODO
    SearchBookmarkItem TODO
    SearchCursor TODO
    SearchView TODO
    SearchViewConstructor TODO
    SecondFunction TODO
    SerializedWorkspace TODO
    SerializedWorkspaceItem TODO
    SerializedWorkspaceLeafHistory TODO
    SerializedWorkspaceLeftRibbon TODO
    SerializedWorkspaceLeftRibbonHiddenItemsRecord TODO
    SerializedWorkspaceSidedock TODO
    SetHighlightMatch TODO
    SharedFile TODO
    ShareReceiver TODO
    SlashCommandPlugin TODO
    SlashCommandPluginInstance TODO
    SliceFunction TODO
    SlidesPlugin TODO
    SlidesPluginInstance TODO
    SQLError TODO
    SQLResultSet TODO
    SQLResultSetRowList TODO
    SQLTransaction TODO
    StateHistory TODO
    StateHistoryEphemeralState TODO
    StateHistoryLeafHistory TODO
    StatusBar TODO
    Submenu TODO
    SuggestionContainer TODO
    SuggestModalChooser TODO
    SwitcherPlugin TODO
    SwitcherPluginInstance TODO
    SyncPlugin TODO
    SyncPluginInstance TODO
    SyncView TODO
    SyncViewConstructor TODO
    TableCell TODO
    TableCellEditor TODO
    TableEditor TODO
    TableView TODO
    TableViewConstructor TODO
    TaggedWithFunction TODO
    TagPanePlugin TODO
    TagPanePluginInstance TODO
    TagsPropertyWidgetComponent TODO
    TagView TODO
    TagViewConstructor TODO
    TemplatesPlugin TODO
    TemplatesPluginInstance TODO
    TextPropertyWidgetComponent TODO
    TFileConstructor
    TFolderConstructor
    ThemeManifest TODO
    TitleFunction TODO
    Token TODO
    Tree TODO
    TreeCollapsibleItem TODO
    TreeItem TODO
    TreeNode TODO
    TreeNodeInfo TODO
    TreeNodeVChildren TODO
    TreeRoot TODO
    TrimFunction TODO
    TypedViewConstructor
    TypedWorkspaceLeaf TODO
    TypeInfo TODO
    UniqueFunction TODO
    UnknownView TODO
    UrlBookmarkItem TODO
    VaultFileMapRecord TODO
    VideoView TODO
    VideoViewConstructor TODO
    ViewEphemeralState TODO
    ViewRegistry TODO
    ViewRegistryTypeByExtensionRecord TODO
    ViewRegistryViewByTypeRecord TODO
    WeakMapWrapper TODO
    WebviewerDBStore TODO
    WebviewerHistoryItem
    WebviewerHistoryView TODO
    WebviewerHistoryViewConstructor TODO
    WebviewerPlugin TODO
    WebviewerPluginInstance TODO
    WebviewerView TODO
    WebviewerViewConstructor TODO
    WidgetEditorView TODO
    WindowSelection TODO
    WordCountPlugin TODO
    WordCountPluginInstance TODO
    WorkerResults
    WorkspaceHoverLinkSourcesRecord TODO
    WorkspaceLeafHistory TODO
    WorkspaceLeafHistoryState TODO
    WorkspacesPlugin TODO
    WorkspacesPluginInstance TODO
    YearFunction TODO
    ZkPrefixerPlugin TODO
    ZkPrefixerPluginInstance TODO
    
    type-aliases
    
    CapacitorAdapterFsConstructor
    CodeBlockPostProcessorHandler
    ConfigItem TODO
    ContentPosition TODO
    EmbedCreator
    FileExplorerViewSortOrder TODO
    FileTreeItemParent TODO
    FocusMode TODO
    GraphColor
    InternalPluginNameInstancesMapping TODO
    InternalPluginNamePluginsMapping TODO
    InternalPluginNameType TODO
    LinkUpdatesHandler TODO
    Mapping TODO
    MaybeDeferredView TODO
    PlatformType TODO
    PropertyWidgetType TODO
    TextDirection
    TypedViewCreator TODO
    ViewFactory TODO
    ViewTypeType TODO
    ViewTypeViewConstructorMapping TODO
    ViewTypeViewMapping TODO
    
    variables
    
    FileExtension TODO
    InternalPluginName TODO
    ViewType TODO
    
    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
    displayTooltip
    finishRenderMath
    getAllTags
    getBlobArrayBuffer
    getFrontMatterInfo
    getIcon
    getIconIds
    getLanguage
    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
    FootnoteRefCache
    FootnoteSubpathResult
    FrontMatterCache
    FrontMatterInfo
    FrontmatterLinkCache
    FuzzyMatch
    HeadingCache
    HeadingSubpathResult
    Hotkey
    HoverLinkSource
    HoverParent
    HSL
    Instruction
    ISuggestOwner
    KeymapContext
    KeymapEventHandler
    KeymapInfo
    LinkCache
    ListedFiles
    ListItemCache
    LivePreviewStateType
    Loc
    MarkdownFileInfo
    MarkdownPostProcessor
    MarkdownPostProcessorContext
    MarkdownPreviewEvents
    MarkdownSectionInformation
    MarkdownSubView
    MenuPositionDef
    ObsidianProtocolData
    OpenViewState
    PluginManifest
    Point
    Pos
    Reference
    ReferenceCache
    ReferenceLinkCache
    RequestUrlParam
    RequestUrlResponse
    RequestUrlResponsePromise
    RGB
    SearchResult
    SearchResultContainer
    SectionCache
    Stat
    SubpathResult
    TagCache
    TooltipOptions
    ViewState
    ViewStateResult
    WorkspaceWindowInitData
    
    namespaces
    
    App
    
    functions
    
    getOverrideConfigDir
    
    FileSystemAdapter
    
    functions
    
    mkdir__
    readLocalFile__
    
    Keymap
    
    functions
    
    isModEvent__
    isModifier__
    
    MarkdownPreviewRenderer
    
    functions
    
    createCodeBlockPostProcessor__
    registerPostProcessor__
    unregisterCodeBlockPostProcessor
    unregisterPostProcessor__
    
    variables
    
    codeBlockPostProcessors
    
    MarkdownRenderer
    
    functions
    
    render__
    renderMarkdown__
    
    Menu
    
    functions
    
    forEvent
    
    Vault
    
    functions
    
    recurseChildren__
    
    type-aliases
    
    Constructor
    Constructor__
    EditorCommandName
    EditorCommandName__
    HexString
    HexString__
    IconName
    IconName__
    KeymapEventListener
    KeymapEventListener__
    MarkdownViewModeType
    MarkdownViewModeType__
    Modifier
    Modifier__
    ObsidianProtocolHandler
    ObsidianProtocolHandler__
    PaneType
    PaneType__
    SearchMatches
    SearchMatches__
    SearchMatchPart
    SearchMatchPart__
    Side
    Side__
    SplitDirection
    SplitDirection__
    TooltipPlacement
    TooltipPlacement__
    UserEvent
    UserEvent__
    ViewCreator
    ViewCreator__
    
    variables
    
    apiVersion
    apiVersion__
    editorEditorField
    editorEditorField__
    editorInfoField
    editorInfoField__
    editorLivePreviewField
    editorLivePreviewField__
    editorViewField
    editorViewField__
    livePreviewState
    livePreviewState__
    moment
    moment__
    Platform
    Platform__
    
    publish
    
    classes
    
    Component
    Events
    MarkdownPreviewRenderer
    MarkdownRenderChild
    Publish
    
    interfaces
    
    EventRef
    MarkdownPostProcessor
    MarkdownPostProcessorContext
    MarkdownSectionInformation

Obsidian Typings

On this page

Overview
Indexable
- Todo

Graph View

On this page

Overview
Indexable
- Todo

Backlinks

Window

Localization

Defined in: src/obsidian/internals/Localization.d.ts:6

Todo

Documentation incomplete.

Unofficial

Indexable

Section titled “Indexable”

[key: string]: string | Localization

Todo

Section titled “Todo”

Documentation incomplete.

LocalGraphViewConstructor

MapOfSets