@antv/x6/es/graph/format.d.ts

JavaScript diagramming library that uses SVG and HTML for rendering.

import { NumberExt } from '../util';
import { Size } from '../types';
import { Rectangle } from '../geometry';
import { Graph } from './graph';
import { Base } from './base';
export declare class FormatManager extends Base {
    toSVG(callback: FormatManager.ToSVGCallback, options?: FormatManager.ToSVGOptions): void;
    toDataURL(callback: FormatManager.ToSVGCallback, options: FormatManager.ToDataURLOptions): void;
    toPNG(callback: FormatManager.ToSVGCallback, options?: FormatManager.ToImageOptions): void;
    toJPEG(callback: FormatManager.ToSVGCallback, options?: FormatManager.ToImageOptions): void;
}
export declare namespace FormatManager {
    type ToSVGCallback = (dataUri: string) => any;
    interface ToSVGOptions {
        /**
         * By default, the resulting SVG has set width and height to `100%`.
         * If you'd like to have the dimensions to be set to the actual content
         * width and height, set `preserveDimensions` to `true`. An object with
         * `width` and `height` properties can be also used here if you need to
         * define the export size explicitely.
         */
        preserveDimensions?: boolean | Size;
        viewBox?: Rectangle.RectangleLike;
        /**
         * When set to `true` all the styles from external stylesheets are copied
         * to the resulting SVG export. Note this requires a lot of computations
         * and it might significantly affect the export time.
         */
        copyStyles?: boolean;
        stylesheet?: string;
        /**
         * Converts all contained images into Data URI format.
         */
        serializeImages?: boolean;
        /**
         * A function called before the XML serialization. It may be used to
         * modify the exported SVG before it is converted to a string. The
         * function can also return a new SVGDocument.
         */
        beforeSerialize?: (this: Graph, svg: SVGSVGElement) => any;
    }
    interface ToImageOptions extends ToSVGOptions {
        /**
         * The width of the image in pixels.
         */
        width?: number;
        /**
         * The height of the image in pixels.
         */
        height?: number;
        ratio?: string;
        backgroundColor?: string;
        padding?: NumberExt.SideOptions;
        quality?: number;
    }
    interface ToDataURLOptions extends ToImageOptions {
        type: 'image/png' | 'image/jpeg';
    }
}