Interface SelectionHandlerOptions

Options for createSelectionHandler.

interface SelectionHandlerOptions {
    layer: string;
    multiSelect?: boolean;
    onChange?: ((selectedIds: ReadonlySet<string | number>) => void);
    onSelectionTargetsChange?: ((selectedTargets: readonly SourceQualifiedFeatureSelectionTarget[]) => void);
    source: string;
    sourceLayer?: string;
    stateKey?: string;
}

Hierarchy (view full)

Properties

layer multiSelect? onChange? onSelectionTargetsChange? source sourceLayer? stateKey?

Properties

layer

layer: string

Layer ID to listen for click events on.

OptionalmultiSelect

multiSelect?: boolean

Allow multiple features to be selected simultaneously.

Default

false

OptionalonChange

onChange?: ((selectedIds: ReadonlySet<string | number>) => void)

Called whenever the selection changes.

OptionalonSelectionTargetsChange

onSelectionTargetsChange?: ((selectedTargets: readonly SourceQualifiedFeatureSelectionTarget[]) => void)

Called whenever the source-qualified selection changes.

source

source: string

Source ID to set feature state on.

OptionalsourceLayer

sourceLayer?: string

Source layer (required for vector-tile sources).

OptionalstateKey

stateKey?: string

Feature-state key to toggle.

Default

"selected"

Settings

Member Visibility

On This Page

Properties