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

    Interface RelatedQuery

    Canonical related-records request. The relationshipId is protocol-specific (GeoServices uses numeric ids; OData uses navigation property names) so adapters that lack relationships throw HonuaCapabilityNotSupportedError rather than silently dropping the request.

    interface RelatedQuery {
        outFields?: readonly string[];
        relationshipId: number;
        returnGeometry?: boolean;
        signal?: AbortSignal;
        sourceIds: readonly FeatureId[];
        where?: string;
    }
    Index

    Properties

    outFields? relationshipId returnGeometry? signal? sourceIds where?

    Properties

    outFields?: readonly string[]
    relationshipId: number
    returnGeometry?: boolean
    signal?: AbortSignal
    sourceIds: readonly FeatureId[]

    Source feature ids whose related records to return.

    where?: string

    Source-native related-record filter text retained for compatibility.

    Use the typed protocol adapter escape hatch until semantic related-record filtering is available.

    Settings

    Member Visibility

    On This Page

    Properties