スプライトの定義と使用
スプライトとは、図の中で使用できる小さい画像のことです。 PlantUMLでは、モノクロで4、8、16段階のグレースケールが使えます。 スプライトの定義は、ピクセルごとに0~Fの16進数を使用します。 その後、<$XXX>の形式でスプライトが使用できます。XXXはスプライトの名前が入ります。
where XXX is the name of the sprite.
WARNING
This translation need to be updated. WARNING
Inline SVG sprite
You can also use inlined SVG for sprites.
Only a tiny subset of SVG directives is possible, so you probably have to compress existing SVG files using https://vecta.io/nano. [Ref. GH-1066]
色の変更
スプライトはモノクロですが、色を変更することが可能です。
スプライトへの変換
次のコマンドで、スプライトをエンコードできます:
java -jar plantuml.jar -encodesprite 16z foo.png
foo.pngは使用したい画像です(自動的にグレースケールに変換されます)
-encodespriteに続けて、形式を指定します。
4、8、16、4z、8z、16zが使用可能です。
数値はグレースケールの段階数を表します。zを付けるとスプライトの定義を圧縮することができます。
スプライトをインポートする
GUIを起動して、既存の画像からスプライトを生成することもできます。
メニューバーのFile/Open Sprite Windowをクリックします。
クリップボードに画像をコピーすると、それに対応したスプライトの定義がいくつか表示されます。その中から必要なものを選択してください。
例
StdLib
PlantUML StdLibには、アーキテクチャ、クラウドサービス、ロゴなどの様々なIT関連のアイコンが含まれています。そこにはAWS、Azure、Kubernetes、C4、プロダクトロゴなどが含まれます。これらのライブラリを検索するには:
- PlantUML StdLibのGithubフォルダを参照する。
- 興味のあるStdLibコレクションのソースリポジトリを参照する。例えば、ロゴに興味がある場合、これはgilbarbara-plantuml-spritesから来ており、スプライトの一覧をすぐに見つけることができます。(次のセクションで示すスプライトの一覧表示は、残念ながらグレースケールとなりますが、この一覧では色が着いています。)
- Hitchhiker’s Guide to PlantUMLの詳細を読む。Standard Library SpritesやPlantUML Stdlib Overviewのセクションなど。
スプライトを一覧表示する
listspritesコマンドを使って、スプライトの一覧を表示できます:
- これ単体で使用すると、ArchiMateスプライトの一覧を表示します。
- 図中に何らかのスプライトライブラリをインクルードしている場合、このコマンドはそれらのスプライトの一覧を表示します。View all the icons with listspritesに説明があります。
allというファイルを含んでいて、コレクション全体を一度に見ることができます。
もしくは、必要なスプライトを一つずつ探してインクルードします。
残念ながら、StdLibに含まれるコレクションのバージョンにはallファイルが含まれていないものも多いので、上で見たようにStdLibからではなく、githubからインクルードしています。
スプライトはすべてグレースケールですが、ほとんどのコレクションには適切な色を含んだマクロが定義されています。
WARNING
This translation need to be updated. WARNING