Interface VectorLayerSelectionSource

interface VectorLayerSelectionSource {
    label: string;
    status: SelectionSourceStatus;
    select(
        selectionKind: ExtentSelection,
        options: SelectionOptions,
    ): Promise<SelectionResult[]>;
}

Hierarchy

Required<SelectionSource>
Resource
- VectorLayerSelectionSource

Index

Properties

Methods

Properties

`Readonly`label

label: string

The label of this source.

This will be displayed by the user interface during selection source selection.

`Readonly`status

status: SelectionSourceStatus

The optional status of this source. If there is no status defined, it is assumed that the source is always available.

This will be displayed by the user interface.

This value can be reactive; changes will be reflected in the UI.

Methods

select

select(
selectionKind: ExtentSelection,
options: SelectionOptions,
): Promise<SelectionResult[]>
Performs a selection and returns a list of selection results.

Implementations should return the results ordered by priority (best match first), if possible.
Parameters
- selectionKind: ExtentSelection
  The geometry with which to perform the spatial selection. Currently only an extent is supported.
- options: SelectionOptions
  see interface documentation SelectionOptions
Returns Promise<SelectionResult[]>
Inherited from Required.select
- Defined in selection/api.ts:124