- 真野隼記
- 約 2,600 文字
- 600 View
目次
はじめに
Markdownでプロジェクトの進捗報告やチームの振り返り資料をまとめていると、定量的な部分にはグラフを入れたくなります。Excelなど外部ツールでグラフを作成して画像を挿入しても良いですが、画像ファイルの管理がちと面倒です。
Mermaid.js はUMLを描けることで有名ですが、実はいくつかのグラフ表示もサポートされています。どうせあまりオシャレじゃないんでしょう?..と、あまり期待していなかったのですが、想定よりオシャレ化ができることが分かったので、この感動を伝えさせてください。
もちろん、見た目や構成ではいくつか制約があります。それさえ許容できれば、テキストでグラフを記述でき、VS Codeなどでのプレビュー以外にも、GitHub・GitLab・Notionなど多くのプラットフォームでプレビューできますし、何よりAIからの支援も受けやすくなりお勧めです。
試してみたナレッジをいくつか紹介します。
環境
- Mermaid.js v11+(
radar-beta、xychart-betaが利用可能) - 表示確認: VS Code(Markdown Preview Mermaid Support拡張)、GitHub
レーダーチャート
2025年3月にリリースされたv11.6からレーダーチャートが利用可能になりました。ドキュメントもあります。レーダーチャートは、多軸の評価結果を一目で比較したいといった用途に便利ですよね。
Tips 1: レーダーチャートの装飾
例えば、チームの「開発チーム成熟度」を複数の観点で評価し、2つのチームの強みを重ねて比較してみます。
このとき、以下の設定がおすすめです。デフォルトでもそこそこオシャレですが、細かい調整をしたくなります。
graticule polygonを指定して目盛線を多角形にする- デフォルトの曲線もオシャレだが、言いたいことが伝わりにくい…
- 絶対評価の基準となる
max(満点)とmin(最低点)を指定する- 指定しない場合は、入力から自動で補正するが揃えた方が無難
curveのラベルにチーム名だけでなく、括弧書きで「平均スコア」等のサマリを埋め込んで凡例とする- テキストでの追加情報は、ラベルに足すしかない
- デフォルトの配色を変えたい場合、configで変更可能
-cScale0/cScale1で1番目、2版目のレーダーの色を調整。curveOpacityで透過度を指定する。
--- |
棒グラフ
Tips 2: 積み上げグラフの実現
xychart-betaは ネイティブの積上げ棒グラフをサポートしていません。複数のbarシリーズを定義すると、並列ではなく重ね描画されます。
例として、機能別・優先度別の残タスク数を可視化したいとします。
| 検索機能 | 決済機能 | ユーザー管理 | |
|---|---|---|---|
| 優先度:高 | 0 | 2 | 0 |
| 優先度:中 | 2 | 4 | 3 |
| 優先度:低 | 4 | 0 | 1 |
| 合計 | 6 | 6 | 4 |
素朴にそのまま書くと、本来「6」「6」「4」の高さになるはずの棒グラフが、ただ同じ位置から重ねて描画されてしまい、意味不明な状態になります(積み上げグラフになっているじゃん…と思いますが、高さをよく見ると合計値に達していません)。
xychart-beta |
3本のグラフが重なっていますが、逆手にとって考えると、累積値で、擬似的に積上げ棒グラフにできるということです。悪い回避策だという指摘はいったん脇に..。
棒グラフは “最後”に書いた定義が “手前” に表示されます。そのため、一番最初に積み上げたい「低」を最初に書いて、「高」を最後に書きます。
こうすると、「中」の棒は「低」の棒の「内側」に重なり、「高」の棒はさらにその内側に重なります。結果として色が層になり、積上げに見えるわけです。
xychart-beta |
積み上げは成功しましたが、0件である「高」が微妙に表示されてしまいノイジーです(0なのにわずかに表示されてしまってます)。いろいろ試したのですが、配列の中間の0は -1 に置換することで回避可能です。末尾の記述も-1にするか省略で回避できました。-1 にしておくことで、グラフ上にはレンダリングされませんが、「データが存在する」という判定になるため、色の割当順序が正しく維持されるため、都合が良いです。
xychart-beta |
Tips 3: 色の指定は plotColorPalette と凡例
さきほど、積み上げ棒グラフ化には成功しましたが、優先度が高い順に、目立たせたいと思うはずです。疑似積上げでは「外側ほど薄く、内側ほど濃く」するのが自然です。「高」を最も濃い色にすると、対応すべきタスクが視覚的に目立ちます。棒グラフの色はplotColorPaletteで指定します。シリーズの定義順(barの記述順)に対応します。
色を付けると、色の意味は何だ?となりますが、xychart-betaには凡例機能はありません(!)。そのため、Markdownが許容する環境であれば、Mermaidブロックのすぐ下にHTML書いてしまうのがてっとり早い回避手段です。
--- |
HTMMLは以下のようなものを、mermaid.jsのすぐ下にそのまま配置します。
<div style="display: flex; justify-content: center; gap: 24px; font-size: 14px; color: #424242; font-family: sans-serif; margin-top: -8px;"> |
ポイントは、薄い色(優先度「低」)の凡例の四角(■)に text-shadow: 0 0 1px #ccc; を付けて輪郭線を出すことです。これにより、白背景でも凡例の視認性をしっかり確保できます。
Tips 4: Before/Afterの表示
xychart-betaはグループ化(横並べ)ができません。そのため、リファクタリング前(Before)と後(After)のバグ発生数を比較したい場合などは、グラフを2つ並べます。
ポイントはY軸の上限を揃えること(0 --> 80)です。これにより、棒の長さだけで直感的に「改善したかどうか」を比較できるようになります。
おわりに
Mermaid.jsは「テキストで書ける手軽さ」が最大の強みですが、積上げ棒グラフや凡例、スライスの順序制御といった実務で欲しい機能に一部制約があります。
しかし、今回紹介した疑似積上げ・-1置換・HTML凡例・上下2段比較といったテクニックを使えば、これらの制約を回避して、メンテナンス性の高い「それっぽい」レポートをMarkdown内で完結させることができます。
特にAIツールとの相性は抜群です。「このタスクデータをMermaidの疑似積上げ棒グラフにして」と頼めば、累積値の計算からコード生成まで一瞬で終わります。ぜひ、日々の進捗報告や振り返り資料に取り入れてみてください。