序列圖

sequenceDiagram
  autonumber
  actor Shopper
  participant Web
  participant Orders
  Shopper->>+Web: 下單
  Web->>Orders: 建立訂單
  loop 每分鐘
    Orders-->>Orders: 檢查付款
  end
  Orders-->>Web: 完成
  Web-->>-Shopper: 確認信

timeline:
  enter Shopper-Web slide-left
  enter Web-Orders slide-left
  enter loop:1 fade, enter Orders-Orders fade, highlight loop:1 glow
  unhighlight loop:1, enter Orders-Web slide-right, enter Web-Shopper slide-right

參與者

參與者可以先宣告,也可以直接在訊息裡使用:和 Mermaid 一樣,沒宣告的參與者會在第一次被提到時自動建立。

寫法 說明
participant Web 方框
actor Shopper 小人圖示,固定 36px 寬;名稱較長時畫在下方,可以比圖示寬
participant A as 訂單服務 A 是 id,訂單服務 是畫出來的名稱
  • id 只能用英數字和 _。要顯示中文或有空白的名稱,請用 as。
  • 參與者依第一次出現(宣告或在訊息裡被提到)的順序由左到右排列。之後再寫 participant X as 名稱 只會設定名稱,不會移動位置。
  • 同一個 id 宣告兩次時保留第一次,並發出警告。

訊息

寫法是 起點箭頭終點: 文字。冒號一定要有,文字可以是空的。

箭頭 線 箭頭頭
->> 實線 實心箭頭
-->> 虛線 實心箭頭
-> 實線 無
--> 虛線 無
-x 實線 叉叉
--x 虛線 叉叉
-) 實線 開放箭頭(非同步)
--) 虛線 開放箭頭(非同步)
<<->> 實線 雙向
<<-->> 虛線 雙向

自己傳給自己也可以:Orders->>Orders: 重試。

啟用條(activation)

  • 簡寫:A->>+B: 呼叫 啟用接收端 B;B-->>-A: 回傳 結束發送端 B 的啟用。
  • 完整寫法:activate B、deactivate B。
  • 啟用可以疊好幾層。沒有啟用中卻寫 deactivate 會報錯,那一行會被略過。

Note

sequenceDiagram
  participant A
  participant B
  A->>B: ping
  note right of B: 收到
  note over A,B: 一來一回

note left of A: 文字、note right of A: 文字、note over A: 文字、note over A,B: 文字。

區塊

sequenceDiagram
  participant Client
  participant API
  alt 已登入
    Client->>API: 取得資料
  else 未登入
    Client->>API: 登入
  end
  par 同時
    API-->>Client: 資料
  and
    API-->>Client: 通知
  end
  rect rgba(99, 102, 241, 0.1)
    Client->>API: 背景同步
  end
區塊 寫法
迴圈 loop 條件 … end
可選 opt 條件 … end
中斷 break 條件 … end
分支 alt 條件 … else 條件 … end
平行 par 標籤 … and 標籤 … end
關鍵區段 critical 標籤 … option 標籤 … end
背景色 rect rgb(...) 或 rect rgba(...) … end
  • 區塊可以任意巢狀,缺少 end 會報錯。
  • rect 只接受 rgb() 和 rgba(),rect #hex 或 rect blue 會報錯。

其他語法

關鍵字不分大小寫,和 Mermaid 一樣:Note RIGHT OF A、Participant A AS Alice、Loop … End 都可以。

只有整行開頭是 %% 的那一行才是註解。行中間的 %% 是文字,和 Mermaid 一樣:A->>B: 50%% done 會畫出「50%% done」,participant A %% x 宣告的參與者就叫「A %% x」。標頭之後、end、autonumber 或 ; 之後的 %% 仍然是註解;activate/deactivate 指到不認識的參與者之後、rect 顏色之後,或緊貼在單一字母的名稱後面的 %% 會報錯。註解請獨立成一行。

寫法 說明
autonumber / autonumber off 幫訊息編號/停止編號。不支援起始值和間隔(autonumber 10 5)
box 顏色 標題 … end 把參與者框在一起。第一個字是顏色(#hex、rgb()、transparent 或 CSS 顏色名稱)時當成顏色,其餘當標題。裡面只能放 participant / actor 宣告
create participant X、create actor X 參與者從它的建立訊息才出現:也就是 create 之後的下一則訊息,而且必須是傳給 X 的。X 的方框畫在那則訊息的箭頭上,生命線從那裡開始。create 必須寫在第一次提到 X 之前;下一則訊息不是傳給 X 會報錯;兩者之間不能有別的東西(note、activate、autonumber、區塊邊界或另一個 create/destroy 都會報錯)。create 之後沒有訊息時什麼都不畫,並發出警告。被建立的參與者在最下面一排也會畫方框;create 之前已經畫了任何東西時,它的欄位會往右移半欄
destroy X 參與者的生命線在它的銷毀訊息結束:也就是 destroy 之後的下一則訊息,而且必須是 X 送出或收到的。X 的方框會在那則訊息的箭頭上再畫一次,生命線停在方框下方;之後的列會往下移。下一則訊息沒有提到 X 會報錯;兩者之間不能有別的東西;destroy 之後沒有訊息時什麼都不畫,並發出警告。destroy 不會建立其他地方沒提到的參與者
link A: 標籤 @ 網址 參與者方框變成連結。沒宣告的參與者會在 link 寫的位置建立
links A: {"標籤": "網址", ...} 用 JSON 一次給參與者加上多個連結
title 標題、title: 標題、accTitle: 標題 圖表標題;accTitle 只給螢幕閱讀器讀
accDescr: 文字、accDescr { ... } 螢幕閱讀器用的描述,單行或大括號區塊

Timeline 目標

元素 id 例子
參與者 宣告的 id(不是 as 後面的名稱) Web
訊息 起點-終點,重複的加 #2,跨所有區塊依原始碼順序計算 Web-Orders、Web-Orders#2
區塊 種類:N,每種區塊各自編號 loop:1、alt:1、opt:1、par:1、critical:1、break:1、rect:1
box box:N box:1
note note:N,依原始碼順序 note:1
啟用條 activation:N,依開啟的順序 activation:1
  • 參與者的上下方框、生命線和 destroy 畫的結束方框會一起動。
  • box 動畫只影響背景框,裡面的參與者要另外指定。
  • else、and、option 分出來的段落不能單獨指定。

尚未支援

語法 目前的行為
參與者 id 有空白或加引號 報錯,請用 participant A as 顯示名稱
participant A@{ "type": ... } 報錯
autonumber 10 5 報錯
properties、details 報錯