Class DataviewApi

The API that the obsidian-dataview plugin exposes to plugin authors. Extended to improve type information.

Hierarchy

DataviewApi
- DataviewApi

Index

Constructors

Methods

Constructors

constructor

new DataviewApi(
    app: App,
    index: FullIndex,
    settings: DataviewSettings,
    verNum: string,
): DataviewApi
Parameters
- app: App
- index: FullIndex
- settings: DataviewSettings
- verNum: string
Returns DataviewApi
Inherited from ActualDataviewApi.constructor
- Defined in node_modules/obsidian-dataview/lib/api/plugin-api.d.ts:45

Methods

pages

pages(query: string): DataArray<SMarkdownPage>
Return an array of page objects corresponding to pages which match the source query.
Parameters
- query: string
Returns DataArray<SMarkdownPage>
Overrides ActualDataviewApi.pages
- Defined in src/lib/obsidian-dataview/types.ts:11