DepthBucketCollection
Defined in: packages/sigma/src/rendering/bucket.ts:18
A collection of depth buckets, one per declared depth layer. Each key belongs
to exactly one bucket; the collection tracks that placement itself
(keyDepth), so set and remove never need a caller-supplied depth and
cannot desync from the data caches. Buckets are pre-created for the declared
layers, so set rejects any depth outside that domain at no extra cost.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DepthBucketCollection(
depthLayers):DepthBucketCollection
Defined in: packages/sigma/src/rendering/bucket.ts:22
Parameters
Section titled “Parameters”depthLayers
Section titled “depthLayers”readonly string[]
Returns
Section titled “Returns”DepthBucketCollection
Methods
Section titled “Methods”clearAll()
Section titled “clearAll()”clearAll():
void
Defined in: packages/sigma/src/rendering/bucket.ts:58
Returns
Section titled “Returns”void
getBucket()
Section titled “getBucket()”getBucket(
depth):ReadonlySet<string> |undefined
Defined in: packages/sigma/src/rendering/bucket.ts:32
Returns the keys at a declared depth layer, or undefined for an undeclared one.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”ReadonlySet<string> | undefined
getSorted()
Section titled “getSorted()”getSorted(
depth,zIndexOf):string[]
Defined in: packages/sigma/src/rendering/bucket.ts:67
Returns the keys at depth sorted ascending by zIndexOf. The result is a
fresh array; an unknown or empty depth yields [].
Parameters
Section titled “Parameters”string
zIndexOf
Section titled “zIndexOf”(key) => number
Returns
Section titled “Returns”string[]
has(
key):boolean
Defined in: packages/sigma/src/rendering/bucket.ts:27
Returns true if the key currently belongs to a bucket.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
remove()
Section titled “remove()”remove(
key):void
Defined in: packages/sigma/src/rendering/bucket.ts:51
Removes key from whichever bucket holds it. No-op for an unknown key.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
set(
key,depth):void
Defined in: packages/sigma/src/rendering/bucket.ts:40
Places key at depth, removing it from any previous bucket. Throws when
depth is not a declared depth layer — no bucket was pre-created for it.
Parameters
Section titled “Parameters”string
string
Returns
Section titled “Returns”void