package.dist.rendering-util.render.d.ts Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mermaid Show documentation

Markdown-ish syntax for generating flowcharts, mindmaps, sequence diagrams, class diagrams, gantt charts, git graphs and more.

The newest version!

import type { SVG } from '../diagram-api/types.js';
import type { InternalHelpers } from '../internals.js';
import type { LayoutData } from './types.js';
export interface RenderOptions {
    algorithm?: string;
}
export interface LayoutAlgorithm {
    render(layoutData: LayoutData, svg: SVG, helpers: InternalHelpers, options?: RenderOptions): Promise;
}
export type LayoutLoader = () => Promise;
export interface LayoutLoaderDefinition {
    name: string;
    loader: LayoutLoader;
    algorithm?: string;
}
export declare const registerLayoutLoaders: (loaders: LayoutLoaderDefinition[]) => void;
export declare const render: (data4Layout: LayoutData, svg: SVG) => Promise;
/**
 * Get the registered layout algorithm. If the algorithm is not registered, use the fallback algorithm.
 */
export declare const getRegisteredLayoutAlgorithm: (algorithm?: string, { fallback }?: {
    fallback?: string | undefined;
}) => string;