Interface SelectionProps

Properties supported by the Selection component.

interface SelectionProps {
    map?: MapModel;
    mapId?: string;
    sources: SelectionSource[];
    onSelectionComplete(event: SelectionCompleteEvent): void;
    onSelectionSourceChanged(event: SelectionSourceChangedEvent): void;
}

Hierarchy (View Summary)

CommonComponentProps
MapModelProps
- SelectionProps

Index

Properties

map? mapId? sources

Methods

onSelectionComplete? onSelectionSourceChanged?

Properties

`Optional`map

The map model to use.

`Optional`mapId

mapId?: string

The id of the map. The map will be looked up in the MapRegistry service.

Deprecated

Use the map property instead.

See

DefaultMapProvider

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 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 selection/Selection.tsx:45