Skip to content

BasesConfigFile

Official

Represents the serialized format of a Bases query as stored in a .base file.

Import:

import type { BasesConfigFile } from 'obsidian';

Signature:

export interface BasesConfigFile

Properties

Property Type Description
filters? BasesConfigFileFilter Configuration for filters applied to this Base.
formulas? Record<string, string> Configuration for formulas used in this Base.

Key: Formula property name. Value: Formula string.
properties? Record<string, Record<string, any>> Configuration for properties in this Base.

Valid keys for this object currently include:

- displayName: string
summaries? Record<string, string> Configuration for summary formulas used in this Base.

Key: Summary formula name. Value: Formula string.
views? BasesConfigFileView[] Configuration for views used in this Base.