GraphView

Unofficial

Obsidian view for a global graph.

Import:

import type { GraphView } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface GraphView extends ItemView

Extends: ItemView

Constructor

new GraphView(leaf: WorkspaceLeaf)

Constructor.

To extract the constructor type, use ExtractConstructor<ItemView>.

Properties

Property	Type	Description
actionsEl	HTMLElement	Container of actions for the view. (Inherited from ItemView)
app	App	The Obsidian app instance. (Inherited from ItemView)
backButtonEl	HTMLButtonElement	Back button element for changing view history. (Inherited from ItemView)
canDropAnywhere	boolean	Whether the view may be dropped anywhere in workspace. (Inherited from ItemView)
closeable	boolean	Whether the leaf may close the view. (Inherited from ItemView)
containerEl	HTMLElement	The container HTML element for the component. (Inherited from ItemView)
contentEl	HTMLElement	The parent element of the content. (Inherited from ItemView)
dataEngine	GraphEngine	Graph engine powering the global graph simulation.
forwardButtonEl	HTMLButtonElement	Forward button element for changing view history. (Inherited from ItemView)
headerEl	HTMLElement	Header bar container of view. (Inherited from ItemView)
icon	IconName	The icon of the view. (Inherited from ItemView)
iconEl	HTMLElement	Icon element for the view (for dragging). (Inherited from ItemView)
leaf	WorkspaceLeaf	The leaf of the view. (Inherited from ItemView)
leftSidebarToggleEl	HTMLElement \| null	Toggle button for the left sidebar, shown on mobile. `null` on desktop. (Inherited from ItemView)
moreOptionsButtonEl	HTMLAnchorElement	Anchor button for revealing more view actions. (Inherited from ItemView)
navigation	boolean	Whether or not the view is intended for navigation. If your view is a static view that is not intended to be navigated away, set this to `false`. (For example: File explorer, calendar, etc.) If your view opens a file or can be otherwise navigated, set this to `true`. (For example: Markdown editor view, Kanban view, PDF view, etc.) (Inherited from ItemView)
renderer	GraphRenderer	Renderer responsible for drawing the global graph.
scope	null \| Scope	Assign an optional scope to your view to register hotkeys for when the view is in focus. (Inherited from ItemView)
titleContainerEl	HTMLElement	Container for the title of the view. (Inherited from ItemView)
titleEl	HTMLElement	Title element for the view. (Inherited from ItemView)
titleParentEl	HTMLElement	Title of the parent. (Inherited from ItemView)

Methods

Method	Returns	Description
addAction(icon, title, callback)	HTMLElement	Add an action to the item view. (Inherited from ItemView)
close()	Promise<void>	Closes the view. (Inherited from ItemView)
getDisplayText()	string	Get the display text of the view. (Inherited from ItemView)
getEphemeralState()	Record<string, unknown>	Get the ephemeral state of the view. (Inherited from ItemView)
getIcon()	IconName	Get the icon of the view. (Inherited from ItemView)
getSideTooltipPlacement()	'left' \| 'right' \| undefined	Returns the placement of the tooltip. (Inherited from ItemView)
getState()	Record<string, unknown>	Get the state of the view. (Inherited from ItemView)
getViewType()	typeof ViewType.Graph	Get the current view type.
handleCopy(event)	void	Handle copy event on metadata editor and serialize properties. (Inherited from ItemView)
handleCut(event)	void	Handle cut event on metadata editor and serialize and remove properties. (Inherited from ItemView)
handleDrop(event, draggable, isOver)	DropResult \| null	Handle a drop event on this view. (Inherited from ItemView)
handlePaste(event)	void	Handle paste event of properties on metadata editor. (Inherited from ItemView)
onClose()	Promise<void>	Called when the view is closed. (Inherited from ItemView)
onGroupChange()	void	Handle a linked group change event. (Inherited from ItemView)
onHeaderMenu(e)	void	Called when the header context menu is triggered. (Inherited from ItemView)
onMoreOptions(event)	void	Handle the 'more options' button click event. (Inherited from ItemView)
onMoreOptionsMenu(e)	void	Handle the 'more options' context menu event. (Inherited from ItemView)
onOpen()	Promise<void>	Called when the view is opened. (Inherited from ItemView)
onOptionsChange()	void	Updates the options from the plugin when changed in view.
onPaneMenu(menu, source)	void	Populates the pane menu. (Replaces the previously removed `onHeaderMenu` and `onMoreOptionsMenu`) (Inherited from ItemView)
onResize()	void	Called when the size of this view is changed. (Inherited from ItemView)
onTabMenu(menu)	void	Adds the menu items to the menu. (Inherited from ItemView)
open(parentEl)	Promise<void>	Opens the view. (Inherited from ItemView)
setEphemeralState(state)	void	Set the ephemeral state of the view. (Inherited from ItemView)
setState(state, result)	Promise<void>	Set the state of the view. (Inherited from ItemView)
update()	void	Renders the graph.
updateNavButtons()	void	Update the state of the back/forward navigation buttons. (Inherited from ItemView)

Links to this page: