Skip to main content
All docs
V25.1
  • DashboardParameterDialogExtensionEvents Type

    Describes events this extension fires.

    Declaration

    export type DashboardParameterDialogExtensionEvents = {
        dynamicLookUpValuesLoaded: DynamicLookUpValuesLoadedArgs;
        showing: DashboardParameterDialogArgs;
        shown: DashboardParameterDialogArgs;
        hidden: DashboardParameterDialogArgs;
    }

    Members

    Name Type Description
    dynamicLookUpValuesLoaded DynamicLookUpValuesLoadedArgs

    Occurs after parameter values provided using a Dynamic List are loaded.

    hidden DashboardParameterDialogArgs

    Occurs after the Dashboard Parameters dialog is hidden.

    showing DashboardParameterDialogArgs

    Occurs before the Dashboard Parameters dialog is shown.

    shown DashboardParameterDialogArgs

    Occurs after the Dashboard Parameters dialog is shown.

    Remarks

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

    The following code handles the DashboardParameterDialogExtension.onShowing event:

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