dataview
This module provides utility functions for working with Dataview in Obsidian.
Interfaces
Section titled “Interfaces”| Interface | Description |
|---|---|
| DataviewInlineApi | Extended interface for the Dataview Inline API, providing additional methods for custom page types and array handling. |
| InsertCodeBlockParams | Parameters for insertCodeBlock. |
| RenderIframeParams | Options for renderIframe. |
| RenderPaginatedListParams | Options for renderPaginatedList. |
| RenderPaginatedParams | Options for renderPaginated. |
| RenderPaginatedTableParams | Options for renderPaginatedTable. |
Functions
Section titled “Functions”| Function | Description |
|---|---|
| getRenderedContainer | Renders the content using the provided renderer function in a temporary container, and then returns the container. |
| insertCodeBlock | Inserts a code block into the specified Dataview instance using the provided language and code. |
| reloadCurrentFileCache | Reloads the current file cache using the Dataview API. |
| renderIframe | Renders an iframe in the Dataview container with the specified relative path, width, and height. |
| renderPaginatedList | Renders a paginated list using the provided DataviewInlineApi instance. |
| renderPaginatedTable | Renders a paginated table using the provided DataviewInlineApi instance. |
| Type | Description |
|---|---|
| ArrayOrDataArray | Array or DataArray type. |
| CombinedPage | A combined page type, which includes the front matter and the SMarkdownPage. |
| DomElementInfoWithContainer | DomElementInfo with an optional container. |
| PageFile | A combined file type, which includes the front matter and the SMarkdownFile. |
| PageFiles | List of page files. |