PlantUMLで独自の画像を表示する

できること

好きな画像をダイアグラム内に表示させることができる。

参考

https://plantuml.com/ja/sprite

手順

1. 画像を用意
2. 変換ツールをダウンロード
3. 画像をスプライトに変換し、 .puml として保存
4. PlantUMLで使う

画像の用意

こちらを使う

サイズが大きいとPlantUMLのプレビューで表示されない可能性があるため、小さくしておく。

画像サイズ：530x723

変換ツールをダウンロード

こちらからダウンロード

https://plantuml.com/ja/download

2023.08.30現在のバージョン

実行にはjavaが必要なため、入っていなければインストールする。

https://www.java.com/ja/download/help/download_options_ja.html

画像をスプライトに変換

実行時のディレクトリは下記の通り

任意のフォルダ/
　plantuml.1.2023.10.jar  ←ダウンロードしたツール
  image.png  ←変換したい画像

変換コマンドを実行する。実行すると結果がコンソールに出力されるので、ファイルに書き込む。

java -jar .\plantuml-1.2023.10.jar -encodesprite 16z .\code_of_perfume.png > code_of_perfume.puml

-encodesprite オプションでは以下が使用可能

• 4, 8, 16, 4z, 8z, 16z

数値はグレースケールの段階数を表し、 z をつけるとスプライトの定義を圧縮できる。

参考：段階数の違い

変換したファイルの1行目を確認

sprite $code_of_perfume [530x723/16z] {
...

$code_of_perfume がこのスプライトの変数名のようなもの。

表示

ディレクトリ構成：

任意のフォルダ/
 code_of_perfume.puml  ←スプライト変換したファイル
 demo.pu  ←表示用

demo.pu の中身：

@startuml
!includeurl ./code_of_perfume.puml
rectangle "<$code_of_perfume>\nCODE OF PERFUME" as perfume
@enduml

表示できた。