Handle dashboard events

import {
    isDashboardAttributeFilterSelectionChanged,
    type DashboardAttributeFilterSelectionChanged,
    type DashboardEventHandler,
} from "@gooddata/sdk-ui-dashboard";

export const logFilterChanges: DashboardEventHandler<DashboardAttributeFilterSelectionChanged> = {
    eval: isDashboardAttributeFilterSelectionChanged,
    handler: (event) => {
        const { displayForm, attributeElements } = event.payload.filter.attributeFilter;
        // displayForm: ObjRef of the filter, attributeElements: the new selection
    },
};

import { Dashboard } from "@gooddata/sdk-ui-dashboard";

export function DashboardPage({ dashboard }: { dashboard: string }) {
    return <Dashboard dashboard={dashboard} eventHandlers={[logFilterChanges]} />;
}

import {
    DashboardPluginV1,
    type DashboardContext,
    type DashboardInitialized,
    type IDashboardCustomizer,
    type IDashboardEventHandling,
} from "@gooddata/sdk-ui-dashboard";

export class Plugin extends DashboardPluginV1 {
    public register(_ctx: DashboardContext, _customize: IDashboardCustomizer, handlers: IDashboardEventHandling): void {
        handlers.addEventHandler<DashboardInitialized>("GDC.DASH/EVT.INITIALIZED", (event) => {
            const visualizationCount = event.payload.insights.length;
            // The dashboard is loaded; event.payload also carries dashboard, config, and permissions
        });

        handlers.addCustomEventHandler(logFilterChanges);
    }
}

import { areObjRefsEqual, attributeDisplayFormRef } from "@gooddata/sdk-model";
import {
    isDashboardAttributeFilterSelectionChanged,
    resetAttributeFilterSelection,
    selectFilterContextAttributeFilterItemByDisplayForm,
    type DashboardAttributeFilterSelectionChanged,
    type DashboardEventHandler,
} from "@gooddata/sdk-ui-dashboard";
import * as Md from "./catalog.js";

const regionDisplayForm = attributeDisplayFormRef(Md.Region.Default);
const productDisplayForm = attributeDisplayFormRef(Md.Product.Name);

export const resetProductOnRegionChange: DashboardEventHandler<DashboardAttributeFilterSelectionChanged> = {
    eval: isDashboardAttributeFilterSelectionChanged,
    handler: (event, dispatch, stateSelect) => {
        const changedDisplayForm = event.payload.filter.attributeFilter.displayForm;

        if (!areObjRefsEqual(changedDisplayForm, regionDisplayForm)) {
            return;
        }

        const productFilter = stateSelect(selectFilterContextAttributeFilterItemByDisplayForm(productDisplayForm));

        if (productFilter && "attributeFilter" in productFilter && productFilter.attributeFilter.localIdentifier) {
            dispatch(resetAttributeFilterSelection(productFilter.attributeFilter.localIdentifier));
        }
    },
};

import {
    changeAttributeFilterSelection,
    isDashboardAttributeFilterSelectionChanged,
    type DashboardAttributeFilterSelectionChanged,
    type DashboardEventHandler,
} from "@gooddata/sdk-ui-dashboard";

const PLUGIN_CORRELATION = "my-plugin/preset";

export function applyPreset(dispatch: (command: unknown) => void, filterLocalId: string): void {
    dispatch(changeAttributeFilterSelection(filterLocalId, { values: ["East"] }, "IN", PLUGIN_CORRELATION));
}

export const onUserFilterChange: DashboardEventHandler<DashboardAttributeFilterSelectionChanged> = {
    eval: isDashboardAttributeFilterSelectionChanged,
    handler: (event) => {
        if (event.correlationId === PLUGIN_CORRELATION) {
            return; // our own change, ignore
        }
        // the user changed the filter
    },
};

import { isCustomDashboardEvent, type DashboardEventHandler, type ICustomDashboardEvent } from "@gooddata/sdk-ui-dashboard";

type RowSelected = ICustomDashboardEvent<{ rowId: string }>;

export const onRowSelected: DashboardEventHandler<RowSelected> = {
    eval: (event) => isCustomDashboardEvent(event) && event.type === "myPlugin.rowSelected",
    handler: (event) => {
        const rowId = event.payload?.rowId;
    },
};