obsidian/augmentations/bases

Classes

Class	Description
BasesEntry	Represent a single “row” or file in a base.
BasesEntryGroup	A group of obsidian#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.
BasesQueryResult	The obsidian#BasesQueryResult contains all of the available information from executing the bases query, applying filters, and evaluating formulas. The data or groupedData should be displayed by your view.
BasesView	View for the Bases plugin.
BasesViewConfig	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.
QueryController	Responsible for executing the Bases query and evaluating filters and formulas. Notifies views of updated results.

Interfaces

Interface	Description
BasesAllOptions__	obsidian#BasesOptions and the associated sub-types are configuration-driven settings controls which can be provided by a BasesViewRegistration to expose configuration options to users in the view config menu of the Bases toolbar.
BasesConfigFile	Represents the serialized format of a Bases query as stored in a .base file.
BasesConfigFileFilter__	A filter clause used in Bases config files, supporting AND, OR, NOT, and string conditions.
BasesConfigFileView	Configuration for a single view in a Bases config file.
BasesDropdownOption	Dropdown option.
BasesFileOption	A text input allowing selection of a file from in the vault.
BasesFolderOption	A text input allowing selection of a folder from in the vault.
BasesFormulaOption	A text input supporting formula evaluation.
BasesMultitextOption	Multitext option.
BasesOption	Bases option.
BasesOptionGroup	Collapsible container for other ViewOptions.
BasesOptions__	Bases options.
BasesProperty	Bases property.
BasesPropertyId__	The full ID of a property, used in the bases config file. The prefixed BasesPropertyType disambiguates properties of the same name but from different sources.
BasesPropertyOption	A dropdown menu allowing selection of a property.
BasesPropertyType__	The three valid “sources” of a property in a Base. - note: Properties from the frontmatter of markdown files in the vault. - formula: Properties calculated by evaluating a formula from the base config file. - file: Properties inherent to a file, such as the name, extension, size, etc.
BasesQueryResultGroup	A group of entries in a BasesQueryResult, keyed by a grouping value.
BasesSliderOption	Slider option.
BasesSortConfig__	Bases sort config.
BasesTextOption	Text option.
BasesToggleOption	Toggle option.
BasesViewFactory__	Implement this factory function in a BasesViewRegistration to create a new instance of a custom Bases view.
BasesViewRegistration	Container for options when registering a new Bases view type.
BasesViewTransaction	A single undo/redo step in a BasesView, capturing a set of property changes and the view state to restore.
BasesViewTransactionChange	A single property change captured within a BasesViewTransaction.
FormulaContext	The context in which a formula is evaluated. In most cases, BasesEntry is the specific type to use.
QueryControllerEphemeralState	The ephemeral (non-persisted) state of a QueryController, keyed by view name.