DashboardExportExtensionEvents Type

Describes events this extension fires.

Declaration

export type DashboardExportExtensionEvents = {
    exportDialogShowing: DashboardExportDialogArgs;
    exportDialogShown: DashboardExportDialogArgs;
    exportDialogHidden: DashboardExportDialogArgs;
}

Members

Name	Type	Description
exportDialogHidden	DashboardExportDialogArgs	Occurs when the export dialog is hidden.
exportDialogShowing	DashboardExportDialogArgs	Occurs before the export dialog is shown.
exportDialogShown	DashboardExportDialogArgs	Occurs after the export dialog is shown.

Remarks

Find the extension by its name (dashboardExport) and pass the event handler’s name to subscribe on the DashboardExportExtension events.

The following code handles the DashboardExportExtensionOptions.onExportDialogShowing event:

function onBeforeRender(dashboardControl) {
  let exportExtension = dashboardControl.findExtension("dashboardExport");
  if (exportExtension) {
    exportExtension.on('exportDialogShowing', customizeDialog);
  }
}
function customizeDialog(args) {
  // ...
}