Interface SelectionProps

Properties supported by the Selection component.

interface SelectionProps {
    map?: MapModel;
    sources: SelectionSource[];
    onSelectionComplete?(event: SelectionCompleteEvent): void;
    onSelectionSourceChanged?(event: SelectionSourceChangedEvent): void;
    [key: `data-${string}`]: unknown;
}

Hierarchy (View Summary)

CommonComponentProps
MapModelProps
- SelectionProps

Indexable

[key: `data-${string}`]: unknown
Arbitrary data attributes.

NOTE: The component may use data properties for its own behavior. Make sure not to overwrite required attributes.

Index

Properties

Methods

onSelectionComplete? onSelectionSourceChanged?

Properties

`Optional`map

The map model to use.

sources

sources: SelectionSource[]

Array of selection sources available for spatial selection.

Methods

`Optional`onSelectionComplete

onSelectionComplete?(event: SelectionCompleteEvent): void
This handler is called whenever the user has successfully selected some items.
Parameters
- event: SelectionCompleteEvent
Returns void
- Defined in src/packages/selection/Selection.tsx:40

`Optional`onSelectionSourceChanged

onSelectionSourceChanged?(event: SelectionSourceChangedEvent): void
This handler is called whenever the user has changed the selected source
Parameters
- event: SelectionSourceChangedEvent
Returns void
- Defined in src/packages/selection/Selection.tsx:45