@maxgraph/core/lib/esm/view/layout/SwimlaneManager.d.ts

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

import EventSource from '../event/EventSource.js';
import type { AbstractGraph } from '../AbstractGraph.js';
import EventObject from '../event/EventObject.js';
import type Cell from '../cell/Cell.js';
/**
 * Manager for swimlanes and nested swimlanes that sets the size of newly added
 * swimlanes to that of their siblings, and propagates changes to the size of a
 * swimlane to its siblings, if {@link siblings} is true, and its ancestors, if
 * {@link bubbling} is true.
 *
 * @category Layout
 */
declare class SwimlaneManager extends EventSource {
    constructor(graph: AbstractGraph, horizontal?: boolean, addEnabled?: boolean, resizeEnabled?: boolean);
    /**
     * Reference to the enclosing {@link AbstractGraph}.
     */
    graph: AbstractGraph;
    /**
     * Specifies if event handling is enabled.
     * @default true
     */
    enabled: boolean;
    /**
     * Specifies the orientation of the swimlanes.
     * @default true
     */
    horizontal: boolean;
    /**
     * Specifies if newly added cells should be resized to match the size of their
     * existing siblings.
     * @default true
     */
    addEnabled: boolean;
    /**
     * Specifies if resizing of swimlanes should be handled.
     * @default true
     */
    resizeEnabled: boolean;
    /**
     * Holds the function that handles the move event.
     */
    addHandler: (sender: EventSource, evt: EventObject) => void;
    /**
     * Holds the function that handles the move event.
     */
    resizeHandler: (sender: EventSource, evt: EventObject) => void;
    /**
     * Returns true if events are handled. This implementation
     * returns {@link enabled}.
     */
    isEnabled(): boolean;
    /**
     * Enables or disables event handling. This implementation
     * updates {@link enabled}.
     *
     * @param enabled Boolean that specifies the new enabled state.
     */
    setEnabled(value: boolean): void;
    /**
     * Returns {@link horizontal}.
     */
    isHorizontal(): boolean;
    /**
     * Sets {@link horizontal}.
     */
    setHorizontal(value: boolean): void;
    /**
     * Returns {@link addEnabled}.
     */
    isAddEnabled(): boolean;
    /**
     * Sets {@link addEnabled}.
     */
    setAddEnabled(value: boolean): void;
    /**
     * Returns {@link resizeEnabled}.
     */
    isResizeEnabled(): boolean;
    /**
     * Sets {@link resizeEnabled}.
     */
    setResizeEnabled(value: boolean): void;
    /**
     * Returns the graph that this manager operates on.
     */
    getGraph(): AbstractGraph;
    /**
     * Sets the graph that the manager operates on.
     */
    setGraph(graph: AbstractGraph | null): void;
    /**
     * Returns true if the given swimlane should be ignored.
     */
    isSwimlaneIgnored(swimlane: Cell): boolean;
    /**
     * Returns true if the given cell is horizontal. If the given cell is not a
     * swimlane, then the global orientation is returned.
     */
    isCellHorizontal(cell: Cell): boolean;
    /**
     * Called if any cells have been added.
     *
     * @param cell Array of {@link Cell} that have been added.
     */
    cellsAdded(cells: Cell[]): void;
    /**
     * Updates the size of the given swimlane to match that of any existing
     * siblings swimlanes.
     *
     * @param swimlane {@link Cell} that represents the new swimlane.
     */
    swimlaneAdded(swimlane: Cell): void;
    /**
     * Called if any cells have been resizes. Calls {@link swimlaneResized} for all
     * swimlanes where {@link isSwimlaneIgnored} returns false.
     *
     * @param cells Array of {@link Cell} whose size was changed.
     */
    cellsResized(cells: Cell[]): void;
    /**
     * Called from {@link cellsResized} for all swimlanes that are not ignored to update
     * the size of the siblings and the size of the parent swimlanes, recursively,
     * if {@link bubbling} is true.
     *
     * @param swimlane {@link Cell} whose size has changed.
     */
    resizeSwimlane(swimlane: Cell, w: number, h: number, parentHorizontal: boolean): void;
    /**
     * Removes all handlers from the {@link graph} and deletes the reference to it.
     */
    destroy(): void;
}
export default SwimlaneManager;