import { Rect } from './internal.types.mjs';
import { RenderSession } from './renderer.mjs';
declare const vectorFormats: readonly ["vector"];
export type VectorFormat = (typeof vectorFormats)[0];
/**
 * The options for creating a session.
 * @property {string} [format] - specify the format of render data
 *   + `vector`: decode {@link CreateSessionOptions['artifactContent']} in binary vector format
 * @property {Uint8Array} artifactContent - The artifact content of Typst document.
 */
export interface CreateSessionOptions<T = VectorFormat> {
    format: T;
    artifactContent: Uint8Array;
}
/**
 * The options for rendering a Typst.
 * @description see {@link RenderByContentOptions} and {@link RenderInSessionOptions}
 */
export type RenderOptions<Base = RenderToCanvasOptions> = RenderInSessionOptions<Base> | RenderByContentOptions<Base>;
/**
 * The options for rendering a Typst document with a created session.
 * @property {RenderSession} renderSession - The Typst document session that has been created by TypstRenderer.
 */
export type RenderInSessionOptions<Base = RenderToCanvasOptions> = Base & {
    renderSession: RenderSession;
};
/**
 * The options for rendering a Typst document by artifact content.
 * See {@link CreateSessionOptions} for more details.
 */
export type RenderByContentOptions<Base = RenderToCanvasOptions> = Base & CreateSessionOptions;
/**
 * The options for rendering an entire preprocessed Typst document to specified container.
 */
export interface RenderToCanvasOptions extends Pick<RenderCanvasOptions, 'backgroundColor' | 'pixelPerPt'> {
    /**
     * The container to render the Typst document.
     */
    container: HTMLElement;
}
/**
 * The options for mounting Typst document to specified container.
 * @property {HTMLElement} [container] - The container to render the Typst document.
 * @property {number} [pixelPerPt] - The pixel per point scale up the image, which is 2.5 by default and recommended.
 */
export interface MountDomOptions {
    container: HTMLElement;
    /**
     * Set the pixel per point scale up the canvas panel.
     *
     * Note: Default to `3`.
     */
    pixelPerPt?: number;
    /**
     * Set a virtual scale to the dom panel.
     *
     * Note: Default to `1`.
     */
    domScale?: number;
}
/**
 * The options for rendering a svg string.
 */
export interface RenderSvgOptions {
    /**
     * Render the svg content inside a window, where the pages are placed vertically.
     */
    window?: Rect;
    /**
     * The selection of the data to render.
     * @description `body`: render the body of the document.
     * @description `defs`: render the defs of the document.
     * @description `css`: render the css of the document.
     * @description `js`: render the js of the document.
     * @default: all of fields set to `true`
     */
    data_selection?: {
        body: boolean;
        defs: boolean;
        css: boolean;
        js: boolean;
    };
}
/**
 * The options for rendering a preprocessed Typst document to specified container.
 * @property {HTMLElement} [container] - The container to render the Typst document.
 */
export interface RenderToSvgOptions extends RenderSvgOptions {
    container: HTMLElement;
}
/**
 * The options for manipulating the Typst document in the session.
 */
export interface ManipulateDataOptions {
    /**
     * The action to manipulate the data.
     * @description `reset`: reset the data to the initial state.
     * @description `merge`: merge the data to the current state.
     * @default 'reset'
     */
    action?: 'reset' | 'merge';
    /**
     * Opaque data to manipulate the Typst document from server.
     */
    data: Uint8Array;
}
/**
 * The options for rendering a page to a canvas.
 */
export declare class RenderCanvasOptions {
    /**
     * The canvas to render the Typst document.
     */
    canvas?: HTMLCanvasElement | CanvasRenderingContext2D;
    /**
     * The page offset to render.
     */
    pageOffset: number;
    /**
     * The previous render state.
     */
    cacheKey?: string;
    /**
     * Set the background color in format of `^#?[0-9a-f]{6}$`
     *
     * Note: Default to `#ffffff`.
     */
    backgroundColor?: string;
    /**
     * Set the pixel per point scale up the canvas panel.
     *
     * Note: Default to `3`.
     */
    pixelPerPt?: number;
    /**
     * The selection of the data to render.
     * @description `body`: render the body of the document.
     * @description `text`: render the text repr of the document.
     * @description `annnotation`: render the annnotation of the document.
     * @description `semantics`: render the semantics as HTML elements of the document.
     * @default: all of fields set to `true`
     */
    dataSelection?: {
        body?: boolean;
        semantics?: boolean;
    };
}
/**
 * The options for rendering a page to a canvas in background.
 */
export declare const OffscreenRenderCanvasOptions: typeof RenderCanvasOptions;
export interface OffscreenRenderCanvasOptions extends Omit<RenderCanvasOptions, 'canvas' | 'cacheKey'> {
    /**
     * The canvas to render the Typst document.
     */
    canvas: HTMLCanvasElement;
}
export {};
//# sourceMappingURL=options.render.d.mts.map