跳到主要内容

Mermaid

规格​

标签值
版本0.1.0(更新于 2023-07-24)
开发者Labii Inc.
类型仪表板
支持配置是

概述​

Mermaid 仪表板小插件允许用户在 Labii 仪表板中创建并显示交互式流程图和其他图表。流程图编辑器基于 Mermaid;这是一个使用简单文本语法创建图表和流程图的 JavaScript 库。此小插件帮助个人和团队以清晰、有条理的仪表板形式直观呈现复杂流程、工作流程和关系。

使用场景​

  • 工作流程可视化:在团队仪表板中显示流程图谱和工作流程图。
  • 项目规划:以可视化形式展示项目步骤、依赖关系和决策点。
  • 决策支持:呈现运营工作流程中的分支逻辑、审批和结果。
  • 培训仪表板:通过易读图表说明操作程序和概念。
  • 跨团队沟通:与需要快速了解仪表板概况的用户共享可视化流程上下文。

配置​

初始设置​

进入要显示图表的仪表板。

单击 Add Widget,然后从仪表板小插件目录中选择 Mermaid。

输入用于定义图表结构、节点和连接关系的 Mermaid 语法。

查看渲染后的图表,并根据需要调整语法或样式选项。

单击 Save,将 Mermaid 图表发布到仪表板。

必填设置​

  • Mermaid syntax:用于生成图表或流程图的文本定义。

可选设置​

  • Styling options:在图表语法支持的情况下,自定义字体样式、颜色和形状。
  • Images and hyperlinks:在支持的情况下,为图表元素添加视觉或交互上下文。
  • Layout placement:调整小插件的大小和位置,确保图表在仪表板中清晰易读。
信息

如需在记录章节中创建图表,请使用章节小插件 Mermaid。

只读视图​

仪表板小插件用于在仪表板环境中快速查看信息并进行交互。

显示功能​

  • Rendered diagram:将 Mermaid 文本语法转换为可视化流程图或其他图表。
  • Customizable visuals:支持颜色、字体和形状等样式选项。
  • Dashboard context:使流程图可与相关仪表板小插件一起持续显示。
  • Interactive elements:配置后支持超链接和其他交互式图表元素。

交互功能​

  • Review diagrams:用户可以从仪表板查看渲染后的图表。
  • Open links:用户可以打开图表元素中包含的超链接。
  • Edit syntax:获得授权的用户可以通过小插件配置或编辑控件更新 Mermaid 语法。

最佳实践​

  • 确保仪表板图表重点明确,方便用户快速理解。
  • 为工作流程步骤、决策和结果使用描述清晰的节点标签。
  • 将 Mermaid 小插件放在相关报告、项目或工作流程小插件附近。
  • 将复杂图表发布到共享仪表板之前,先测试 Mermaid 语法。
  • 谨慎使用链接,确保交互元素有助于工作流程,而不会分散注意力。