ViewState

Official

Both Official Unofficial

Both Own Inherited

The state of the view.

Import:

import type { ViewState } from 'obsidian';

Signature:

export interface ViewState

Properties

	Property	Type	Description
	active?	boolean	Whether the view is active.
	group?	WorkspaceLeaf	The leaf group of the view.
	pinned?	boolean	Whether the view is pinned.
	state?	Record<string, unknown>	The state of the view.
	type	string	The type of the view.

---

Links to this page:

• LeafEntry
• StateHistory
• TypedWorkspaceLeaf
• WorkspaceLeaf