useDashboardDispatch

useDashboardDispatch returns the Redux dispatch function of the dashboard store, so a plugin component can dispatch any dashboard command.

Basic usage

import { changeFilterContextSelectionByParams, useDashboardDispatch } from "@gooddata/sdk-ui-dashboard";

export const ClearFiltersButton = () => {
    const dispatch = useDashboardDispatch();

    return (
        <button onClick={() => dispatch(changeFilterContextSelectionByParams({ filters: [], resetOthers: true }))}>
            Clear filters
        </button>
    );
};

The same with the public hook:

import { changeFilterContextSelectionByParams, useDispatchDashboardCommand } from "@gooddata/sdk-ui-dashboard";

export const ClearFiltersButton = () => {
    const changeFilters = useDispatchDashboardCommand(changeFilterContextSelectionByParams);

    return <button onClick={() => changeFilters({ filters: [], resetOthers: true })}>Clear filters</button>;
};

Return value

Dispatch<Action>: the Redux dispatch function of the dashboard store. Pass it a command object created by a command creator, such as changeFilterContextSelectionByParams(...).

Notes

• Call the hook inside a component rendered by the Dashboard component, for example a custom widget of a plugin. Outside of the dashboard store there is no store to dispatch to.
• useDispatchDashboardCommand(commandCreator) returns a function that takes the creator’s arguments and dispatches the command. Use it unless you need to dispatch several kinds of commands through one function.
• For every command you can dispatch, see All commands. For the events the dashboard emits in response, see All events.