refresh Method

Use the refresh method to rerun all of the queries for an Aura component for CRM Analytics dashboards or for a specific query.

Arguments

Argument Name	Description
`config`	The optional configuration for the `refresh` call. This value is a JSON object that sets parameters for the call. For `refresh`, the `config` is used when refresh is called for a single query on the dashboard. To specify which query to rerun, use the `step` parameter.

Example

Add your implementation of the refresh call into the controller.js for your Aura component. The optional config JSON is created with the step attribute to rerun the query for a specific step. To rerun all the queries for a dashboard, call refresh without the config attribute.

({
  refresh: function (component, event, helper) {
    var dashboard = component.find("myDashboard");

    var config = {
      step: "step_id",
    };

    dashboard.refresh(config);
  },
});

See Also

getState Method
setState Method