StatsGrid.RegionSelectedEvent
Used to notify that a region has been selected in statsgrid. Components handling regions can update "highlighted" regions or the latest selection.
Parameters
(* means the parameter is required)
| Name | Type | Description | Default value |
|---|---|---|---|
| \* regionset | Number | id for the selected regionset | |
| \* region | Number | id for the selected region in the regionset | |
| currentSelection | Number[] | for multiple selection this can be used to communicate the whole set of currently selected regions | array with region-param value as the only item |
| triggeredBy | String | component id what triggered event | component id (map/grid) or null |
Event methods
getName()
Returns event name
getRegionset()
Returns id for the regionset where the region can be found.
getRegion()
Returns id for the region that was selected.
getSelection()
Returns an array of selected region ids. Defaults to having an array of one region that is the same as returned by getRegion().