Class default

constructor

• new default(
      numItems: number,
      nodeSize?: number,
      ArrayType?: TypedArrayConstructor,
      ArrayBufferType?: ArrayBufferConstructor | SharedArrayBufferConstructor,
      data?: ArrayBufferLike,
  ): default

  Creates an index that will hold a given number of items.

  Parameters

  • numItems: number
  • OptionalnodeSize: number

    Size of the KD-tree node (64 by default).

  • OptionalArrayType: TypedArrayConstructor

    The array type used for coordinates storage (Float64Array by default).

  • OptionalArrayBufferType: ArrayBufferConstructor | SharedArrayBufferConstructor

    The array buffer type used for storage (ArrayBuffer by default).

  • Optionaldata: ArrayBufferLike

    (For internal use only)

  Returns default

ArrayType

coords

data

ids

IndexArrayType

nodeSize

numItems

add

• add(x: number, y: number): number

  Add a point to the index.

  Parameters

  • x: number
  • y: number

  Returns number

  An incremental index associated with the added item (starting from 0).

finish

• finish(): this

  Perform indexing of the added points.

  Returns this

range

• range(minX: number, minY: number, maxX: number, maxY: number): number[]

  Search the index for items within a given bounding box.

  Parameters

  • minX: number
  • minY: number
  • maxX: number
  • maxY: number

  Returns number[]

  An array of indices correponding to the found items.

within

• within(qx: number, qy: number, r: number): number[]

  Search the index for items within a given radius.

  Parameters

  • qx: number
  • qy: number
  • r: number

    Query radius.

  Returns number[]

  An array of indices correponding to the found items.

withinInto

• withinInto(
      qx: number,
      qy: number,
      r: number,
      out: number[] | TypedArray,
  ): number

  Search the index for items within a given radius, writing matching ids into out via indexed assignment (out[i] = id). Accepts any indexed-writable container — a typed array sized to the expected upper bound (allocation-free, fast) or a plain Array (which will grow as needed). Returns the number of matches written.

  Parameters

  • qx: number
  • qy: number
  • r: number

    Query radius.

  • out: number[] | TypedArray

    Container to write matching ids into.

  Returns number

  The number of matches written to out.

Staticfrom

• from(data: ArrayBufferLike): default

  Creates an index from raw ArrayBuffer data.

  Parameters

  • data: ArrayBufferLike

  Returns default