@honua/sdk-js
    Preparing search index...

    Interface ColumnarResult<T>Experimental

    A protocol-neutral Result produced from a bounded columnar window.

    It is a Result: every consumer that accepts an object-path result accepts this unchanged. The two extra members exist because the shared envelope has nowhere to put them — crs so a consumer is never left assuming EPSG:4326, and columnar so the bounded view carries the batch's ordering and freshness with it.

    interface ColumnarResult<T = Record<string, unknown>> {
        aggregateRows?: readonly Record<string, unknown>[];
        columnar: ColumnarResultProvenance;
        crs?: GeoArrowCrs;
        degraded?: readonly DegradedReason[];
        exceededTransferLimit: boolean;
        extent?: HonuaExtent;
        features: readonly HonuaTypedFeature<T>[];
        fields?: readonly HonuaFieldInfo[];
        totalCount?: number;
    }

    Type Parameters

    • T = Record<string, unknown>

    Hierarchy (View Summary)

    Index

    Properties

    aggregateRows? columnar crs? degraded? exceededTransferLimit extent? features fields? totalCount?

    Properties

    aggregateRows?: readonly Record<string, unknown>[]

    Aggregated rows when the query carried an aggregation spec.

    columnar: ColumnarResultProvenance

    Provenance of the bounded window this Result was cut from.

    crs?: GeoArrowCrs

    CRS the batch declared for its geometry column: a serialized CRS string or a PROJJSON object. Undefined when the batch declared none, in which case the coordinates carry no CRS claim at all and a consumer must not invent one.

    degraded?: readonly DegradedReason[]

    Degradation flags emitted by the source while serving this query.

    exceededTransferLimit: boolean

    True if the server signalled that more records exist than were returned.

    extent?: HonuaExtent

    Spatial extent of the returned features (extent-only query response).

    features: readonly HonuaTypedFeature<T>[]

    Returned features. Empty array (not undefined) when nothing matched.

    fields?: readonly HonuaFieldInfo[]

    Field schema as returned by the protocol, when the response carried one.

    totalCount?: number

    Total count when known (counts request, OGC numberMatched).

    Settings

    Member Visibility

    On This Page

    Properties