Skip to content

DataviewInlineApi

Extended interface for the Dataview Inline API, providing additional methods for custom page types and array handling.

Import:

import type { DataviewInlineApi } from '@mnaoumov/obsidian-lib/dataview';

Signature:

export interface DataviewInlineApi extends DataviewInlineApiOriginal

Extends: DataviewInlineApiOriginal

Properties

PropertyTypeDescription
array<T>(array: T[]) => DataArray<T>Wraps an array of items into a DataArray object.
current<CustomFrontmatter = unknown>() => CombinedPage<CustomFrontmatter>Retrieves the current page, with an optional custom page type.
pages<CustomFrontmatter = unknown>(query?: string) => DataArray<CombinedPage<CustomFrontmatter>>Retrieves pages based on an optional query, with an optional custom page type.
paragraph(
text: unknown,
options?: DomElementInfoWithContainer
) => HTMLParagraphElement
Creates a paragraph HTML element with the provided text and optional DOM element options.

Links to this page: