<!-- Do not edit this file. It is automatically generated by API Documenter. --> ## obsidian package ## Classes | Class | Description | | --- | --- | | [`AbstractTextComponent`](AbstractTextComponent) | 0.9.21 | | [`App`](App) | 0.9.7 | | [`BasesEntry`](BasesEntry) | <p>Represent a single "row" or file in a base.</p><p> 1.10.0</p> | | [`BasesEntryGroup`](BasesEntryGroup) | <p>A group of BasesEntry objects for a given value of the groupBy key. If there are entries in the results which do not have a value for the groupBy key, the key will be the [NullValue](NullValue)<!-- -->.</p><p> 1.10.0</p> | | [`BasesQueryResult`](BasesQueryResult) | <p>The BasesQueryResult contains all of the available information from executing the bases query, applying filters, and evaluating formulas. The <code>data</code> or <code>groupedData</code> should be displayed by your view.</p><p> 1.10.0</p> | | [`BasesViewConfig`](BasesViewConfig) | <p>The in-memory representation of a single entry in the "views" section of a Bases file. Contains settings and configuration options set by the user from the toolbar menus and view options.</p><p> 1.10.0</p> | | [`BooleanValue`](BooleanValue) | <p>[Value](Value) wrapping a boolean.</p><p> 1.10.0</p> | | [`ButtonComponent`](ButtonComponent) | 0.9.7 | | [`CapacitorAdapter`](CapacitorAdapter) | <p>Implementation of the vault adapter for mobile devices.</p><p> 1.7.2</p> | | [`ColorComponent`](ColorComponent) | <p>Color picker component. Values are by default 6-digit hash-prefixed hex strings like <code>#000000</code>.</p><p> 1.0.0</p> | | [`Component`](Component) | 0.9.7 | | [`DateValue`](DateValue) | <p>[Value](Value) wrapping a Date.</p><p> 1.10.0</p> | | [`DropdownComponent`](DropdownComponent) | 0.9.7 | | [`DurationValue`](DurationValue) | <p>[Value](Value) wrapping a duration. Durations can be used to modify a [DateValue](DateValue) or can result from subtracting a DateValue from another.</p><p> 1.10.0</p> | | [`Events`](Events) | 0.9.7 | | [`ExtraButtonComponent`](ExtraButtonComponent) | 0.9.7 | | [`FileManager`](FileManager) | <p>Manage the creation, deletion and renaming of files from the UI.</p><p> 0.9.7</p> | | [`FileSystemAdapter`](FileSystemAdapter) | Implementation of the vault adapter for desktop. | | [`FileValue`](FileValue) | <p>[Value](Value) wrapping a file in Obsidian.</p><p> 1.10.0</p> | | [`HoverPopover`](HoverPopover) | 0.15.0 | | [`HTMLValue`](HTMLValue) | <p>[Value](Value) wrapping raw HTML.</p><p> 1.10.0</p> | | [`IconValue`](IconValue) | <p>[Value](Value) wrapping a renderable icon.</p><p> 1.10.0</p> | | [`ImageValue`](ImageValue) | <p>[Value](Value) wrapping a path to an image resource in the vault.</p><p> 1.10.0</p> | | [`Keymap`](Keymap) | <p>Manages keymap lifecycle for different [Scope](Scope)<!-- -->s.</p><p> 0.13.9</p> | | [`LinkValue`](LinkValue) | <p>[Value](Value) wrapping an internal wikilink.</p><p> 1.10.0</p> | | [`ListValue`](ListValue) | <p>[Value](Value) wrapping an array of Values. Values do not all need to be of the same type.</p><p> 1.10.0</p> | | [`MarkdownEditView`](MarkdownEditView) | This is the editor for Obsidian Mobile as well as the WYSIWYG editor. | | [`MarkdownPreviewRenderer`](MarkdownPreviewRenderer) | 0.9.7 | | [`MarkdownPreviewView`](MarkdownPreviewView) | | | [`MarkdownRenderChild`](MarkdownRenderChild) | | | [`MarkdownView`](MarkdownView) | | | [`Menu`](Menu) | | | [`MenuItem`](MenuItem) | | | [`MenuSeparator`](MenuSeparator) | 0.15.3 | | [`MetadataCache`](MetadataCache) | Linktext is any internal link that is composed of a path and a subpath, such as 'My note\#Heading' Linkpath (or path) is the path part of a linktext Subpath is the heading/block ID part of a linktext. | | [`Modal`](Modal) | | | [`MomentFormatComponent`](MomentFormatComponent) | 0.9.7 | | [`Notice`](Notice) | <p>Notification component. Use to present timely, high-value information.</p><p> 0.9.7</p> | | [`NullValue`](NullValue) | <p>[Value](Value) which represents null. NullValue is a singleton and <code>NullValue.value</code> should be used instead of calling the constructor.</p><p> 1.10.0</p> | | [`NumberValue`](NumberValue) | <p>[Value](Value) wrapping a number.</p><p> 1.10.0</p> | | [`ObjectValue`](ObjectValue) | <p>[Value](Value) wrapping an object.</p><p> 1.10.0</p> | | [`ProgressBarComponent`](ProgressBarComponent) | 1.4.4 | | [`QueryController`](QueryController) | <p>Responsible for executing the Bases query and evaluating filters and formulas. Notifies views of updated results.</p><p> 1.10.0</p> | | [`RegExpValue`](RegExpValue) | <p>[Value](Value) wrapping a RegExp pattern.</p><p> 1.10.0</p> | | [`RelativeDateValue`](RelativeDateValue) | <p>[Value](Value) wrapping a Date. RelativeDateValue behaves the same as a [DateValue](DateValue) however it renders as a time relative to now.</p><p> 1.10.0</p> | | [`RenderContext`](RenderContext) | <p>Utility functions for rendering Values within the app.</p><p> 1.10.0</p> | | [`Scope`](Scope) | A scope receives keyboard events and binds callbacks to given hotkeys. Only one scope is active at a time, but scopes may define parent scopes (in the constructor) and inherit their hotkeys. | | [`SearchComponent`](SearchComponent) | 0.9.21 | | [`Setting`](Setting) | 0.9.7 | | [`SliderComponent`](SliderComponent) | 0.9.7 | | [`StringValue`](StringValue) | <p>[Value](Value) wrapping a string.</p><p> 1.10.0</p> | | [`TagValue`](TagValue) | <p>[Value](Value) wrapping an Obsidian tag.</p><p> 1.10.0</p> | | [`Tasks`](Tasks) | 0.10.2 | | [`TextAreaComponent`](TextAreaComponent) | 0.9.7 | | [`TextComponent`](TextComponent) | 0.9.21 | | [`TFile`](TFile) | 0.9.7 | | [`TFolder`](TFolder) | 0.9.7 | | [`ToggleComponent`](ToggleComponent) | 0.9.7 | | [`UrlValue`](UrlValue) | <p>[Value](Value) wrapping an external link.</p><p> 1.10.0</p> | | [`Vault`](Vault) | Work with files and folders stored inside a vault. | | [`Workspace`](Workspace) | 0.9.7 | | [`WorkspaceFloating`](WorkspaceFloating) | 0.15.2 | | [`WorkspaceLeaf`](WorkspaceLeaf) | | | [`WorkspaceMobileDrawer`](WorkspaceMobileDrawer) | 1.6.6 | | [`WorkspaceRibbon`](WorkspaceRibbon) | | | [`WorkspaceRoot`](WorkspaceRoot) | 0.15.2 | | [`WorkspaceSidedock`](WorkspaceSidedock) | 0.15.4 | | [`WorkspaceSplit`](WorkspaceSplit) | 0.9.7 | | [`WorkspaceTabs`](WorkspaceTabs) | | | [`WorkspaceWindow`](WorkspaceWindow) | 0.15.4 | ## Abstract Classes | Abstract Class | Description | | --- | --- | | [`AbstractInputSuggest`](AbstractInputSuggest) | <p>Attach to an <code>&lt;input&gt;</code> element or a <code>&lt;div contentEditable&gt;</code> to add type-ahead support.</p><p> 1.4.10</p> | | [`BaseComponent`](BaseComponent) | 0.10.3 | | [`BasesView`](BasesView) | <p>Plugins can create a class which extends this in order to render a Base. Plugins should create a function, then call <code>plugin.registerView</code> to register the view factory.</p><p> 1.10.0</p> | | [`EditableFileView`](EditableFileView) | 0.9.7 | | [`Editor`](Editor) | <p>A common interface that bridges the gap between CodeMirror 5 and CodeMirror 6.</p><p> 0.11.11</p> | | [`EditorSuggest`](EditorSuggest) | 0.12.17 | | [`FileView`](FileView) | | | [`FuzzySuggestModal`](FuzzySuggestModal) | 0.9.20 | | [`ItemView`](ItemView) | 0.9.7 | | [`MarkdownRenderer`](MarkdownRenderer) | 0.9.7 | | [`NotNullValue`](NotNullValue) | <p>Base type for all non-null .</p><p> 1.10.0</p> | | [`Plugin`](Plugin) | 0.9.7 | | [`PluginSettingTab`](PluginSettingTab) | Provides a unified interface for users to configure the plugin. | | [`PopoverSuggest`](PopoverSuggest) | Base class for adding a type-ahead popover. | | [`PrimitiveValue`](PrimitiveValue) | <p>Base type for which wrap a single primitive.</p><p> 1.10.0</p> | | [`SettingTab`](SettingTab) | | | [`SuggestModal`](SuggestModal) | 0.9.20 | | [`TAbstractFile`](TAbstractFile) | <p>This can be either a <code>TFile</code> or a <code>TFolder</code>.</p><p> 0.9.7</p> | | [`TextFileView`](TextFileView) | <p>This class implements a plaintext-based editable file view, which can be loaded and saved given an editor.</p><p>Note that by default, this view only saves when it's closing. To implement auto-save, your editor should call <code>this.requestSave()</code> when the content is changed.</p><p> 0.10.12</p> | | [`Value`](Value) | <p>Container type for data which can expose functions for retrieving, comparing, and rendering the data. Most commonly used in conjunction with formulas for Bases. Values can be used as formula parameters, intermediate values, and the result of evaluation.</p><p> 1.10.0</p> | | [`ValueComponent`](ValueComponent) | 0.9.7 | | [`View`](View) | 0.9.7 | | [`WorkspaceContainer`](WorkspaceContainer) | 0.15.4 | | [`WorkspaceItem`](WorkspaceItem) | 0.10.2 | | [`WorkspaceParent`](WorkspaceParent) | 0.9.7 | ## Enumerations | Enumeration | Description | | --- | --- | | [`PopoverState`](PopoverState) | | ## Functions | Function | Description | | --- | --- | | [`addIcon(iconId, svgContent)`](addIcon) | Adds an icon to the library. | | [`arrayBufferToBase64(buffer)`](arrayBufferToBase64) | | | [`arrayBufferToHex(data)`](arrayBufferToHex) | | | [`base64ToArrayBuffer(base64)`](base64ToArrayBuffer) | | | [`debounce(cb, timeout, resetTimer)`](debounce) | A standard debounce function. Use this to have a time-delayed function only be called once in a given timeframe. | | [`displayTooltip(newTargetEl, content, options)`](displayTooltip) | <p>Manually trigger a tooltip that will appear over the provided element.</p><p>To display a tooltip on hover, use [setTooltip()](setTooltip) instead.</p><p> 1.8.7</p> | | [`finishRenderMath()`](finishRenderMath) | Flush the MathJax stylesheet. | | [`getAllTags(cache)`](getAllTags) | Combines all tags from frontmatter and note content into a single array. | | [`getBlobArrayBuffer(blob)`](getBlobArrayBuffer) | | | [`getFrontMatterInfo(content)`](getFrontMatterInfo) | <p>Given the contents of a file, get information about the frontmatter of the file, including whether there is a frontmatter block, the offsets of where it starts and ends, and the frontmatter text.</p><p> 1.5.7</p> | | [`getIcon(iconId)`](getIcon) | Create an SVG from an iconId. Returns null if no icon associated with the iconId. | | [`getIconIds()`](getIconIds) | Get the list of registered icons. | | [`getLanguage()`](getLanguage) | <p>Get the ISO code for the currently configured app language. Defaults to 'en'. See [https://github.com/obsidianmd/obsidian-translations?tab=readme-ov-file\#existing-languages](https://github.com/obsidianmd/obsidian-translations?tab=readme-ov-file#existing-languages) for list of options.</p><p> 1.8.7</p> | | [`getLinkpath(linktext)`](getLinkpath) | Converts the linktext to a linkpath. | | [`hexToArrayBuffer(hex)`](hexToArrayBuffer) | | | [`htmlToMarkdown(html)`](htmlToMarkdown) | Converts HTML to a Markdown string. | | [`iterateCacheRefs(cache, cb)`](iterateCacheRefs) | Iterate links and embeds. If callback returns true, the iteration process will be interrupted. | | [`iterateRefs(refs, cb)`](iterateRefs) | If callback returns true, the iteration process will be interrupted. | | [`loadMathJax()`](loadMathJax) | Load MathJax. | | [`loadMermaid()`](loadMermaid) | Load Mermaid and return a promise to the global mermaid object. Can also use <code>mermaid</code> after this promise resolves to get the same reference. | | [`loadPdfJs()`](loadPdfJs) | Load PDF.js and return a promise to the global pdfjsLib object. Can also use <code>window.pdfjsLib</code> after this promise resolves to get the same reference. | | [`loadPrism()`](loadPrism) | Load Prism.js and return a promise to the global Prism object. Can also use <code>Prism</code> after this promise resolves to get the same reference. | | [`normalizePath(path)`](normalizePath) | | | [`parseFrontMatterAliases(frontmatter)`](parseFrontMatterAliases) | | | [`parseFrontMatterEntry(frontmatter, key)`](parseFrontMatterEntry) | | | [`parseFrontMatterStringArray(frontmatter, key)`](parseFrontMatterStringArray) | | | [`parseFrontMatterTags(frontmatter)`](parseFrontMatterTags) | | | [`parseLinktext(linktext)`](parseLinktext) | Parses the linktext of a wikilink into its component parts. | | [`parsePropertyId(propertyId)`](parsePropertyId) | <p>Split a Bases property ID into constituent parts.</p><p> 1.10.0</p> | | [`parseYaml(yaml)`](parseYaml) | | | [`prepareFuzzySearch(query)`](prepareFuzzySearch) | Construct a fuzzy search callback that runs on a target string. Performance may be an issue if you are running the search for more than a few thousand times. If performance is a problem, consider using <code>prepareSimpleSearch</code> instead. | | [`prepareSimpleSearch(query)`](prepareSimpleSearch) | Construct a simple search callback that runs on a target string. | | [`removeIcon(iconId)`](removeIcon) | Remove a custom icon from the library. | | [`renderMatches(el, text, matches, offset)`](renderMatches) | | | [`renderMath(source, display)`](renderMath) | Render some LaTeX math using the MathJax engine. Returns an HTMLElement. Requires calling <code>finishRenderMath</code> when rendering is all done to flush the MathJax stylesheet. | | [`renderResults(el, text, result, offset)`](renderResults) | | | [`request(request)`](request) | <p>Similar to <code>fetch()</code>, request a URL using HTTP/HTTPS, without any CORS restrictions. Returns the text value of the response.</p><p> 0.12.11</p> | | [`requestUrl(request)`](requestUrl) | Similar to <code>fetch()</code>, request a URL using HTTP/HTTPS, without any CORS restrictions. | | [`requireApiVersion(version)`](requireApiVersion) | Returns true if the API version is equal or higher than the requested version. Use this to limit functionality that require specific API versions to avoid crashing on older Obsidian builds. | | [`resolveSubpath(cache, subpath)`](resolveSubpath) | Resolve the given subpath to a reference in the MetadataCache. | | [`sanitizeHTMLToDom(html)`](sanitizeHTMLToDom) | | | [`setIcon(parent, iconId)`](setIcon) | Insert an SVG into the element from an iconId. Does nothing if no icon associated with the iconId. | | [`setTooltip(el, tooltip, options)`](setTooltip) | | | [`sortSearchResults(results)`](sortSearchResults) | | | [`stringifyYaml(obj)`](stringifyYaml) | | | [`stripHeading(heading)`](stripHeading) | Normalizes headings for link matching by stripping out special characters and shrinking consecutive spaces. | | [`stripHeadingForLink(heading)`](stripHeadingForLink) | Prepares headings for linking by stripping out some bad combinations of special characters that could break links. | ## Interfaces | Interface | Description | | --- | --- | | [`BaseOption`](BaseOption) | 1.10.0 | | [`BasesConfigFile`](BasesConfigFile) | <p>Represents the serialized format of a Bases query as stored in a <code>.base</code> file.</p><p> 1.10.0</p> | | [`BasesConfigFileView`](BasesConfigFileView) | 1.10.0 | | [`BasesProperty`](BasesProperty) | <p>A parsed version of the [BasesPropertyId](BasesPropertyId)<!-- -->.</p><p> 1.10.0</p> | | [`BasesViewRegistration`](BasesViewRegistration) | <p>Container for options when registering a new Bases view type.</p><p> 1.10.0</p> | | [`BlockCache`](BlockCache) | 0.11.13 | | [`BlockSubpathResult`](BlockSubpathResult) | 0.13.26 | | [`CachedMetadata`](CachedMetadata) | | | [`CacheItem`](CacheItem) | | | [`CloseableComponent`](CloseableComponent) | A closeable component that can get dismissed via the Android 'back' button. | | [`Command`](Command) | | | [`DataAdapter`](DataAdapter) | Work directly with files and folders inside a vault. If possible prefer using the [Vault](Vault) API over this. | | [`DataWriteOptions`](DataWriteOptions) | | | [`Debouncer`](Debouncer) | | | [`DropdownOption`](DropdownOption) | 1.10.0 | | [`EditorChange`](EditorChange) | 0.12.11 | | [`EditorPosition`](EditorPosition) | 0.12.11 | | [`EditorRange`](EditorRange) | 0.12.11 | | [`EditorRangeOrCaret`](EditorRangeOrCaret) | 0.12.11 | | [`EditorScrollInfo`](EditorScrollInfo) | 0.15.0 | | [`EditorSelection`](EditorSelection) | 0.12.11 | | [`EditorSelectionOrCaret`](EditorSelectionOrCaret) | 0.12.11 | | [`EditorSuggestContext`](EditorSuggestContext) | 0.12.17 | | [`EditorSuggestTriggerInfo`](EditorSuggestTriggerInfo) | 0.12.17 | | [`EditorTransaction`](EditorTransaction) | | | [`EmbedCache`](EmbedCache) | 0.9.7 | | [`EventRef`](EventRef) | | | [`FileOption`](FileOption) | <p>A text input allowing selection of a file from in the vault.</p><p> 1.10.2</p> | | [`FileStats`](FileStats) | | | [`FolderOption`](FolderOption) | <p>A text input allowing selection of a folder from in the vault.</p><p> 1.10.2</p> | | [`FootnoteCache`](FootnoteCache) | | | [`FootnoteRefCache`](FootnoteRefCache) | | | [`FootnoteSubpathResult`](FootnoteSubpathResult) | 1.7.2 | | [`FormulaContext`](FormulaContext) | <p>The context in which a formula is evaluated. In most cases, [BasesEntry](BasesEntry) is the specific type to use.</p><p> 1.10.0</p> | | [`FormulaOption`](FormulaOption) | <p>A text input supporting formula evaluation.</p><p> 1.10.2</p> | | [`FrontMatterCache`](FrontMatterCache) | | | [`FrontMatterInfo`](FrontMatterInfo) | | | [`FrontmatterLinkCache`](FrontmatterLinkCache) | | | [`FuzzyMatch`](FuzzyMatch) | 0.9.20 | | [`GroupOption`](GroupOption) | <p>Collapsible container for other ViewOptions.</p><p> 1.10.0</p> | | [`HeadingCache`](HeadingCache) | | | [`HeadingSubpathResult`](HeadingSubpathResult) | 0.9.16 | | [`Hotkey`](Hotkey) | | | [`HoverLinkSource`](HoverLinkSource) | | | [`HoverParent`](HoverParent) | 0.11.13 | | [`HSL`](HSL) | 0.16.0 | | [`Instruction`](Instruction) | 0.9.20 | | [`ISuggestOwner`](ISuggestOwner) | | | [`KeymapContext`](KeymapContext) | | | [`KeymapEventHandler`](KeymapEventHandler) | | | [`KeymapInfo`](KeymapInfo) | 0.10.4 | | [`LinkCache`](LinkCache) | 0.9.7 | | [`ListedFiles`](ListedFiles) | | | [`ListItemCache`](ListItemCache) | | | [`LivePreviewStateType`](LivePreviewStateType) | The object stored in the view plugin [livePreviewState](livePreviewState) | | [`Loc`](Loc) | Location within a Markdown document | | [`MarkdownFileInfo`](MarkdownFileInfo) | | | [`MarkdownPostProcessor`](MarkdownPostProcessor) | <p>A post processor receives an element which is a section of the preview.</p><p>Post processors can mutate the DOM to render various things, such as mermaid graphs, latex equations, or custom controls.</p><p>If your post processor requires lifecycle management, for example, to clear an interval, kill a subprocess, etc when this element is removed from the app, look into [MarkdownPostProcessorContext.addChild()](MarkdownPostProcessorContext/addChild)</p><p> 0.10.12</p> | | [`MarkdownPostProcessorContext`](MarkdownPostProcessorContext) | | | [`MarkdownPreviewEvents`](MarkdownPreviewEvents) | \* | | [`MarkdownSectionInformation`](MarkdownSectionInformation) | | | [`MarkdownSubView`](MarkdownSubView) | | | [`MenuPositionDef`](MenuPositionDef) | 1.1.0 | | [`MultitextOption`](MultitextOption) | 1.10.0 | | [`ObsidianProtocolData`](ObsidianProtocolData) | | | [`OpenViewState`](OpenViewState) | | | [`PluginManifest`](PluginManifest) | Metadata about a Community plugin. | | [`Point`](Point) | | | [`Pos`](Pos) | Describes a text range in a Markdown document. | | [`PropertyOption`](PropertyOption) | <p>A dropdown menu allowing selection of a property.</p><p> 1.10.0</p> | | [`Reference`](Reference) | Base interface for items that point to a different location. | | [`ReferenceCache`](ReferenceCache) | | | [`ReferenceLinkCache`](ReferenceLinkCache) | 1.8.7 | | [`RequestUrlParam`](RequestUrlParam) | | | [`RequestUrlResponse`](RequestUrlResponse) | | | [`RequestUrlResponsePromise`](RequestUrlResponsePromise) | | | [`RGB`](RGB) | 0.16.0 | | [`SearchResult`](SearchResult) | 0.9.21 | | [`SearchResultContainer`](SearchResultContainer) | 0.9.21 | | [`SectionCache`](SectionCache) | | | [`SliderOption`](SliderOption) | 1.10.0 | | [`Stat`](Stat) | | | [`SubpathResult`](SubpathResult) | | | [`TagCache`](TagCache) | 0.9.7 | | [`TextOption`](TextOption) | 1.10.0 | | [`ToggleOption`](ToggleOption) | 1.10.0 | | [`TooltipOptions`](TooltipOptions) | | | [`ViewState`](ViewState) | | | [`ViewStateResult`](ViewStateResult) | | | [`WorkspaceWindowInitData`](WorkspaceWindowInitData) | | ## Variables | Variable | Description | | --- | --- | | [`apiVersion`](apiVersion) | This is the API version of the app, which follows the release cycle of the desktop app. Example: '0.13.21' | | [`editorEditorField`](editorEditorField) | Use this StateField to get a reference to the EditorView | | [`editorInfoField`](editorInfoField) | Use this StateField to get information about this Markdown editor, such as the associated file, or the Editor. | | [`editorLivePreviewField`](editorLivePreviewField) | Use this StateField to check whether Live Preview is active | | [`editorViewField`](editorViewField) | This is now deprecated - it is now mapped directly to <code>editorInfoField</code>, which return a MarkdownFileInfo, which may be a MarkdownView but not necessarily. | | [`livePreviewState`](livePreviewState) | | | [`moment`](moment) | | | [`Platform`](Platform) | 0.12.2 | ## Type Aliases | Type Alias | Description | | --- | --- | | [`BasesConfigFileFilter`](BasesConfigFileFilter) | 1.10.0 | | [`BasesPropertyId`](BasesPropertyId) | <p>The full ID of a property, used in the bases config file. The prefixed [BasesPropertyType](BasesPropertyType) disambiguates properties of the same name but from different sources.</p><p> 1.10.0</p> | | [`BasesPropertyType`](BasesPropertyType) | <p>The three valid "sources" of a property in a Base.</p><p>- <code>note</code>: Properties from the frontmatter of markdown files in the vault. - <code>formula</code>: Properties calculated by evaluating a formula from the base config file. - <code>file</code>: Properties inherent to a file, such as the name, extension, size, etc.</p><p> 1.10.0</p> | | [`BasesSortConfig`](BasesSortConfig) | 1.10.0 | | [`BasesViewFactory`](BasesViewFactory) | Implement this factory function in a [BasesViewRegistration](BasesViewRegistration) to create a new instance of a custom Bases view. | | [`Constructor`](Constructor) | | | [`EditorCommandName`](EditorCommandName) | | | [`HexString`](HexString) | Hex strings are 6-digit hash-prefixed rgb strings in lowercase form. Example: \#ffffff | | [`IconName`](IconName) | | | [`KeymapEventListener`](KeymapEventListener) | Return <code>false</code> to automatically preventDefault | | [`MarkdownViewModeType`](MarkdownViewModeType) | | | [`Modifier`](Modifier) | Mod = Cmd on MacOS and Ctrl on other OS Ctrl = Ctrl key for every OS Meta = Cmd on MacOS and Win key on other OS | | [`ObsidianProtocolHandler`](ObsidianProtocolHandler) | | | [`PaneType`](PaneType) | | | [`SearchMatches`](SearchMatches) | | | [`SearchMatchPart`](SearchMatchPart) | Text position offsets within text file. Represents a text range \[from offset, to offset\]. | | [`Side`](Side) | | | [`SplitDirection`](SplitDirection) | | | [`TooltipPlacement`](TooltipPlacement) | | | [`UserEvent`](UserEvent) | | | [`ViewCreator`](ViewCreator) | | | [`ViewOption`](ViewOption) | <p>ViewOption and the associated sub-types are configuration-driven settings controls which can be provided by a [BasesViewRegistration](BasesViewRegistration) to expose configuration options to users in the view config menu of the Bases toolbar.</p><p> 1.10.0</p> |