Configure dashboard events
Events can trigger the widgets on a dashboard to update. For example, when you change the Region at the top of the dashboard, this event can cause a map widget to be updated to show that region; or if you click a city on a map widget, this event can cause a datagrid widget to be updated to show information for that city. This is configured within the widgets themselves. For the examples above, you would configure a map widget to respond to a DASHBOARD.REGION_CHANGE_EVENT, or you would configure a map widget to trigger a MAP_ENTITY_CLICK event and configure a datagrid widget to respond to that event.
The list of event types is defined at the dashboard level. You can then select one or more of these event types when you configure a widget. There are some predefined events, or you can add new ones.
Also defined at the dashboard level is a list of parameters that are passed between widgets, for all event types. When a widget responds to an event, it checks the parameters to find out what information it should display. For example, if a datagrid widget receives a value of 'Washington' for the regionId parameter, its information is updated so that it displays information relating to Washington. In most cases, the predefined list should be sufficient. However, you can add further parameters if you want to.
In the top left-hand corner of the main dashboard screen, click the Admin Panel icon:
.On the Admin Panel, click Appearance
.On the Appearance screen, in the menu on the left-hand side of the screen, select Advanced and click the Dashboard Events tab.
The predefined events are as follows:
Event name
Description
MAP_ENTITY_CLICK
The user clicks a marker on a map widget.
DASHBOARD.REGION_CHANGE_EVENT
The user selects a different Region from the Region filter.
DASHBOARD.DATE_RANGE_CHANGE_EVENT
The user selects a different time period from the Date filter.
The datatypes to be configured for
formattedFromDate,formattedToDate,from,fromDate,to,toDate,isoFromDateandisoToDateisobject.TABLE.SELECT_ROW_EVENT
The user selects a row in a datagrid widget.
DASHBOARD.LANG_CHANGE_EVENT
The user selects a different language in the Language drop-down list at the top of the main screen.
DASHBOARD.GENDER_CHANGE_EVENT
The user selects a different gender from the Gender filter.
DASHBOARD.AGE_RANGE_CHANGE_EVENT
The user selects a different age range from the Age Range filter.
DASHBOARD.GRANULARITY_CHANGE_EVENT
The user selects a different granularity from the Granularity filter.
To create a new event, click on the Dashboard Event button, enter the name of the event and click Save.
Note
It must be 4 -100 alphanumeric, dot and underscore characters only.
On the right-hand side of the tab is the list of parameters that are passed when an event occurs, in JSON format. You can add further parameters if you want to:
At the top of the parameters box, click the Tree drop-down list and select Code.
Add further parameters as desired, specifying the data type of each.
Click Update.
Your settings are applied to all dashboards. In other words, the lists of event types and parameters are available to widgets that are placed on any dashboard, not just the one that you are configuring.