@highcharts/dashboards/es-modules/Dashboards/PluginHandler.d.ts

Highcharts Dashboards framework

import type { AnyRecord } from '../Shared/Types';
export interface DashboardsPlugin<T = (AnyRecord | undefined)> {
    /**
     * Custom properties of the plugin
     */
    custom: T;
    /**
     * Maximal version of plugin that is compatible with dashboard
     */
    maxRevision?: number;
    /**
     * Minimal version of plugin that is compatible with dashboard
     */
    minRevision?: number;
    /**
     * Name of plugin
     */
    name: string;
}
/**
 * Adds a dashboard plugin.
 *
 * @param {Dashboards.Plugin} plugin
 * Dashboard plugin to register.
 *
 * @param {string} [key]
 * Plugin key for the registry. (Default: `plugin.name`)
 */
export declare function addPlugin(plugin: DashboardsPlugin, key?: string): void;
/**
 * Removes a dashboard plugin.
 *
 * @param {string} key
 * Plugin key in the registry.
 */
export declare function removePlugin(key: string): void;
declare const PluginHandler: {
    addPlugin: typeof addPlugin;
    removePlugin: typeof removePlugin;
    registry: Record<string, DashboardsPlugin<AnyRecord | undefined>>;
    revision: number;
};
export default PluginHandler;