Interface ResultGroup

A result group within a search.

interface ResultGroup {
    label: string;
    priority: number;
    result: Promise<ResultSet>;
    state: SearchStatus;
}

Index

Properties

label priority result state

Properties

`Readonly`label

label: string

Group label for display purposes (e.g. layer name).

`Readonly`priority

priority: number

Priority of this result group in relation to other groups. A lower value indicates a higher priority.

`Readonly`result

result: Promise<ResultSet>

Search results for this group. When the search is cancelled, this promise will reject with an AbortError (see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal).

`Readonly`state

state: SearchStatus

Current state of this result group.