@antv/g6/lib/plugins/toolbar/index.d.ts

A Graph Visualization Framework in JavaScript

import type { RuntimeContext } from '../../runtime/types';
import type { CornerPlacement } from '../../types';
import type { BasePluginOptions } from '../base-plugin';
import { BasePlugin } from '../base-plugin';
import type { ToolbarItem } from './util';
/**
 * <zh/> Toolbar 工具栏的配置项
 *
 * <en/> The options of the Toolbar toolbar
 */
export interface ToolbarOptions extends BasePluginOptions {
    /**
     * <zh/> 给工具栏的 DOM 追加的 classname，便于自定义样式。默认是包含 `g6-toolbar`
     *
     * <en/> The classname appended to the menu DOM for custom styles. The default is `g6-toolbar`
     */
    className?: string;
    /**
     * <zh/> Toolbar 的位置，相对于画布，会影响 DOM 的 style 样式
     *
     * <en/> The position of the Toolbar relative to the canvas, which will affect the style of the DOM
     * @defaultValue 'top-left'
     */
    position?: CornerPlacement;
    /**
     * <zh/> 工具栏显式的 style 样式，可以用来设置它相对于画布的位置、背景容器样式等
     *
     * <en/> The style style of the Toolbar, which can be used to set its position relative to the canvas
     */
    style?: Partial<CSSStyleDeclaration>;
    /**
     * <zh/> 当工具栏被点击后，触发的回调方法
     *
     * <en/> The callback method triggered when the toolbar item is clicked
     */
    onClick?: (value: string, target: Element) => void;
    /**
     * <zh/> 返回工具栏的项目列表，支持 `Promise` 类型的返回值
     *
     * <en/> Return the list of toolbar items, support return a `Promise` as items
     */
    getItems: () => ToolbarItem[] | Promise<ToolbarItem[]>;
}
/**
 * <zh/> 工具栏，支持配置工具栏项目，以及点击之后的回调方法
 *
 * <en/> Toolbar, support configuration of toolbar items, and callback methods after clicking
 */
export declare class Toolbar extends BasePlugin<ToolbarOptions> {
    static defaultOptions: Partial<ToolbarOptions>;
    private $element;
    constructor(context: RuntimeContext, options: ToolbarOptions);
    /**
     * <zh/> 更新工具栏的配置项
     *
     * <en/> Update the configuration of the toolbar
     * @param options - <zh/> 工具栏的配置项 | <en/> The options of the toolbar
     * @internal
     */
    update(options: Partial<ToolbarOptions>): Promise<void>;
    /**
     * <zh/> 销毁工具栏
     *
     * <en/> Destroy the toolbar
     * @internal
     */
    destroy(): void;
    private getDOMContent;
    private onToolbarItemClick;
}