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

    Interface CreateGeoArrowAggregateOperationOptionsExperimental

    Options for the bounded GeoArrow aggregation worker operation.

    interface CreateGeoArrowAggregateOperationOptions {
        group: GeoArrowAggregateGroupSpec;
        groupField?: string;
        id: string;
        limits?: GeoArrowConversionLimits;
        maxGroups?: number;
        metrics: readonly GeoArrowAggregateMetricSpec[];
        nullKeys?: GeoArrowAggregateNullKeyPolicy;
        schemaId: string;
        yieldIntervalRows?: number;
    }
    Index

    Properties

    group groupField? id limits? maxGroups? metrics nullKeys? schemaId yieldIntervalRows?

    Properties

    group: GeoArrowAggregateGroupSpec
    groupField?: string

    Output group field name. Grid grouping emits <name>_x and <name>_y.

    id: string

    Stable id assigned to the aggregated output batch.

    limits?: GeoArrowConversionLimits

    Conversion ceilings applied to the input inspection and the output batch.

    maxGroups?: number

    Ceiling on distinct groups. Defaults to DEFAULT_GEOARROW_AGGREGATE_MAX_GROUPS.

    metrics: readonly GeoArrowAggregateMetricSpec[]
    nullKeys?: GeoArrowAggregateNullKeyPolicy

    Null-key policy. Defaults to "null-group".

    schemaId: string

    Schema id for the aggregated field set. It is also written as the result identity.schemaVersion, so it must change whenever the group or metric specification changes.

    yieldIntervalRows?: number

    Rows scanned between cooperative event-loop yields.

    Settings

    Member Visibility

    On This Page

    Properties