@syncfusion/ej2-diagrams/src/diagram/objects/tooltip-model.d.ts

Feature-rich diagram control to create diagrams like flow charts, organizational charts, mind maps, and BPMN diagrams. Its rich feature set includes built-in shapes, editing, serializing, exporting, printing, overview, data binding, and automatic layouts.

import { Property, ChildProperty, isBlazor, initializeCSPTemplate } from '@syncfusion/ej2-base';import { Tooltip, AnimationModel, Position, TooltipEventArgs } from '@syncfusion/ej2-popups';import { TooltipRelativeMode, TooltipMode } from '../enum/enum';import { Diagram } from '../diagram';import { NodeModel } from './node-model';import { ConnectorModel } from './connector-model';import { PointPortModel } from './port-model';

/**
 * Interface for a class DiagramTooltip
 */
export interface DiagramTooltipModel {

    /**
     * Defines the content of the Tooltip
     *
     * @default ''
     */
    content?: string | HTMLElement;

    /**
     * Defines the position of the Tooltip
     *
     * @default 'TopLeft'
     * @aspDefaultValueIgnore
     * @blazorType Syncfusion.Blazor.Popups.Position
     * @blazorDefaultValue Syncfusion.Blazor.Popups.Position.TopLeft
     * @isEnumeration true
     */
    position?: Position;

    /**
     * Defines the relative mode of the Tooltip
     * * Object - sets the tooltip position relative to the node
     * * Mouse - sets the tooltip position relative to the mouse
     *
     * @default 'Mouse'
     */
    relativeMode?: TooltipRelativeMode;

    /**
     * Defines if the Tooltip has tip pointer or not
     *
     * @default true
     */
    showTipPointer?: boolean;

    /**
     * Sets the width of the Tooltip
     *
     * @default 'auto'
     */
    width?: number | string;

    /**
     * Sets the height of the Tooltip
     *
     * @default 'auto'
     */
    height?: number | string;

    /**
     * Sets how to open the Tooltip
     *
     * @default 'Auto'
     */
    openOn?: TooltipMode;

    /**
     * Allows to set the same or different animation option for the Tooltip, when it is opened or closed.
     * ```html
     * <div id='diagram'></div>
     * ```
     * ```typescript
     * let diagram: Diagram = new Diagram({
     * ...
     * constraints: DiagramConstraints.Default | DiagramConstraints.Tooltip,
     * tooltip: { content: getcontent(), position: 'TopLeft', relativeMode: 'Object',
     * animation: { open: { effect: 'FadeZoomIn', delay: 0 },
     * close: { effect: 'FadeZoomOut', delay: 0 } } },
     * ...
     * });
     * diagram.appendTo('#diagram');
     * function getcontent(): => {
     * ...
     * }
     * ```
     *
     * @aspDefaultValueIgnore
     * @blazorType Syncfusion.Blazor.Popups.AnimationModel
     * @default { open: { effect: 'FadeIn', duration: 150, delay: 0 }, close: { effect: 'FadeOut', duration: 150, delay: 0 } }
     */
    animation?: AnimationModel;

    /**
     * Specifies whether the tooltip remains visible even when the mouse moves away from the target element.
     * If set to true, the tooltip is always visible; otherwise, it is hidden when the mouse moves away.
     * The default value is false.
     *
     * @default false
     */
    isSticky?: boolean;

}