@bpmnkit/canvas 0.0.28 → 0.0.29

package/dist/canvas.d.ts

@@ -1,5 +1,6 @@
 import type { BpmnDefinitions } from "@bpmnkit/core";
-import type { CanvasEvents, CanvasOptions, Theme } from "./types.js";
+import { OverlayManager } from "./overlays.js";
+import type { CanvasEvents, CanvasOptions, ImportWarnings, PlaneInfo, RenderedEdge, RenderedShape, ScreenBox, Theme, Viewbox } from "./types.js";
 /**
  * BpmnCanvas — a high-performance, accessible BPMN 2.0 diagram viewer.
  *
@@ -58,14 +59,35 @@ export declare class BpmnCanvas {
     private readonly _labelsG;
     private _gridPattern;
     private _markerId;
+    private _breadcrumb;
     private readonly _viewport;
     private readonly _keyboard;
+    private readonly _overlays;
+    private readonly _scene;
     private readonly _plugins;
     private _shapes;
     private _edges;
     private _currentDefs;
     private _theme;
     private _fit;
+    private _layoutMissingDi;
+    /** Elements from the last load that had no diagram interchange. */
+    private _importWarnings;
+    /** The DI plane currently rendered. */
+    private _currentPlane;
+    /** Element ids (this document) that own a plane and can be drilled into. */
+    private _planeElementIds;
+    /** Breadcrumb path from the root plane to the current one. */
+    private _planeStack;
+    /** CSS classes applied via {@link addMarker}, keyed by element id. */
+    private _markers;
+    /** Element id currently under the pointer (for hover enter/leave events). */
+    private _hoverId;
+    /**
+     * Set once the user pans/zooms so a container resize preserves their
+     * viewport instead of force-fitting the diagram.
+     */
+    private _userMovedViewport;
     private _listeners;
     constructor(options: CanvasOptions);
     private _ro;
@@ -80,6 +102,25 @@ export declare class BpmnCanvas {
      * Use this when you already have the parsed model from `@bpmnkit/core`.
      */
     loadDefinitions(defs: BpmnDefinitions): void;
+    /**
+     * Returns the elements from the last {@link load}/{@link loadDefinitions}
+     * that had no diagram interchange (and so were auto-laid-out or skipped).
+     */
+    getImportWarnings(): ImportWarnings;
+    /**
+     * Lists every DI plane in the current document (the primary plane plus any
+     * collapsed sub-processes that carry their own layout).
+     */
+    getPlanes(): PlaneInfo[];
+    /**
+     * Shows the plane identified by a DI plane `bpmnElement` (a process/
+     * collaboration id or a collapsed sub-process id). Drilling into a
+     * sub-process extends the breadcrumb; navigating to an ancestor trims it.
+     * No-op if the id has no plane. Fires `plane:change`.
+     */
+    showPlane(planeElementId: string): void;
+    /** Renders a specific plane into the (cleared) layers and refits. */
+    private _renderPlane;
     /** Clears the canvas and fires `diagram:clear`. */
     clear(): void;
     /**
@@ -89,12 +130,75 @@ export declare class BpmnCanvas {
     fitView(padding?: number): void;
     /** Sets the color theme. Pass `"auto"` to follow the OS preference. */
     setTheme(theme: Theme): void;
+    /**
+     * HTML overlays anchored to diagram elements (badges, tooltips, panels).
+     * @example
+     * ```typescript
+     * canvas.overlays.add("Task_1", {
+     *   position: { top: -8, right: -8 },
+     *   html: `<span class="badge">!</span>`,
+     * });
+     * ```
+     */
+    get overlays(): OverlayManager;
+    /** Returns the rendered shape or edge for a BPMN id, or `undefined` (O(1)). */
+    getElement(id: string): RenderedShape | RenderedEdge | undefined;
+    /** Returns the `<g>` graphics element for a BPMN id, or `undefined` (O(1)). */
+    getGraphics(id: string): SVGGElement | undefined;
+    /** Iterates every rendered element (shapes and edges). */
+    forEachElement(fn: (el: RenderedShape | RenderedEdge) => void): void;
+    /**
+     * Re-renders a single element's `<g>` in place from the current model,
+     * preserving markers/selection classes — the incremental-update path used
+     * for cheap edits. No-op for an unknown id.
+     */
+    updateElement(id: string): void;
     /** Zooms in by 25% centred on the canvas. */
     zoomIn(): void;
     /** Zooms out by 25% centred on the canvas. */
     zoomOut(): void;
     /** Resets to 100% zoom, centred on the canvas. */
     resetZoom(): void;
+    /**
+     * Adjusts the zoom. Pass `"fit"` (or no argument) to fit the whole diagram;
+     * pass a number for an absolute scale, optionally keeping `center`
+     * (screen-space pixels relative to the host) fixed.
+     */
+    zoom(scaleOrFit?: number | "fit", center?: {
+        x: number;
+        y: number;
+    }): void;
+    /** Returns the visible region in diagram coordinates plus the zoom scale. */
+    viewbox(): Viewbox;
+    /** Pans (without changing zoom) so the element with the given id is centred. */
+    scrollToElement(id: string): void;
+    /**
+     * Returns the element's bounding box in screen pixels relative to the host,
+     * or `null` if the element is not found.
+     */
+    getAbsoluteBBox(id: string): ScreenBox | null;
+    /**
+     * Serializes the current diagram to a standalone SVG string with theme
+     * colours inlined, so it renders correctly outside the page.
+     * @param opts.bounds `"diagram"` (default) exports the whole diagram;
+     *   `"viewport"` exports only the currently visible region.
+     */
+    exportSvg(opts?: {
+        bounds?: "diagram" | "viewport";
+    }): string;
+    /**
+     * Rasterizes the current diagram to a PNG data URL at `scale`× the diagram
+     * size. Browser-only (requires `Image`/`<canvas>`).
+     */
+    exportPng(scale?: number): Promise<string>;
+    /** Adds a CSS class to the element with the given BPMN id. No-op if not found. */
+    addMarker(id: string, cls: string): void;
+    /** Removes a CSS class from the element with the given BPMN id. */
+    removeMarker(id: string, cls: string): void;
+    /** Returns whether the element with the given id currently has the CSS class. */
+    hasMarker(id: string, cls: string): boolean;
+    /** Toggles a CSS class on the element with the given id. */
+    toggleMarker(id: string, cls: string): void;
     /**
      * Subscribes to a canvas event. Returns an unsubscribe function.
      *
@@ -119,6 +223,27 @@ export declare class BpmnCanvas {
     clearHighlights(): void;
     /** Destroys the canvas, removing all DOM nodes and event listeners. */
     destroy(): void;
+    /** Finds the SVG group for a shape or edge by BPMN id. */
+    private _findElement;
+    /** Design tokens to resolve from the live host for a self-contained export. */
+    private static readonly _EXPORT_TOKENS;
+    /** Stylesheet for the exported SVG: resolved theme tokens + the canvas CSS. */
+    private _exportStyles;
+    /** A human-readable label for a plane's `bpmnElement` (name, or a fallback). */
+    private _planeName;
+    /** Recursively finds a flow element by id across all processes/sub-processes. */
+    private _findFlowElementById;
+    /** Rebuilds the breadcrumb bar from the current plane stack. */
+    private _updateBreadcrumb;
+    /**
+     * Resolves the BPMN element id under a pointer/mouse event, or `null`.
+     * Prefers `elementFromPoint` (correct when native SVG hit-testing returns
+     * the root `<svg>` in flex/scroll containers) and falls back to the event
+     * target (for environments where `elementFromPoint` is unavailable).
+     */
+    private _elementIdForEvent;
+    /** Diagram-coordinate bounds of a shape (from DI) or edge (waypoint bbox). */
+    private _diagramBounds;
     private _applyTheme;
     private _installPlugin;
     private _emit;