For AI agents: a documentation index is available at /llms.txt. Markdown versions of all pages are available by appending .md to any URL.
Class GridIndex<T>
Type Parameters
- T extends GridKey
Properties
bboxes
bboxes: number[]
boxCells
boxCells: number[][]
boxKeys
boxUid
boxUid: number
circleCells
circleCells: number[][]
circleKeys
circles
circles: number[]
circleUid
circleUid: number
height
height: number
width
width: number
xCellCount
xCellCount: number
xScale
xScale: number
yCellCount
yCellCount: number
yScale
yScale: number
Methods
hitTest
-
hitTest(
x1: number,
y1: number,
x2: number,
y2: number,
overlapMode: OverlapMode,
predicate?: (key: T) => boolean,
): booleanParameters
- x1: number
- y1: number
- x2: number
- y2: number
- overlapMode: OverlapMode
Optionalpredicate: (key: T) => boolean
Returns boolean
hitTestCircle
-
hitTestCircle(
x: number,
y: number,
radius: number,
overlapMode: OverlapMode,
predicate?: (key: T) => boolean,
): booleanParameters
- x: number
- y: number
- radius: number
- overlapMode: OverlapMode
Optionalpredicate: (key: T) => boolean
Returns boolean
insert
-
Parameters
- key: T
- x1: number
- y1: number
- x2: number
- y2: number
Returns void
insertCircle
-
Parameters
- key: T
- x: number
- y: number
- radius: number
Returns void
keysLength
-
Returns number
query
-
Parameters
- x1: number
- y1: number
- x2: number
- y2: number
Returns QueryResult<T>[]