CRM Analytics Aura Events

Easily interact with the embedded CRM Analytics Dashboard component in custom applications. Use Aura Events for Lightning Apps, Visualforce, or your preferred development environment.

wave:assetLoaded

A CRM Analytics asset fires this event when the asset is finished loading. The payload contains the asset type and the asset id. For a CRM Analytics dashboard asset, the event is fired: on the initial load of a dashboard, when a user resets to dashboard to the initial view, and when the user selects a dashboard view. After this event is received, you can safely reapply mandatory filters or resync the dashboard state.

wave:update

Use this event to dynamically set the filter on a CRM Analytics dashboard or interact with the dashboard by dynamically changing the selection. It has four attributes: the unique ID of the CRM Analytics asset on which to apply the filter, the payload, the asset type (currently only dashboard), and the fully qualified developer name of the CRM Analytics dashboard. The payload is a JSON string that identifies the datasets and any dimensions and field values.

wave:selectionChanged

A CRM Analytics dashboard fires this event for consumption by custom Aura components. It provides the following attributes: the ID of the dashboard that fired the event and the payload. The payload object contains the selection information—the name of the step involved when changing the selection and an array of objects representing the current selection. Each object in the array contains one or more attributes based on the selection.

wave:discover

This event sends a global request to identify CRM Analytics dashboard assets. The response is a wave:discoverResponse event. You can include your own parameter in this event that is included in the response payload.

wave:discoverResponse

This event is fired by listening to CRM Analytics dashboard assets in response to the wave:discover event. The payload includes the dashboard identifier, the type of component, the dashboard title, whether the dashboard is still loading, and any optional parameter sent with the request.

wave:pageChange

Use this event to update the CRM Analytics dashboard page that is displayed. It has two attributes: the unique ID of the page to display and the fully qualified developer name of the CRM Analytics dashboard