Skip to content

EdgeIndexBase

Unofficial

Base interface for the spatial edge index, extending the R-tree with custom insert/remove behavior.

Import:

import type { EdgeIndexBase } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface EdgeIndexBase extends EdgeIndexBaseBase

Extends: EdgeIndexBaseBase

Methods

MethodReturnsDescription
_adjustParentBBoxes(arg1, arg2, arg3)unknownAdjust parent bounding boxes after an insertion or modification.
(Inherited from EdgeIndexBaseBase)
_all(arg1, arg2)unknownTraverse all items in the tree, calling the callback for each.
(Inherited from EdgeIndexBaseBase)
_allDistMargin(arg1, arg2, arg3, arg4)unknownCalculate the distribution margin for all possible splits along an axis.
(Inherited from EdgeIndexBaseBase)
_build(arg1, arg2, arg3, arg4)unknownBuild the R-tree from a set of items.
(Inherited from EdgeIndexBaseBase)
_chooseSplitAxis(arg1, arg2, arg3)unknownChoose the best axis for splitting an overflowing node.
(Inherited from EdgeIndexBaseBase)
_chooseSplitIndex(arg1, arg2, arg3)unknownChoose the best split index along the chosen axis.
(Inherited from EdgeIndexBaseBase)
_chooseSubtree(arg1, arg2, arg3, arg4)unknownChoose the best subtree for inserting a new item.
(Inherited from EdgeIndexBaseBase)
_condense(arg1)unknownCondense the tree by removing empty branches after a deletion.
(Inherited from EdgeIndexBaseBase)
_insert(arg1, arg2, arg3)unknownInternal insert method that places an item at the specified tree level.
(Inherited from EdgeIndexBaseBase)
_split(arg1, arg2)unknownSplit an overflowing tree node into two nodes.
(Inherited from EdgeIndexBaseBase)
_splitRoot(arg1, arg2)unknownSplit the root node when it overflows.
(Inherited from EdgeIndexBaseBase)
all()unknownReturn all items stored in the index.
(Inherited from EdgeIndexBaseBase)
clear()unknownRemove all items from the index.
(Inherited from EdgeIndexBaseBase)
collides(arg1)unknownCheck whether any items in the index collide with the given bounding box.
(Inherited from EdgeIndexBaseBase)
compareMinX(arg1, arg2)unknownCompare two items by their minimum X coordinate for sorting.
(Inherited from EdgeIndexBaseBase)
compareMinY(arg1, arg2)unknownCompare two items by their minimum Y coordinate for sorting.
(Inherited from EdgeIndexBaseBase)
fromJSON(arg1)unknownLoad the index state from a JSON representation.
(Inherited from EdgeIndexBaseBase)
insert(arg1)unknownInsert an item into the spatial index.
load(arg1)unknownBulk-load a set of items into the index.
(Inherited from EdgeIndexBaseBase)
remove(arg1)unknownRemove an item from the spatial index.
remove(arg1, arg2)unknownRemove an item from the index, optionally using a custom equality function.
(Inherited from EdgeIndexBaseBase)
search(arg1)unknownSearch for all items that intersect the given bounding box.
(Inherited from EdgeIndexBaseBase)
toBBox(arg1)unknownConvert an item to its bounding box representation.
toJSON()unknownSerialize the index state to a JSON representation.
(Inherited from EdgeIndexBaseBase)

Links to this page: