メインコンテンツへスキップ

PlantUML プレビュー

PlantUML の文から、シーケンス図・アクティビティ図・クラス図・ER 図などをその場で描く無料ツール。

PlantUML プレビュー

PlantUML の公式のエンジンをブラウザの中で動かすので、Java を入れる必要はなく、書いた文を外のサーバーに送りません。SVG と PNG で保存できます。

左の欄に PlantUML の文を書くと、手を止めたところで右に図を描きます。

サンプルから、シーケンス図・アクティビティ図・クラス図・ユースケース図・状態遷移図・ER 図・ガントチャート・マインドマップ・JSON の図を選べます。

書き間違いがあるときは、何行目かとその行を表示します。

PlantUML プレビューの機能と特徴

PlantUML とは

PlantUML は、文字で書いた文から UML などの図を作るオープンソースのソフトウェアです。2009年から Arnaud Roques さんが中心になって作っています。

図を文で書くので、Git で変更の差分を見たり、レビューしたりできます。線や箱の位置は PlantUML が自動で決めます。

このツールのサンプルにある9種類のほか、コンポーネント図・配置図・タイミング図などの UML の図や、WBS などの図も描けます。

書き方は、PlantUML の公式の説明に日本語のページがあります(例: シーケンス図)。

Mermaid との違いと使い分け

Mermaid も、文から図を描く仕組みです。大きな違いは、GitHub で表示できるかどうかです。

  • GitHub の Markdown は、Mermaid をそのまま図にして表示します。GitHub の説明では、表示できるのは Mermaid・GeoJSON・TopoJSON・ASCII STL の4つで、PlantUML は入っていません。
  • PlantUML は UML の図の種類が多く、見た目を細かく決める設定(skinparam)もあります。

GitHub などの Markdown にそのまま書いて見せたいときは Mermaid、UML をきちんと描きたいときや、すでに PlantUML で書いた図があるときは PlantUML、と使い分けるとよいです。

Mermaid の図は Mermaid プレビュー で描けます。

VS Code や公式のサーバーとの違い

VS Code の拡張機能(PlantUML)で手元で描くには、Java が要ります。Mac などでは Graphviz も入れます(Windows では拡張機能に入っています)。入れずに使うときは、PlantUML のサーバーに描かせる設定にします。

公式のサーバー(PlantUML Web Server)は、書いた文を圧縮して URL に入れ、サーバーで図にします。

このツールは、PlantUML の公式がブラウザ用に出しているエンジン(@plantuml/core)を、このサイトから配って動かしています。図の配置に使う Graphviz もその中に入っているので、何も入れずに使えて、書いた文はブラウザの外に出ません。

よく使う書き方(シーケンス図)

シーケンス図でよく使う書き方です。サンプルの「シーケンス図」にも入れてあります。

書き方意味
@startuml 〜 @enduml図の始まりと終わり(このツールでは省いても描けます)
A -> B : 文A から B への矢印(実線)
A --> B : 文点線の矢印(返事などに使います)
note right of A : 文A の右にメモを付ける
alt 条件 〜 else 〜 end条件で分かれる流れ
loop 条件 〜 endくり返し
' 文コメント(図には出ません)

このツールで使えないもの

図の中身を外に出さないため、外から何かを読み込む機能は使えないようにしています。使ったときは、何行目かを表示します。

  • C4・AWS などの部品集(!include <C4/C4_Context> など)
  • 別のファイルやほかのサイトから読み込む書き方(!include・!import・!theme … from)
  • 絵文字(<:smile:> など)

ブラウザ用のエンジンにない図も描けません。書いたときは、描けないことを表示します。

  • ditaa(@startditaa)や Graphviz の DOT(@startdot)など
  • 数式(@startmath・@startlatex)。図の中の <math>・<latex> は、式にならずに文のまま出ます

縦か横が 32,768px を超える大きな図も描けません。図をいくつかに分けてください。

<img:https://…> のように外の画像を入れても、画像は表示されません。

@startuml が2つ以上あるときは、最初の図だけを描きます。

色の組み合わせを変える !theme と、アイコン(<&account-login> など)は使えます。どちらもこのサイトから読み込みます。

PlantUML プレビューに関するよくある質問

保存した SVG に、元の文は入りますか?

入りません。PlantUML はふつう、作った SVG の中に元の文を圧縮して埋め込みます。図に出ないコメントの行も含まれます。

このツールでは、それを取り除いてから表示と保存をしています。図を人に渡しても、コメントまで渡ることはありません。

保存した SVG を別のパソコンで開くと、文字がずれます

PlantUML の SVG は、文字に「sans-serif」(その環境のゴシック体)を指定していて、文字の幅は図を描いたときのブラウザのフォントで決まります。フォントの違う環境で開くと、文字が枠からはみ出すことがあります。

どこでも同じ見た目にしたいときは、「PNG で保存」を使ってください。PNG は2倍の大きさで作ります(とても大きな図は、ブラウザの上限に収まるように小さくします)。

作った図は、仕事の資料や公開するページに使えますか?

PlantUML のライセンスの文では、PlantUML で作った図(PNG・SVG など)は、元の文を書いた人のものとされています。PlantUML で作ったと書く必要もない、とあります。

ただし、元の文がほかのライセンスにしたがうものなら、図も同じライセンスにしたがいます。

GitHub の README に PlantUML の図を載せるには?

GitHub の Markdown は PlantUML を図にしないので、このツールで SVG か PNG にして、画像として載せます。

Markdown の中に文のまま書いて図にしたいときは、Mermaid で書く方法があります。Mermaid プレビュー で試せます。

書いた文は保存されますか?

このブラウザの中(localStorage)に自動で残るので、次に開いたときも続きから書けます。別のブラウザや端末には引き継がれません。

消すときは「クリア」を押します。

PlantUML プレビューの使い方

  1. サンプルを選ぶか、文を書く

    上の「サンプル」から図の種類を選ぶか、左の欄に PlantUML の文を書きます。

  2. 図を確かめる

    書く手を止めると、右に図が出ます。書き間違いがあるときは、何行目かとその行を表示します。横に広い図は、図の下の「等倍」を押すと、縮めずに表示します。

  3. SVG か PNG で保存する

    「SVG で保存」か「PNG で保存」で保存します。「SVG をコピー」で、SVG のコードをそのままコピーすることもできます。

カテゴリ デザイン