Luxar Viewer API Documentation - v2026.9.22
    Preparing search index...

    Type Alias SpatialQueryOptions

    SpatialQueryOptions: {
        totalElements: number;
        chunkSize?: number;
        extendDims?: string[];
        logModule?: string;
    } & (
        | {
            geometryType: GeometryKind;
            toleranceOptions?: ToleranceOptions;
            tolerance?: never;
        }
        | { tolerance: number[]; geometryType?: never; toleranceOptions?: never }
    )

    Constructor-options for SpatialQueryBuilder.

    Discriminated union: callers must supply EITHER geometryType (tolerance is computed via tolerance-computer.computeTolerance) OR tolerance (a pre-computed per-dimension array). Both are mutually exclusive.

    Type Declaration

    • totalElements: number

      Total elements in the dataset (for clipping the last range).

    • OptionalchunkSize?: number

      Override index.metadata.chunk_size if absent there.

    • OptionalextendDims?: string[]

      Names of extend_to_all dimensions; triggers load-all when any is hidden.

    • OptionallogModule?: string

      Log module label for diagnostic messages emitted by this query (Modules.SPATIAL_INDEX_LOADER, Modules.LINES_LOADER, Modules.GSPLATS_SPATIAL_INDEX_LOADER, …). Defaults to Modules.SPATIAL_INDEX when omitted, but callers should pass their geometry-specific module so log filtering / triage works.

    • {
          geometryType: GeometryKind;
          toleranceOptions?: ToleranceOptions;
          tolerance?: never;
      }
      • geometryType: GeometryKind

        Geometry-aware tolerance via computeTolerance(geometryType, …).

      • OptionaltoleranceOptions?: ToleranceOptions

        Optional tuning passed to computeTolerance.

      • Optionaltolerance?: never
    • { tolerance: number[]; geometryType?: never; toleranceOptions?: never }
      • tolerance: number[]

        Pre-computed per-dimension tolerance (used for points).

      • OptionalgeometryType?: never
      • OptionaltoleranceOptions?: never

    Settings
    Member Visibility