Skip to content
This is the alpha v4 version website. Looking for the v3 documentation?

BucketCollection

Defined in: packages/sigma/src/rendering/bucket.ts:184

BucketCollection manages buckets indexed by zIndex. This provides O(1) bucket lookup and efficient iteration by depth order.

Constructors

Constructor

new BucketCollection(maxDepthLevels, stride?): BucketCollection

Defined in: packages/sigma/src/rendering/bucket.ts:194

Parameters

maxDepthLevels

number

stride?

number = 1

Returns

BucketCollection

Methods

addItem()

addItem(zIndex, key): void

Defined in: packages/sigma/src/rendering/bucket.ts:250

Adds an item to the appropriate bucket

Parameters

zIndex

number

key

string

Returns

void


clearAll()

clearAll(): void

Defined in: packages/sigma/src/rendering/bucket.ts:288

Clears all buckets

Returns

void


forEachBucketByZIndex()

forEachBucketByZIndex(callback): void

Defined in: packages/sigma/src/rendering/bucket.ts:298

Iterates over all buckets in zIndex order (back-to-front). Calls the callback for each non-empty bucket.

Parameters

callback

(zIndex, bucket) => void

Returns

void


getBucket()

getBucket(zIndex): Bucket | null

Defined in: packages/sigma/src/rendering/bucket.ts:242

Gets the bucket for a specific zIndex

Parameters

zIndex

number

Returns

Bucket | null


getMaxDepthLevels()

getMaxDepthLevels(): number

Defined in: packages/sigma/src/rendering/bucket.ts:206

Gets the current maximum depth levels

Returns

number


hasDirtyBuckets()

hasDirtyBuckets(): boolean

Defined in: packages/sigma/src/rendering/bucket.ts:321

Checks if any bucket is dirty

Returns

boolean


moveItem()

moveItem(oldZIndex, newZIndex, key): void

Defined in: packages/sigma/src/rendering/bucket.ts:270

Moves an item between buckets (zIndex change).

Parameters

oldZIndex

number

newZIndex

number

key

string

Returns

void


rebuildDirtyBuckets()

rebuildDirtyBuckets(processItem): void

Defined in: packages/sigma/src/rendering/bucket.ts:310

Rebuilds all dirty buckets

Parameters

processItem

ProcessItemFunction

Returns

void


removeItem()

removeItem(zIndex, key): void

Defined in: packages/sigma/src/rendering/bucket.ts:260

Removes an item from a bucket

Parameters

zIndex

number

key

string

Returns

void


setMaxDepthLevels()

setMaxDepthLevels(maxDepthLevels): void

Defined in: packages/sigma/src/rendering/bucket.ts:214

Updates the maximum depth levels and resizes the bucket array. Items in buckets beyond the new max will be moved to the highest bucket.

Parameters

maxDepthLevels

number

Returns

void


updateItem()

updateItem(zIndex, key): void

Defined in: packages/sigma/src/rendering/bucket.ts:278

Updates an item’s attributes (marks the containing bucket as dirty)

Parameters

zIndex

number

key

string

Returns

void