以下签名与说明从包的公开入口和 JSDoc 提取;中文说明与当前源码对账。Vue 组件接入见嵌入 Vue 工作台。
渲染与栅格化
renderTextDiagram
@quirekit/text-diagram/browserMIT根据明确语言 language 和精确草稿 source 执行可取消渲染,options 指定生命周期及 DOM 所有者。返回与这份源码绑定的静态 SVG 快照。
renderTextDiagramts
function renderTextDiagram(language: TextDiagramLanguage, source: string, options: TextDiagramRenderOptions): Promise<TextDiagramSnapshot>rasterizeTextDiagram
@quirekit/text-diagram/browserMIT从已经净化并绑定源码的 snapshot 生成 PNG;owner 为 Canvas 所有者,signal 为保存生命周期。返回受尺寸预算约束的 PNG,不再读取当前草稿。
rasterizeTextDiagramts
function rasterizeTextDiagram(snapshot: TextDiagramSnapshot, owner: Document, signal: AbortSignal): Promise<TextDiagramRaster>选项
TextDiagramRenderOptions
@quirekit/text-diagram/browserMIT显式的渲染生命周期,不捕获宿主编辑器状态。
TextDiagramRenderOptionsts
export interface TextDiagramRenderOptions {
readonly signal: AbortSignal;
readonly ownerDocument?: Document;
readonly typography?: TextDiagramTypography;
}TextDiagramTypography
@quirekit/text-diagram/browserMITMermaid 测量排版配置,在编辑、阅读和导出之间共用。
TextDiagramTypographyts
export interface TextDiagramTypography {
readonly fontFamily: string;
readonly fontSize: number;
}