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;
}

Properties

outFields? relationshipId returnGeometry? signal? sourceIds where?

Properties

OptionaloutFields

outFields?: readonly string[]

relationshipId

relationshipId: number

OptionalreturnGeometry

returnGeometry?: boolean

Optionalsignal

signal?: AbortSignal

sourceIds

sourceIds: readonly FeatureId[]

Source feature ids whose related records to return.

Optionalwhere

where?: string

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

Deprecated

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

Settings

Member Visibility

On This Page

Properties