ExcaliBrain

https://github.com/zsviczian/excalibrain
Admin
ExcaliBrain is an interactive, structured mind-map visualization plugin for Obsidian that transforms...
Tokens:33,626
Snippets:468
Trust Score:8.8
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Create and Render Links

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/link.md

Practical examples of instantiating and rendering different types of relationships.

```typescript
// Create a parent-child relationship link
const parentLink = new Link(
  centralNode,
  childNode,
  Role.CHILD,
  RelationType.INFERRED,
  "leads to",
  ea,
  settings,
  plugin
);

// Render the link
parentLink.render(false);

// Create a friend relationship with label
const friendLink = new Link(
  nodeA,
  nodeB,
  Role.LEFT,
  RelationType.DEFINED,
  "similar",
  ea,
  settings,
  plugin
);
friendLink.render(false);
```

--------------------------------

### Minimal Configuration Setup

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/configuration.md

Override the default brain file path while maintaining other default settings.

```typescript
// Use defaults, only override brain file path
excalibrainFilepath: "graphs/excalibrain.md"
```

--------------------------------

### OntologySuggester Usage

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/components.md

Example of how to trigger the OntologySuggester within a note.

```markdown
# Note Title

Some content here. When I type ::p the suggester shows:
- Potential parent pages from vault

I can also type (page name) mid-sentence to suggest relationships.

Parent:: [[Suggested Parent]]
Child:: [[Suggested Child]]
Friends:: [[Suggested Friend]]
```

--------------------------------

### Define and Initialize NodeStyles

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/types.md

Map structure for managing multiple node styles and an example of its initialization.

```typescript
type NodeStyles = {
  [key: string]: NodeStyleData
}
```

```typescript
const styles: NodeStyles = {
  "base": { style: {...}, allowOverride: true, ... },
  "central": { style: {...}, allowOverride: false, ... },
  "inferred": { style: {...}, allowOverride: true, ... },
};
```

--------------------------------

### Complete link rendering workflow in TypeScript

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/links-collection.md

A full example showing the lifecycle of clearing, adding various relationship types, and rendering links.

```typescript
import { Links } from 'src/graph/Links';
import { Role, RelationType } from 'src/types';

const links = new Links(plugin);

// Clear previous links
links.clear();

// Add relationships
links.addParentLinks(centralNode, parentNodes, false);
links.addChildrenLinks(centralNode, childNodes, false);
links.addLeftFriendLinks(centralNode, leftFriends, false);
links.addRightFriendLinks(centralNode, rightFriends, false);

// Add sequences if enabled
if (plugin.settings.renderSiblings) {
  links.addSiblingLinks(centralNode, siblings, false);
}

// Add next/previous for sequences
links.addNextFriendLinks(centralNode, nextPages, false);
links.addPreviousFriendLinks(centralNode, previousPages, false);

// Render to canvas
links.render();
```

--------------------------------

### Dataview Field Value Examples

Source: https://github.com/zsviczian/excalibrain/blob/master/EXCALIBRAIN_DETAILED_SPECIFICATION.md

Examples of supported Dataview field formats for link extraction.

```text
children:: [[file1]] [[file2]]
parents:: [link1, link2]
```

```text
parent:: [[MainConcept]]
```

```text
related:: [[note1]] and [[note2]] are similar
```

```typescript
field.values() // Iterates link objects
field.path     // Single link path
```

```text
timeline:: [2024-01-15, 2024-01-16]
// Converted using daily note format settings
```

--------------------------------

### Display WarningPrompt

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/components.md

Usage example for showing a warning dialog and handling the user's boolean response via a callback.

```typescript
import { WarningPrompt } from 'src/utils/Prompts';

new WarningPrompt(
  app,
  "Confirm Action",
  "Are you sure you want to proceed?"
).show((confirmed) => {
  if (confirmed) {
    // User clicked OK/Yes
  } else {
    // User clicked Cancel/No
  }
});
```

--------------------------------

### Define Hierarchy interface and example

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/types.md

Configures how Dataview fields are mapped to specific relationship types.

```typescript
type Hierarchy = {
  hidden: string[],           // Fields for hidden relationships
  parents: string[],          // Field names for parent relationships
  children: string[],         // Field names for child relationships
  leftFriends: string[],       // Field names for left friends
  rightFriends: string[],      // Field names for right friends
  previous: string[],         // Field names for previous links
  next: string[],             // Field names for next links
  exclusions: string[],       // Fields to ignore
}
```

```typescript
const hierarchy: Hierarchy = {
  hidden: ["hidden", "excluded"],
  parents: ["Parent", "Parents", "up", "origin"],
  children: ["Child", "Children", "down"],
  leftFriends: ["Friend", "similar"],
  rightFriends: ["opposes"],
  previous: ["Previous", "Before"],
  next: ["Next", "After"],
  exclusions: ["excalidraw-plugin", "kanban-plugin"]
};
```

--------------------------------

### Configure tag node style

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/configuration.md

Example configuration for applying a red color scheme and italic style to tag nodes.

```typescript
tagNodeStyle: {
  prefix: "🏷️ ",
  textColor: "#ff0000ff",
  backgroundColor: "#ff000022"
}
```

--------------------------------

### Get All Pages

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/pages-collection.md

Retrieves an array containing all pages currently in the collection.

```typescript
const allPages = pages.getPages();
allPages.forEach(page => {
  console.log(page.path);
});
```

--------------------------------

### Verify Excalidraw Version

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/constants.md

Check if the installed Excalidraw plugin meets the minimum version requirement.

```typescript
if (!this.EA.verifyMinimumPluginVersion(MINEXCALIDRAWVERSION)) {
  throw new Error("Excalidraw plugin is too old");
}
```

--------------------------------

### Bidirectional Accumulation Example

Source: https://github.com/zsviczian/excalibrain/blob/master/EXCALIBRAIN_DETAILED_SPECIFICATION.md

Shows the result of merging opposing inferred relationships.

```text
A → B (inferred child)
A ← B (inferred parent)
Result: Bidirectional friend relationship
```

--------------------------------

### get prefix()

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/node.md

Retrieves the label prefix for the node based on its type (e.g., attachment or URL).

```APIDOC
## get prefix()

### Description
Gets the prefix for the node label.

### Returns
- **string** - The configured prefix (e.g., "📎 " for attachments, "🌐 " for URLs)
```

--------------------------------

### initialize(focusSearchAfterInitiation: boolean)

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/scene.md

Initializes the scene for rendering, including loading plugin settings and creating the tools panel UI.

```APIDOC
## async initialize(focusSearchAfterInitiation: boolean)

### Description
Initializes the scene for rendering. This method loads plugin settings, creates the tools panel UI, and calls internal initialization logic.

### Parameters
- **focusSearchAfterInitiation** (boolean) - Required - If true, focus search panel after setup.
```

--------------------------------

### Get Collection Size

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/pages-collection.md

Returns the total count of pages in the collection.

```typescript
console.log(`Total pages: ${pages.size}`);
```

--------------------------------

### Manual Layout Implementation

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/layout.md

Demonstrates initializing a layout with a specification, assigning nodes, and triggering the render process.

```typescript
import { Layout } from 'src/graph/Layout';

// Create layout specification
const spec = {
  columns: 5,
  origoX: 400,
  origoY: 300,
  top: null,
  bottom: null,
  rowHeight: 120,
  columnWidth: 150,
  maxLabelLength: 30
};

// Create and position layout
const layout = new Layout(spec);
layout.nodes = [node1, node2, node3];

// Render to canvas
await layout.render();

// Access positioned nodes
console.log(layout.renderedNodes);
// [
//   [null, node1, node2, node3, null],
// ]
```

--------------------------------

### Initialize ToolsPanel and WarningPrompt in TypeScript

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/components.md

Demonstrates creating a ToolsPanel instance and triggering a confirmation dialog using WarningPrompt.

```typescript
import { ToolsPanel } from 'src/Components/ToolsPanel';
import { WarningPrompt } from 'src/utils/Prompts';

// Create tools panel during scene initialization
this.toolsPanel = new ToolsPanel(containerElement, plugin);

// Handle user interactions
this.toolsPanel.on('filter-change', (filter) => {
  // Update graph with new filters
  await scene.reRender();
});

// Show confirmation dialog
new WarningPrompt(
  app,
  "Close Brain?",
  "Unsaved changes will be lost"
).show(async (confirmed) => {
  if (confirmed) {
    scene.terminate();
  }
});
```

--------------------------------

### constructor(spec: LayoutSpecification)

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/layout.md

Initializes a new layout calculator with the provided grid dimensions and positioning specifications.

```APIDOC
## constructor(spec: LayoutSpecification)

### Description
Creates a new layout calculator instance.

### Parameters
- **spec** (LayoutSpecification) - Required - Layout dimensions and positioning configuration.
```

--------------------------------

### log(message: any): void

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/utilities.md

Standard console.log wrapper.

```APIDOC
## log(message: any)

### Description
Standard console.log wrapper.

### Example
```typescript
log("Debug message");
```
```

--------------------------------

### Import and Use Plugin Constants

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/constants.md

Demonstrates importing plugin identifiers and version requirements for compatibility checks.

```typescript
import { PLUGIN_NAME, MINEXCALIDRAWVERSION } from 'src/constants/constants';

if(!ea.verifyMinimumPluginVersion(MINEXCALIDRAWVERSION)) {
  // Excalidraw needs upgrade
}
```

--------------------------------

### Initialize scene

Source: https://github.com/zsviczian/excalibrain/blob/master/EXCALIBRAIN_DETAILED_SPECIFICATION.md

Prepares the Excalidraw canvas by clearing elements, setting modes, and registering event handlers.

```typescript
initialize(focusSearchAfterInitiation: boolean) {
  initializeScene()  // Prepare Excalidraw canvas
  // - Clear existing elements
  // - Set view mode
  // - Disable mobile
  // - Register event handlers
  // - Show welcome message
}
```

--------------------------------

### Initialize Multi-Type Hierarchy Link

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/link.md

Demonstrates creating a link with multiple hierarchy types, where styles are applied cumulatively.

```typescript
// Hierarchy definition with multiple types separated by comma
const link = new Link(nodeA, nodeB, Role.CHILD, RelationType.DEFINED, 
  "Parent, origin, source", ea, settings, plugin);

// This link's style combines styles for all three types:
// 1. Apply base style
// 2. Apply style for "Parent"
// 3. Apply style for "origin"
// 4. Apply style for "source"
// Later styles override earlier ones
```

--------------------------------

### Get Node Prefix

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/node.md

Retrieves the label prefix based on the node's type, such as attachments or URLs.

```typescript
const label = node.prefix + node.title;
// "📎 My Document" or "🌐 example.com"
```

--------------------------------

### Initialize WarningPrompt

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/components.md

Constructor signature for creating a new warning dialog instance.

```typescript
constructor(app: App, title: string, message: string)
```

--------------------------------

### View Documentation Directory Structure

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/INDEX.md

Displays the file organization of the ExcaliBrain documentation repository.

```text
output/
├── README.md                          # Main overview and quick start
├── INDEX.md                          # This file
├── types.md                          # Type definitions
├── configuration.md                  # Settings reference
├── constants.md                      # Constants and defaults
└── api-reference/
    ├── excalibrain-plugin.md        # Main plugin class
    ├── scene.md                     # Graph visualization
    ├── page.md                      # Individual pages
    ├── pages-collection.md          # Page index
    ├── node.md                      # Visual nodes
    ├── link.md                      # Visual links
    ├── links-collection.md          # Link manager
    ├── layout.md                    # Layout algorithm
    ├── utilities.md                 # Helper functions
    └── components.md                # UI components
```

--------------------------------

### Initialize Node Instance

Source: https://github.com/zsviczian/excalibrain/blob/master/EXCALIBRAIN_DETAILED_SPECIFICATION.md

Constructs a new node with specific configuration parameters for Excalidraw integration.

```typescript
const node = new Node({
  ea: ExcalidrawAutomate,
  page: Page,
  isInferred: boolean,
  isCentral: boolean,
  isSibling: boolean,
  friendGateOnLeft: boolean
})
```

--------------------------------

### Plugin Initialization Flow

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/README.md

Sequence of operations performed during the plugin load process.

```text
Plugin load
  ↓
Load settings & defaults
  ↓
Initialize Dataview API
  ↓
Initialize Excalidraw API
  ↓
Create index (Pages collection)
  ↓
Register commands & handlers
```

--------------------------------

### Index Creation Phases

Source: https://github.com/zsviczian/excalibrain/blob/master/EXCALIBRAIN_DETAILED_SPECIFICATION.md

Outlines the sequential steps for building the graph structure, populating relationships, and enriching metadata.

```text
1. Wait for Dataview API readiness
2. Wait for URLParser completion
3. Add host origins as URL nodes
4. Add file system structure:
   - Root folder node
   - Recursively add folders with parent-child relationships (file-tree)
   - Add markdown files under respective folders
5. Add tag hierarchy:
   - Parse all tags from metadata cache
   - Create tag nodes (tag:parent/child/name)
   - Link parent-child tags
```

```text
1. addUnresolvedLinks():     Links to non-existent files
2. addResolvedLinks():        Standard wiki/markdown links (inferred)
3. addPageURLs():             HTTP links and their origins
```

```text
1. Load starred/bookmarked files as home entry points
2. Cache lowercase paths (case-sensitivity workaround)
3. Mark index as ready
```

--------------------------------

### Initialize Pages Collection

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/pages-collection.md

Constructor signature for creating a new Pages collection instance.

```typescript
constructor(plugin: ExcaliBrain)
```

--------------------------------

### Initialize ExcaliBrain Plugin Instance

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/excalibrain-plugin.md

Constructor for the main ExcaliBrain plugin class, requiring the Obsidian App instance and plugin manifest.

```typescript
constructor(app: App, manifest: PluginManifest)
```

--------------------------------

### Integrate bookmarks for entry points

Source: https://github.com/zsviczian/excalibrain/blob/master/EXCALIBRAIN_DETAILED_SPECIFICATION.md

Extracts and groups Obsidian bookmarks to provide quick-access navigation entry points.

```typescript
// During index creation:
const bookmarks = bookmarksPlugin.instance.items
const starred = groupElements(bookmarks)  // Recursive extraction

// Starred files become quick-access entry points
// Users can click to navigate to any bookmarked location
```

--------------------------------

### Initialize ToolsPanel

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/components.md

Constructor for the ToolsPanel component, requiring a parent HTMLElement and the ExcaliBrain plugin instance.

```typescript
constructor(containerEl: HTMLElement, plugin: ExcaliBrain)
```

--------------------------------

### Initialize Page instance

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/page.md

Constructor for creating a new Page node within the brain graph.

```typescript
constructor(
  pages: Pages,
  path: string,
  file: TFile,
  plugin: ExcaliBrain,
  isFolder?: boolean,
  isTag?: boolean,
  name?: string|null,
  url?: string|null
)
```

--------------------------------

### ExcaliBrain Source Directory Structure

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/README.md

Visual representation of the project's file hierarchy.

```text
src/
├── excalibrain-main.ts       # Main plugin class
├── Scene.ts                  # Graph visualization
├── Settings.ts               # Settings management
├── Types.ts                  # Type definitions
├── graph/
│   ├── Page.ts              # Page representation
│   ├── Pages.ts             # Page collection
│   ├── Node.ts              # Visual node
│   ├── Link.ts              # Visual link
│   ├── Links.ts             # Link collection
│   ├── Layout.ts            # Layout algorithm
│   ├── URLParser.ts         # URL extraction
├── Components/              # UI components
├── Suggesters/              # Autocomplete
├── utils/                   # Helper functions
├── constants/               # Constants
├── styles/                  # CSS
└── lang/                    # Localization
```

--------------------------------

### Utilities

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/INDEX.md

Helper functions for logging, async operations, file handling, and data extraction.

```APIDOC
## utils.errorlog()
Log errors.

## utils.sleep()
Perform an async delay.

## utils.svgToBase64()
Convert SVG to Base64.

## utils.keepOnTop()
Manage window layering.

## dataview.getDVFieldLinksForPage()
Extract Dataview links for a page.

## dataview.getPrimaryTag()
Get tag styling.

## fileUtils.getFilenameFromPath()
Extract filename from a path.
```

--------------------------------

### Configuring Compact Display

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/configuration.md

Adjust settings for the compact view layout and item density.

```typescript
compactView: true,
compactingFactor: 2.0,
maxItemCount: 20,
showFolderNodes: true
```

--------------------------------

### Initialize Layout Constructor

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/layout.md

Instantiate a new layout calculator using a LayoutSpecification object.

```typescript
constructor(spec: LayoutSpecification)
```

--------------------------------

### debug(message: any): void

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/utilities.md

Alias for console.log.

```APIDOC
## debug(message: any)

### Description
Alias for console.log.

### Example
```typescript
debug("Debug info");
```
```

--------------------------------

### Node Constructor

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/node.md

Creates a new Node instance for rendering a Page on the Excalidraw canvas.

```APIDOC
## constructor(x: {ea, page, isInferred, isCentral, isSibling, friendGateOnLeft, isEmbeded?, embeddedElementIds?})

### Description
Initializes a new Node instance to represent a Page.

### Parameters
- **x.ea** (ExcalidrawAutomate) - Required - Excalidraw automation API
- **x.page** (Page) - Required - Page to represent
- **x.isInferred** (boolean) - Required - True for inferred relationships
- **x.isCentral** (boolean) - Required - True if central node
- **x.isSibling** (boolean) - Required - True if sibling node
- **x.friendGateOnLeft** (boolean) - Required - Position friend gates on left side
- **x.isEmbeded** (boolean) - Optional - True if content is embedded (default: false)
- **x.embeddedElementIds** (string[]) - Optional - IDs of embedded Excalidraw elements (default: [])
```

--------------------------------

### Execute Full Render Cycle

Source: https://github.com/zsviczian/excalibrain/blob/master/EXCALIBRAIN_DETAILED_SPECIFICATION.md

Orchestrates the retrieval of neighbors, layout creation, and node rendering.

```typescript
async render(retainCentralNode = false) {
  // 1. Get central page relationships
  const {parents, children, leftFriends, rightFriends, siblings} 
    = getNeighbors(centralPage)
  
  // 2. Create layout specs for each area
  const parentLayout = new Layout(parentSpec)
  const childLayout = new Layout(childSpec)
  // ... etc
  
  // 3. Add nodes to layouts
  addNodes({neighbours: parents, layout: parentLayout, ...})
  addNodes({neighbours: children, layout: childLayout, ...})
  // ... etc
  
  // 4. Render all layouts
  await parentLayout.render()
  await childLayout.render()
  // ... etc
  
  // 5. Render links between nodes
  links.render(linksToHide)
}
```

--------------------------------

### Create a new Excalibrain scene

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/README.md

Initializes a new brain graph visualization and sets the central page for rendering.

```typescript
import { Scene } from 'src/Scene';

// Create new brain graph visualization
const scene = new Scene(plugin, true); // true = create new leaf
await scene.initialize(true);

// Set central page and render
scene.centralPagePath = "notes/my-note.md";
await scene.reRender();
```

--------------------------------

### Node Constructor

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/node.md

Initializes a new Node instance with required automation, page data, and relationship flags.

```typescript
constructor(x: {
  ea: ExcalidrawAutomate,
  page: Page,
  isInferred: boolean,
  isCentral: boolean,
  isSibling: boolean,
  friendGateOnLeft: boolean,
  isEmbeded?: boolean,
  embeddedElementIds?: string[],
})
```

--------------------------------

### keepOnTop(ea: ExcalidrawAutomate, ownerWindow?: Window)

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/utilities.md

Forces the Excalidraw window to stay on top momentarily on desktop environments.

```APIDOC
## keepOnTop(ea: ExcalidrawAutomate, ownerWindow?: Window)

### Description
Keeps Excalidraw window on top momentarily on desktop. On mobile, this function does nothing.

### Parameters
- **ea** (ExcalidrawAutomate) - Required - Excalidraw API instance
- **ownerWindow** (Window) - Optional - Optional window reference

### Behavior
- Desktop: Checks if Excalidraw is active, sets window to always-on-top, and removes after 500ms.
- Mobile: No action taken.

### Example
```typescript
import { keepOnTop } from 'src/utils/utils';

keepOnTop(this.ea);
```
```

--------------------------------

### Initialize Link Constructor

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/link.md

Defines the parameters required to instantiate a new Link between two nodes.

```typescript
constructor(
  nodeA: Node,
  nodeB: Node,
  nodeBRole: Role,
  relation: RelationType,
  hierarchyDefinition: string,
  ea: ExcalidrawAutomate,
  settings: ExcaliBrainSettings,
  plugin: ExcaliBrain
)
```

--------------------------------

### Graph Rendering Process

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/README.md

Steps involved in rendering the graph visualization to the Excalidraw canvas.

```text
Scene initialization
  ↓
Load central page
  ↓
Get neighbors from index
  ↓
Create Nodes for each page
  ↓
Create Links for relationships
  ↓
Layout positioning
  ↓
Render to Excalidraw canvas
```

--------------------------------

### Initialize NavigationHistory

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/components.md

Constructor for the NavigationHistory class, accepting an optional initial array of history strings.

```typescript
constructor(history: string[] = [])
```

--------------------------------

### render()

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/links-collection.md

Renders all previously added links in the Excalidraw canvas.

```APIDOC
## render()

### Description
Renders all links in the Excalidraw canvas. It iterates through all Link objects and calls render() on each. Links must be added before calling this method.

### Example
```typescript
links.createLink(...);
links.createLink(...);
links.render();
```
```

--------------------------------

### render(): Promise<void>

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/layout.md

Positions all nodes in the Excalidraw canvas by invoking the layout calculation and updating node positions.

```APIDOC
## render(): Promise<void>

### Description
Positions all nodes in the Excalidraw canvas. This method triggers the layout calculation and then iterates through the rendered nodes to set their center positions and invoke their individual render methods.
```

--------------------------------

### render()

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/node.md

Renders the node in the Excalidraw canvas, including text, gates, and embedded content.

```APIDOC
## render()

### Description
Renders the node in the Excalidraw canvas. This includes calculating display text, rendering the main element, creating connection gates, and applying styles.
```

--------------------------------

### Retrieve Daily Note Settings in TypeScript

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/utilities.md

Fetches the daily note plugin configuration including format, folder, and template settings.

```typescript
import { getDailyNoteSettings } from 'src/utils/datehelpers';

const settings = getDailyNoteSettings(app);
console.log(settings.format); // "YYYY-MM-DD"
```

--------------------------------

### Log messages with log

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/utilities.md

A standard wrapper for console.log.

```typescript
log("Debug message");
```

--------------------------------

### Ontology Suggester Configuration

Source: https://github.com/zsviczian/excalibrain/blob/master/EXCALIBRAIN_DETAILED_SPECIFICATION.md

Defines the triggers used by the UI to assist in field entry.

```typescript
OntologySuggester {
  trigger: string                   // Default: "::"
  midSentenceTrigger: string       // Default: "("
  
  parentTrigger: "::p"
  childTrigger: "::c"
  leftFriendTrigger: "::l"
  rightFriendTrigger: "::r"
  previousTrigger: "::e"
  nextTrigger: "::n"
}
```

--------------------------------

### getDailyNoteSettings(app: App)

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/utilities.md

Retrieves the daily note plugin configuration settings.

```APIDOC
## getDailyNoteSettings(app: App)

### Description
Retrieves daily note plugin configuration including format, folder, and template settings.

### Parameters
- **app** (App) - Required - Obsidian app instance

### Returns
- **IPeriodicNoteSettings** - Object containing format (string), folder (string), and template (string) properties.
```

--------------------------------

### layout(columns?: number): void

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/layout.md

Calculates the grid positions for nodes based on the provided specification and optional column count.

```APIDOC
## layout(columns?: number): void

### Description
Calculates node positions based on the layout specification. It sorts nodes alphabetically, calculates optimal grid dimensions, and centers the layout relative to the origo point.

### Parameters
- **columns** (number) - Optional - Number of columns in the grid. Defaults to spec.columns.
```

--------------------------------

### Apply Autocomplete Suggestion Limits

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/constants.md

Shows how to use the SUGGEST_LIMIT constant to constrain the number of autocomplete results.

```typescript
import { SUGGEST_LIMIT } from 'src/constants/constants';

const suggestions = allPages.slice(0, SUGGEST_LIMIT);
```

--------------------------------

### Create Ghost Page

Source: https://github.com/zsviczian/excalibrain/blob/master/EXCALIBRAIN_DETAILED_SPECIFICATION.md

Instantiates a virtual page and establishes relationships based on plugin settings.

```typescript
addUnresolvedPage(childPath: string, parent: Page, plugin, pages) {
  const ghostPage = pages.get(childPath) ?? 
    new Page(pages, childPath, null, plugin)
  
  // Link as inferred relationship
  if(plugin.settings.inferAllLinksAsFriends) {
    ghostPage.addLeftFriend(parent, INFERRED, TO)
    parent.addLeftFriend(ghostPage, INFERRED, FROM)
  } else {
    ghostPage.addParent(parent, INFERRED, TO)
    parent.addChild(ghostPage, INFERRED, FROM)
  }
  
  pages.add(childPath, ghostPage)
  return ghostPage
}
```

--------------------------------

### NavigationHistory Methods

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/components.md

Methods for managing navigation history state, including adding paths, retrieving the previous entry, and fetching the full history.

```typescript
push(path: string): void
```

```typescript
pop(): string
```

```typescript
getHistory(): string[]
```

--------------------------------

### Configuring Dark Theme Styles

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/configuration.md

Set custom background and text colors for the graph nodes.

```typescript
backgroundColor: "#1e1e1e",
baseNodeStyle: {
  backgroundColor: "#2d2d2d",
  textColor: "#ffffff"
}
```

--------------------------------

### Apply Default Node Styles

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/constants.md

Initialize a node style object based on the default configuration.

```typescript
const nodeStyle = { ...DEFAULT_NODE_STYLE };
nodeStyle.prefix = "📎 ";
```

--------------------------------

### Link Class Constructor

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/link.md

Initializes a new visual connection between two nodes in the graph.

```APIDOC
## Constructor

### Description
Creates a new Link instance representing a connection between two nodes.

### Signature
`new Link(nodeA, nodeB, nodeBRole, relation, hierarchyDefinition, ea, settings, plugin)`

### Parameters
- **nodeA** (Node) - Source node
- **nodeB** (Node) - Target node
- **nodeBRole** (Role) - Relationship type (PARENT, CHILD, LEFT, RIGHT)
- **relation** (RelationType) - DEFINED or INFERRED
- **hierarchyDefinition** (string) - Hierarchy field name (comma-separated for multi-type)
- **ea** (ExcalidrawAutomate) - Excalidraw automation API
- **settings** (ExcaliBrainSettings) - Plugin settings
- **plugin** (ExcaliBrain) - Plugin instance
```

--------------------------------

### Import Plugin Constants

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/constants.md

Standard import statement for accessing core plugin configuration constants.

```typescript
import {
  APPNAME,
  PLUGIN_NAME,
  MINEXCALIDRAWVERSION,
  DEFAULT_NODE_STYLE,
  DEFAULT_LINK_STYLE,
  DEFAULT_HIERARCHY_DEFINITION,
  PREDEFINED_LINK_STYLES,
  SUGGEST_LIMIT
} from 'src/constants/constants';
```

--------------------------------

### WarningPrompt

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/components.md

A utility class to display a warning dialog to the user with a title and message, accepting a callback to handle the user's boolean response.

```APIDOC
## WarningPrompt

### Description
Displays a warning dialog to the user and captures their response via a callback function.

### Constructor
`new WarningPrompt(app: App, title: string, message: string)`

#### Parameters
- **app** (App) - Required - Obsidian app instance
- **title** (string) - Required - Dialog title
- **message** (string) - Required - Dialog message

### Methods
#### show(callback: (result: boolean) => void): void
Displays the prompt and executes the provided callback with the user's choice (true for confirmed, false for cancelled).

### Example
```typescript
import { WarningPrompt } from 'src/utils/Prompts';

new WarningPrompt(
  app,
  "Confirm Action",
  "Are you sure you want to proceed?"
).show((confirmed) => {
  if (confirmed) {
    // User clicked OK/Yes
  } else {
    // User clicked Cancel/No
  }
});
```
```

--------------------------------

### Mutual Link Handling

Source: https://github.com/zsviczian/excalibrain/blob/master/EXCALIBRAIN_DETAILED_SPECIFICATION.md

Demonstrates the method calls for establishing bidirectional lateral relationships when mutual links exist.

```javascript
// Standard mode
A.addLeftFriend(B, INFERRED, BOTH)  // Bidirectional lateral
B.addLeftFriend(A, INFERRED, BOTH)
```

--------------------------------

### Initialize ToggleButton

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/components.md

Constructor definition for the ToggleButton component.

```typescript
constructor(container: HTMLElement, options: {
  label: string;
  onChange: (value: boolean) => void;
})
```

--------------------------------

### render(hide: boolean)

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/link.md

Renders the link onto the Excalidraw canvas with optional opacity settings.

```APIDOC
## render(hide: boolean)

### Description
Renders the link in the Excalidraw canvas, applying styles and connection gates based on the link's role.

### Parameters
- **hide** (boolean) - If true, renders with 10% opacity; otherwise renders with 100% opacity.

### Example
```typescript
link.render(false); // Render normally
link.render(true);  // Render faded/hidden
```
```

--------------------------------

### Retrieve Page

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/pages-collection.md

Fetches a Page object by its path, returning undefined if not found.

```typescript
const page = pages.get("note.md");
if (page) {
  console.log(page.name);
}
```

--------------------------------

### Define LinkStyles

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/types.md

Map structure for managing multiple link styles.

```typescript
type LinkStyles = {
  [key: string]: LinkStyleData
}
```

--------------------------------

### Vault Change Handling

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/README.md

Workflow for updating the index and re-rendering the scene when files are modified.

```text
File created/modified/renamed
  ↓
Update metadata cache
  ↓
Rebuild index (Pages collection)
  ↓
Scene re-renders (if active)
```

--------------------------------

### Render Links

Source: https://github.com/zsviczian/excalibrain/blob/master/EXCALIBRAIN_DETAILED_SPECIFICATION.md

Connects nodes via gates and applies styling or filtering.

```typescript
Link.render(hide: boolean) {
  // Determine source and target gates based on role
  const gateA = getRoleGate(nodeA, roleBRole)
  const gateB = getRoleGate(nodeB, roleBRole)
  
  const linkId = ea.connectObjects(gateA, null, gateB, null, {
    startArrowHead: style.startArrowHead,
    endArrowHead: style.endArrowHead
  })
  
  // Optional label
  if(style.showLabel && hierarchyDefinition) {
    ea.addLabelToLine(linkId, hierarchyDefinition)
  }
  
  // Hide if filtered
  if(hide) {
    ea.style.opacity = 10
  }
}
```

--------------------------------

### LayoutSpecification Type

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/types.md

Defines the configuration parameters for the graph layout algorithm.

```typescript
type LayoutSpecification = {
  columns: number;
  origoX: number;
  origoY: number;
  top: number;
  bottom: number;
  rowHeight: number;
  columnWidth: number;
  maxLabelLength: number;
}
```

--------------------------------

### Graph Rendering

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/INDEX.md

Methods for controlling the rendering and layout of the graph, scenes, nodes, and links.

```APIDOC
## Scene.render()
Render the full graph.

## Scene.reRender()
Update the graph after changes.

## Node.render()
Render a single node.

## Link.render()
Render a single link.

## Layout.render()
Position and render nodes.
```

--------------------------------

### Inference Settings Configuration

Source: https://github.com/zsviczian/excalibrain/blob/master/EXCALIBRAIN_DETAILED_SPECIFICATION.md

Configuration schema for controlling link inference behavior.

```typescript
settings {
  inverseInfer: boolean         // Flip parent/child interpretation
  inverseArrowDirection: boolean // Flip arrow directions in visualization
  inferAllLinksAsFriends: boolean // Treat all inferred links as lateral friends
}
```

--------------------------------

### isActive()

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/scene.md

Checks if the scene is currently active in the workspace.

```APIDOC
## isActive()

### Description
Checks if the scene is currently active in the workspace.

### Returns
- **boolean** - true if scene is active and not terminated.
```

--------------------------------

### Initialize AddToOntologyModal

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/components.md

Constructor for the modal dialog used to add pages to the brain hierarchy.

```typescript
constructor(app: App, plugin: ExcaliBrain)
```

--------------------------------

### Define Spacing Constraints

Source: https://github.com/zsviczian/excalibrain/blob/master/EXCALIBRAIN_DETAILED_SPECIFICATION.md

Configuration variables for controlling node spacing and link lengths.

```typescript
compactView: boolean       // Reduces spacing
compactingFactor: number   // Multiplier (default: 1.5)
minLinkLength: number      // Minimum link distance
```

--------------------------------

### Calculate Base Layout Dimensions

Source: https://github.com/zsviczian/excalibrain/blob/master/EXCALIBRAIN_DETAILED_SPECIFICATION.md

Sets node width and height based on measured text size and padding.

```typescript
setBaseLayoutParams() {
  const style = baseStyle + centralNodeStyle
  this.textSize = ea.measureText("m".repeat(maxLabelLength))
  this.nodeWidth = textSize.width + 2 * padding
  this.nodeHeight = 2 * (textSize.height + 2 * padding)
}
```

--------------------------------

### Render Nodes to Canvas

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/layout.md

Execute the render method to calculate positions and draw nodes onto the Excalidraw canvas.

```typescript
await layout.render();
```

--------------------------------

### Define ARGB Color Values

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/constants.md

Hexadecimal format for colors using #RRGGBBAA syntax.

```text
#ffffffff  = white, fully opaque
#ffffff00  = white, fully transparent
#000000ff  = black, fully opaque
#ff0000ff  = red, fully opaque
#0000ff88  = blue, 50% opaque
```

--------------------------------

### Calculate Grid Centering and Positioning

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/layout.md

Logic for determining total height, top constraints, and individual node coordinates within the grid.

```typescript
// 1. Calculate total height
const height = rowCount * spec.rowHeight;

// 2. Determine top position with constraints:
// - If unconstrained: origo - height/2 (center at origo)
// - If top constrained: align to top boundary if would overlap
// - If bottom constrained: align to bottom boundary if would overlap

// 3. Calculate center position:
const center00 = {
  x: origoX - (columns === 1 ? 0 : (columns-1)/2 * columnWidth),
  y: top
};

// 4. Position each node:
node.x = center00.x + colIndex * columnWidth;
node.y = center00.y + rowIndex * rowHeight;
```

--------------------------------

### Create a new link

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/links-collection.md

Instantiates a new link between two nodes with a specified role and relationship type.

```typescript
const link = links.createLink(
  centralNode,
  childNode,
  Role.CHILD,
  RelationType.DEFINED,
  "leads to"
);
```

--------------------------------

### Tag-Based Styling Logic

Source: https://github.com/zsviczian/excalibrain/blob/master/EXCALIBRAIN_DETAILED_SPECIFICATION.md

Functions to determine the primary tag and retrieve the corresponding style configuration.

```typescript
getPrimaryTag(dvPage, settings) {
  // Check primaryTagField (default: "Note type")
  const primaryTag = dvPage[settings.primaryTagFieldLowerCase]
  const styleTags = settings.tagStyleList
  
  return [
    tags.find(t => styleTags.includes(t)) || firstTag,
    otherTags
  ]
}

getTagStyle(tags, settings) {
  const [primary, others] = tags
  let style = settings.tagNodeStyles[primary]
  
  // Combine prefixes if displayAllStylePrefixes enabled
  if(settings.displayAllStylePrefixes) {
    style.prefix = [style.prefix, otherTags.prefixes].join("")
  }
  
  return style
}
```

--------------------------------

### errorlog(data: ErrorLog): void

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/utilities.md

Logs an error to the browser console with plugin context.

```APIDOC
## errorlog(data: ErrorLog)

### Description
Logs an error to the browser console with plugin context.

### Parameters
- **data** (ErrorLog) - Required - Error information object

#### ErrorLog Properties
- **fn** (Function) - Required - The function where error occurred
- **where** (string) - Required - Location string (e.g., "Scene.ts:42")
- **message** (string) - Required - Error message
- **error** (Error) - Optional - Error object for stack trace
- **data** (any) - Optional - Additional context data

### Example
```typescript
import { errorlog } from 'src/utils/utils';

try {
  processPage(page);
} catch (error) {
  errorlog({
    fn: processPage,
    where: "Scene.ts:render()",
    message: "Failed to render page",
    error: error as Error,
    data: { page: page.path }
  });
}
```
```

--------------------------------

### Define LinkStyleData

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/types.md

Runtime structure for link styles including inheritance.

```typescript
type LinkStyleData = {
  style: LinkStyle,
  allowOverride: boolean,
  userStyle: boolean,
  display: string,
  getInheritedStyle: () => LinkStyle,
}
```

--------------------------------

### Render links in TypeScript

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/links-collection.md

Renders all previously added links to the Excalidraw canvas.

```typescript
links.createLink(...);
links.createLink(...);
links.render();
```

--------------------------------

### Check Page Existence

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/pages-collection.md

Verifies if a page exists in the collection before retrieval.

```typescript
if (pages.has("note.md")) {
  const page = pages.get("note.md");
}
```

--------------------------------

### Add next friend links

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/links-collection.md

Adds sequential 'next' relationship links to the collection.

```typescript
links.addNextFriendLinks(centralNode, nextPages, false);
```

--------------------------------

### Page Relationship Addition Methods

Source: https://github.com/zsviczian/excalibrain/blob/master/EXCALIBRAIN_DETAILED_SPECIFICATION.md

Methods used to build the neighbor graph, ensuring validation and preservation of defined relationships.

```typescript
addParent(page, relationType, direction, definition)
addChild(page, relationType, direction, definition)
addLeftFriend(page, relationType, direction, definition)
addRightFriend(page, relationType, direction, definition)
addPreviousFriend(page, relationType, direction, definition)
addNextFriend(page, relationType, direction, definition)
addHidden(page)  // Excluded from display
```

--------------------------------

### Handle Multiple Relationship Types

Source: https://github.com/zsviczian/excalibrain/blob/master/EXCALIBRAIN_DETAILED_SPECIFICATION.md

Logic for merging relationship types and directions, prioritizing defined relationships and merging directions into 'BOTH' when applicable.

```typescript
relationTypeToSet(current: RelationType, new: RelationType) {
  // DEFINED always takes precedence over INFERRED
  if(current === DEFINED) return DEFINED;
  if(new === DEFINED) return DEFINED;
  return INFERRED;
}

directionToSet(current: LinkDirection, new: LinkDirection) {
  // TO/FROM merge into BOTH
  if(current === BOTH || current === new) return current;
  return BOTH;
}
```

--------------------------------

### Define LinkStyle

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/types.md

Configuration object for customizing the appearance of graph links.

```typescript
type LinkStyle = {
  strokeColor?: string,
  strokeWidth?: number,
  strokeStyle?: StrokeStyle,
  roughness?: number,
  startArrowHead?: Arrowhead,
  endArrowHead?: Arrowhead,
  showLabel?: boolean,
  fontSize?: number,
  fontFamily?: number,
  textColor?: string
}
```

--------------------------------

### ToolsPanel

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/components.md

Renders the toolbar UI in the brain graph view, providing controls for search, navigation, and display filters.

```APIDOC
## ToolsPanel

### Constructor
`constructor(containerEl: HTMLElement, plugin: ExcaliBrain)`

### Parameters
- **containerEl** (HTMLElement) - Required - Parent container for tools panel
- **plugin** (ExcaliBrain) - Required - Plugin instance
```

--------------------------------

### Re-render Scene

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/scene.md

Update the scene visualization, optionally rebuilding the page index.

```typescript
// Re-render with updated index
await scene.reRender();

// Re-render without rebuilding index
await scene.reRender(false);
```

--------------------------------

### Forward Link Interpretation Logic

Source: https://github.com/zsviczian/excalibrain/blob/master/EXCALIBRAIN_DETAILED_SPECIFICATION.md

Defines how forward links are interpreted based on the inverseInfer setting.

```text
File A links to File B → Inference based on settings.inverseInfer:
  - Normal mode (false):     A → child of B
  - Inverse mode (true):     A → parent of B
```

--------------------------------

### Add relationships programmatically

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/README.md

Establishes parent-child links between two pages using defined relationship types and directions.

```typescript
import { RelationType, LinkDirection } from 'src/types';

const parentPage = plugin.pages.get("notes/parent.md");
const childPage = plugin.pages.get("notes/child.md");

// Create relationship
childPage.addParent(
  parentPage,
  RelationType.DEFINED,
  LinkDirection.FROM,
  "Parent"
);

parentPage.addChild(
  childPage,
  RelationType.DEFINED,
  LinkDirection.TO,
  "Parent"
);
```

--------------------------------

### Retrieve Pages by Type

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/README.md

Filter the collection of all pages to exclude folders and tags.

```typescript
const pages = plugin.pages.getPages()
  .filter(p => !p.isFolder && !p.isTag);
```

--------------------------------

### Check Scene Activity

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/scene.md

Verify if the scene is active before performing operations like re-rendering.

```typescript
if (scene.isActive()) {
  await scene.reRender();
}
```

--------------------------------

### Register scene event handlers

Source: https://github.com/zsviczian/excalibrain/blob/master/EXCALIBRAIN_DETAILED_SPECIFICATION.md

Hooks into Obsidian workspace, metadata, and vault events to trigger scene updates.

```typescript
registerEvent(
  app.workspace.on('active-leaf-change', handleLeafChange)
)

registerEvent(
  app.metadataCache.on('changed', handleFileChange)
)

registerEvent(
  app.vault.on('create', handleFileCreate)
)

// Dataview index change detection
// Settings change detection
// Plugin enable/disable
```

--------------------------------

### Render Link to Canvas

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/link.md

Controls the visibility and rendering state of a link on the Excalidraw canvas.

```typescript
link.render(false); // Render normally
link.render(true);  // Render faded/hidden
```

--------------------------------

### Configure auto-opening central document

Source: https://github.com/zsviczian/excalibrain/blob/master/EXCALIBRAIN_DETAILED_SPECIFICATION.md

Settings toggle to control whether opening a graph from search automatically reveals the central document pane.

```typescript
settings.autoOpenCentralDocument: boolean

// When enabled:
// - Opening graph from search creates/reveals central document pane
// - Maintains cognitive focus on current concept
// - Can be toggled per-render
```

--------------------------------

### Path Case Sensitivity Mapping

Source: https://github.com/zsviczian/excalibrain/blob/master/EXCALIBRAIN_DETAILED_SPECIFICATION.md

Defines the data structure used to resolve Obsidian path case inconsistencies.

```typescript
lowercasePathMap: Map<string, string>
// Maps lowercase path → proper-case path
// Used when resolving links with case mismatches
```

--------------------------------

### NavigationHistory

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/components.md

Manages the navigation history state, allowing for pushing, popping, and retrieving history entries.

```APIDOC
## NavigationHistory

### Constructor
`constructor(history: string[] = [])`

### Methods

#### push(path: string): void
Adds a page to the history.
- **path** (string) - Required - File path to add

#### pop(): string
Gets the previous page in history.
- **Returns** (string) - Previous page path

#### getHistory(): string[]
Gets all history entries.
- **Returns** (string[]) - Full navigation history
```

--------------------------------

### Register a child relationship

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/page.md

Adds a child page to the current page's hierarchy.

```typescript
parentPage.addChild(childPage, RelationType.INFERRED, LinkDirection.TO);
```

--------------------------------

### File Event Registration

Source: https://github.com/zsviczian/excalibrain/blob/master/EXCALIBRAIN_DETAILED_SPECIFICATION.md

Registers vault event listeners to maintain the URL index when files are created, modified, or deleted.

```typescript
registerFileEvents() {
  vault.on('create', modifyEventHandler)  // Parse new files
  vault.on('modify', modifyEventHandler)  // Re-parse changed files
  vault.on('delete', deleteEventHandler)  // Remove old URLs
}
```

--------------------------------

### Register a parent relationship

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/api-reference/page.md

Adds a parent page to the current page's hierarchy.

```typescript
childPage.addParent(parentPage, RelationType.DEFINED, LinkDirection.FROM, "Parent");
```

--------------------------------

### Relationship Management

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/INDEX.md

Methods for managing hierarchical and sequential relationships between pages.

```APIDOC
## Page.addParent()
Add a parent relationship to a page.

## Page.addChild()
Add a child relationship to a page.

## Page.addLeftFriend()
Add a friend relationship to a page.

## Page.addRightFriend()
Add an opposing relationship to a page.

## Page.addPreviousFriend()
Add a prior link to a page.

## Page.addNextFriend()
Add a next link to a page.
```

--------------------------------

### Define LinkStyle properties

Source: https://github.com/zsviczian/excalibrain/blob/master/_autodocs/configuration.md

Defines the structure for link styling, including stroke, arrow, and label properties.

```typescript
type LinkStyle = {
  strokeColor?: string,       // Hex ARGB
  strokeWidth?: number,       // Pixels
  strokeStyle?: StrokeStyle,  // "solid", "dashed", "dotted"
  roughness?: number,         // 0-3
  startArrowHead?: Arrowhead, // Arrow type or "none"
  endArrowHead?: Arrowhead,   // Arrow type or "none"
  showLabel?: boolean,        // Display field name
  fontSize?: number,          // Label size
  fontFamily?: number,        // Font ID
  textColor?: string          // Hex ARGB
}
```
Tokens:
Raw