@maxgraph/core/lib/esm/view/plugins/TooltipHandler.d.ts

maxGraph is a fully client side JavaScript diagramming library that uses SVG and HTML for rendering.

import type { AbstractGraph } from '../AbstractGraph.js';
import CellState from '../cell/CellState.js';
import InternalMouseEvent from '../event/InternalMouseEvent.js';
import type { GraphPlugin, MouseListenerSet } from '../../types.js';
import EventSource from '../event/EventSource.js';
/**
 * Graph event handler that displays tooltips.
 *
 * {@link AbstractGraph.getTooltip} is used to get the tooltip for a cell or handle.
 *
 * This handler is generally enabled using {@link AbstractGraph.setTooltips}.
 *
 * @category Plugin
 */
declare class TooltipHandler implements GraphPlugin, MouseListenerSet {
    static pluginId: string;
    /**
     * Creates the tooltip element and appends it to the document body.
     *
     */
    init(): void;
    /**
     * Constructs an event handler that displays tooltips.
     *
     * @param graph Reference to the enclosing {@link AbstractGraph}.
     */
    constructor(graph: AbstractGraph);
    div?: HTMLElement | null;
    /**
     * Specifies the zIndex for the tooltip and its shadow.
     * @default 10005
     */
    zIndex: number;
    /**
     * Reference to the enclosing {@link AbstractGraph}.
     */
    graph: AbstractGraph;
    /**
     * Delay to show the tooltip in milliseconds.
     * @default 500
     */
    delay: number;
    /**
     * Specifies if touch and pen events should be ignored.
     * @default true
     */
    ignoreTouchEvents: boolean;
    /**
     * Specifies if the tooltip should be hidden if the mouse is moved over the current cell.
     * @default false
     */
    hideOnHover: boolean;
    /**
     * `true` if this handler was destroyed using {@link onDestroy}.
     */
    destroyed: boolean;
    lastX: number;
    lastY: number;
    state: CellState | null;
    stateSource: boolean;
    node: any;
    thread: number | null;
    /**
     * Specifies if events are handled.
     * @default false
     */
    enabled: boolean;
    /**
     * Returns `true` if events are handled.
     *
     * This implementation returns {@link enabled}.
     */
    isEnabled(): boolean;
    /**
     * Enables or disables event handling.
     *
     * This implementation updates {@link enabled}.
     */
    setEnabled(enabled: boolean): void;
    /**
     * Returns {@link hideOnHover}.
     */
    isHideOnHover(): boolean;
    /**
     * Sets <hideOnHover>.
     */
    setHideOnHover(value: boolean): void;
    /**
     * Returns the <CellState> to be used for showing a tooltip for this event.
     */
    getStateForEvent(me: InternalMouseEvent): CellState | null;
    /**
     * Handles the event by initiating a rubberband selection.
     * By consuming the event all subsequent events of the gesture are redirected to this handler.
     */
    mouseDown(_sender: EventSource, me: InternalMouseEvent): void;
    /**
     * Handles the event by updating the rubberband selection.
     */
    mouseMove(_sender: EventSource, me: InternalMouseEvent): void;
    /**
     * Handles the event by resetting the tooltip timer or hiding the existing tooltip.
     */
    mouseUp(_sender: EventSource, me: InternalMouseEvent): void;
    /**
     * Resets the timer.
     */
    resetTimer(): void;
    /**
     * Resets and/or restarts the timer to trigger the display of the tooltip.
     */
    reset(me: InternalMouseEvent, restart: boolean, state?: CellState | null): void;
    /**
     * Hides the tooltip and resets the timer.
     */
    hide(): void;
    /**
     * Hides the tooltip.
     */
    hideTooltip(): void;
    /**
     * Shows the tooltip for the specified cell and optional index at the
     * specified location (with a vertical offset of 10 pixels).
     */
    show(tip: HTMLElement | string | null, x: number, y: number): void;
    /**
     * Destroys the handler and all its resources and DOM nodes.
     */
    onDestroy(): void;
}
export default TooltipHandler;