Skip to content

GraphOptions

Unofficial

Base interface for a collapsible graph options section in the settings panel.

Import:

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

Signature:

export interface GraphOptions extends TreeCollapsibleItem

Extends: TreeCollapsibleItem

Properties

Property Type Description
childrenEl HTMLElement Container element for the child items of this collapsible node.
(Inherited from TreeCollapsibleItem)
collapsed boolean Current collapsed state of tree item.
(Inherited from TreeCollapsibleItem)
collapseEl HTMLElement | null Element for the collapse/expand toggle indicator, or null if not rendered.
(Inherited from TreeCollapsibleItem)
collapsible boolean Whether tree item is able to be collapsed or not.
(Inherited from TreeCollapsibleItem)

Methods

Method Returns Description
getOptions(e) unknown Get the current values of this options section.
onCollapseClick(event) void Execute collapse functionality on mouse click.
(Inherited from TreeCollapsibleItem)
setCollapsed(value, animate?) Promise<undefined> Set collapsed state of tree item.
(Inherited from TreeCollapsibleItem)
setCollapsible(value) void Set collapsible state of tree item.
(Inherited from TreeCollapsibleItem)
setOptions(e) unknown Apply new values to this options section.
toggleCollapsed(animate?) Promise<undefined> Toggle collapsed state of tree item.
(Inherited from TreeCollapsibleItem)
updateCollapsed(animate?) Promise<undefined> Update the tree item's cover element.
(Inherited from TreeCollapsibleItem)

Links to this page: