界面: Mermaid
mermaid.Mermaid
属性
contentLoaded
• contentLoaded: () => void
类型声明
▸ (): void
##contentLoaded 当页面加载时调用的回调函数。此函数获取 mermaid 渲染的配置，并调用 init 以渲染页面上的 mermaid 图表。
返回值
void
定义在
packages/mermaid/src/mermaid.ts:436
detectType
• detectType: (text: string, config?: MermaidConfig) => string
类型声明
▸ (text, config?): string
检测图形文本的类型。
考虑到 %%init 指令可能存在。
参数
| 名称 | 类型 | 描述 |
|---|---|---|
text | string | 定义图形的文本。例如: mermaid %%{initialize: {"startOnLoad": true, logLevel: "fatal" }}%% graph LR a-->b b-->c c-->d d-->e e-->f f-->g g-->h |
config? | MermaidConfig | mermaid 配置。 |
返回值
string
一个图形定义键
定义在
packages/mermaid/src/mermaid.ts:438
init
• init: (config?: MermaidConfig, nodes?: string | HTMLElement | NodeListOf<HTMLElement>, callback?: (id: string) => unknown) => Promise<void>
已弃用
请改用 initialize 和 run。
类型声明
▸ (config?, nodes?, callback?): Promise<void>
参数
| 名称 | 类型 |
|---|---|
config? | MermaidConfig |
nodes? | string | HTMLElement | NodeListOf<HTMLElement> |
callback? | (id: string) => unknown |
返回值
Promise<void>
定义在
packages/mermaid/src/mermaid.ts:431
initialize
• initialize: (config: MermaidConfig) => void
类型声明
▸ (config): void
用于设置 mermaid 的配置。此函数应在 run 函数之前调用。
参数
| 名称 | 类型 | 描述 |
|---|---|---|
config | MermaidConfig | mermaid 的配置对象。 |
返回值
void
定义在
packages/mermaid/src/mermaid.ts:435
mermaidAPI
• mermaidAPI: Readonly<{ defaultConfig: MermaidConfig = configApi.defaultConfig; getConfig: () => MermaidConfig = configApi.getConfig; getDiagramFromText: (text: string, metadata: Pick<DiagramMetadata, "title">) => Promise<Diagram> ; getSiteConfig: () => MermaidConfig = configApi.getSiteConfig; globalReset: () => void ; initialize: (userOptions: MermaidConfig) => void ; parse: (text: string, parseOptions: ParseOptions & { suppressErrors: true }) => Promise<ParseResult | false>(text: string, parseOptions?: ParseOptions) => Promise<ParseResult> ; render: (id: string, text: string, svgContainingElement?: Element) => Promise<RenderResult> ; reset: () => void ; setConfig: (conf: MermaidConfig) => MermaidConfig = configApi.setConfig; updateSiteConfig: (conf: MermaidConfig) => MermaidConfig = configApi.updateSiteConfig }>
已弃用
请改用 parse 和 render。如果您需要的新 API 不符合您的用例，请 开启讨论。
定义在
packages/mermaid/src/mermaid.ts:425
parse
• parse: (text: string, parseOptions: ParseOptions & { suppressErrors: true }) => Promise<ParseResult | false>(text: string, parseOptions?: ParseOptions) => Promise<ParseResult>
类型声明
▸ (text, parseOptions): Promise<ParseResult | false>
解析文本并验证语法。
参数
| 名称 | 类型 | 描述 |
|---|---|---|
text | string | mermaid 图表定义。 |
parseOptions | ParseOptions & { suppressErrors: true } | 解析选项。 |
返回值
Promise<ParseResult | false>
如果有效，则包含 diagramType 设置为图表类型的对象。否则，如果 parseOptions.suppressErrors 为 true，则为 false。
参见
抛出
如果图表无效且 parseOptions.suppressErrors 为 false 或未设置，则抛出错误。
▸ (text, parseOptions?): Promise<ParseResult>
参数
| 名称 | 类型 |
|---|---|
text | string |
parseOptions? | ParseOptions |
返回值
Promise<ParseResult>
定义在
packages/mermaid/src/mermaid.ts:426
parseError
• Optional parseError: ParseErrorFunction
定义在
packages/mermaid/src/mermaid.ts:420
registerExternalDiagrams
• registerExternalDiagrams: (diagrams: ExternalDiagramDefinition[], opts: { lazyLoad?: boolean = true }) => Promise<void>
类型声明
▸ (diagrams, opts?): Promise<void>
用于注册外部图表类型。
参数
| 名称 | 类型 | 默认值 | 描述 |
|---|---|---|---|
diagrams | ExternalDiagramDefinition[] | undefined | 外部图表定义的数组。 |
opts | 对象 | {} | 如果 opts.lazyLoad 为 false，图表将立即加载。 |
opts.lazyLoad? | 布尔值 | true | - |
返回
Promise<void>
定义在
packages/mermaid/src/mermaid.ts:434
registerIconPacks
• registerIconPacks: (iconLoaders: IconLoader[]) => void
类型声明
▸ (iconLoaders): void
参数
| 名称 | 类型 |
|---|---|
iconLoaders | IconLoader[] |
返回
void
定义在
packages/mermaid/src/mermaid.ts:439
registerLayoutLoaders
• registerLayoutLoaders: (loaders: LayoutLoaderDefinition[]) => void
类型声明
▸ (loaders): void
参数
| 名称 | 类型 |
|---|---|
loaders | LayoutLoaderDefinition[] |
返回
void
定义在
packages/mermaid/src/mermaid.ts:433
render
• render: (id: string, text: string, svgContainingElement?: Element) => Promise<RenderResult>
类型声明
▸ (id, text, svgContainingElement?): Promise<RenderResult>
参数
| 名称 | 类型 |
|---|---|
id | string |
text | string |
svgContainingElement? | Element |
返回
Promise<RenderResult>
定义在
packages/mermaid/src/mermaid.ts:427
run
• run: (options: RunOptions) => Promise<void>
类型声明
▸ (options?): Promise<void>
run
该函数遍历文档以查找其中的图表定义并渲染它们。
该函数使用属性数据 - 已处理标记已处理的属性，并忽略已经设置了该属性的已找到元素。这样，init 函数可以被多次触发。
渲染 Mermaid 图表
参数
| 名称 | 类型 | 描述 |
|---|---|---|
options | RunOptions | 可选运行时配置 |
返回
Promise<void>
定义在
packages/mermaid/src/mermaid.ts:432
setParseErrorHandler
• setParseErrorHandler: (parseErrorHandler: (err: any, hash: any) => void) => void
类型声明
▸ (parseErrorHandler): void
setParseErrorHandler 直接使用以下方法设置 parseError 的替代方法：
mermaid.parseError = function (err, hash) {
forExampleDisplayErrorInGui(err); // do something with the error
};这适用于 Mermaid 对象无法直接添加新成员的环境（例如 Dart 互操作包装器）。（最初，Mermaid 没有 parseError 成员）。
参数
| 名称 | 类型 | 描述 |
|---|---|---|
parseErrorHandler | (err: any, hash: any) => void | 新的 parseError() 回调。 |
返回
void
定义在
packages/mermaid/src/mermaid.ts:437
startOnLoad
• startOnLoad: boolean