VirtualizationManager

Defined in: spatial/VirtualizationManager.ts:10

Manages viewport culling and spatial indexing for a diagram. Only parts intersecting the visible viewport are considered “in view”.

Constructors

Constructor

new VirtualizationManager(bounds, options?): VirtualizationManager

Defined in: spatial/VirtualizationManager.ts:15

Parameters

bounds

Rect

options?

maxDepth?

number

maxItems?

number

Returns

VirtualizationManager

Accessors

culledCount

Get Signature

get culledCount(): number

Defined in: spatial/VirtualizationManager.ts:30

Get the number of parts currently culled (hidden).

Returns

number

---

isEnabled

Get Signature

get isEnabled(): boolean

Defined in: spatial/VirtualizationManager.ts:20

Whether virtualization is enabled.

Returns

boolean

Set Signature

set isEnabled(value): void

Defined in: spatial/VirtualizationManager.ts:25

Set whether virtualization is enabled.

Parameters

value

boolean

Returns

void

---

itemCount

Get Signature

get itemCount(): number

Defined in: spatial/VirtualizationManager.ts:35

Get the total number of indexed parts.

Returns

number

Methods

clear()

clear(): void

Defined in: spatial/VirtualizationManager.ts:101

Clear the spatial index.

Returns

void

---

cull()

cull(viewport, allParts?): Part[]

Defined in: spatial/VirtualizationManager.ts:72

Cull parts based on the current viewport. When enabled, returns only parts within the viewport. When disabled, returns all provided parts (no culling).

Parameters

viewport

Rect

allParts?

Part[]

Returns

Part[]

---

getIndex()

getIndex(): QuadTree<Part>

Defined in: spatial/VirtualizationManager.ts:40

Get the underlying spatial index.

Returns

QuadTree<Part>

---

insert()

insert(part): void

Defined in: spatial/VirtualizationManager.ts:45

Insert a part into the spatial index.

Parameters

part

Part

Returns

void

---

insertAt()

insertAt(x, y, part): void

Defined in: spatial/VirtualizationManager.ts:50

Insert a part at explicit coordinates.

Parameters

x

number

y

number

part

Part

Returns

void

---

queryCircle()

queryCircle(cx, cy, radius): Part[]

Defined in: spatial/VirtualizationManager.ts:91

Query parts within a circle.

Parameters

cx

number

cy

number

radius

number

Returns

Part[]

---

queryNearest()

queryNearest(x, y, maxDistance): Part | null

Defined in: spatial/VirtualizationManager.ts:96

Query the nearest part to a point within a maximum distance.

Parameters

x

number

y

number

maxDistance

number

Returns

Part | null

---

queryRegion()

queryRegion(bounds): Part[]

Defined in: spatial/VirtualizationManager.ts:86

Query parts intersecting a region.

Parameters

bounds

Rect

Returns

Part[]

---

rebuild()

rebuild(parts, bounds): void

Defined in: spatial/VirtualizationManager.ts:60

Rebuild the spatial index from a list of parts.

Parameters

parts

Iterable<Part>

bounds

Rect

Returns

void

---

remove()

remove(part): boolean

Defined in: spatial/VirtualizationManager.ts:55

Remove a part from the spatial index.

Parameters

part

Part

Returns

boolean

---

createViewport()

static createViewport(x, y, width, height, padding?): Rect

Defined in: spatial/VirtualizationManager.ts:107

Create a viewport rect from diagram coordinates.

Parameters

x

number

y

number

width

number

height

number

padding?

number = 0

Returns

Rect