PlantUML - skinparam

PlantUML でのダイアグラムの見栄えを変更する skinparam について説明します。

@startuml{plantuml_skinparam_sample.png}

skinparam backgroundColor #EEEBDC

skinparam sequence {
	ArrowColor DeepSkyBlue
	ActorBorderColor DeepSkyBlue
	LifeLineBorderColor blue
	LifeLineBackgroundColor #A9DCDF
	
	ParticipantBorderColor DeepSkyBlue
	ParticipantBackgroundColor DodgerBlue
	ParticipantFontName Impact
	ParticipantFontSize 17
	ParticipantFontColor #A9DCDF
	
	ActorBackgroundColor aqua
	ActorFontColor DeepSkyBlue
	ActorFontSize 17
	ActorFontName Aapex
}

actor User
participant "First Class" as A
participant "Second Class" as B
participant "Last Class" as C

User -> A: DoWork
activate A

A -> B: Create Request
activate B

B -> C: DoWork
activate C
C --> B: WorkDone
destroy C

B --> A: Request Created
deactivate B

A --> User: Done
deactivate A

@enduml

使用法

skinparam を使うとダイアグラムで使われる色やフォントなどを変更することができます。
使用する場合はダイアグラムの記述内に以下のような形式で指定します。記述位置はどこでも構いません。

skinparam パラメーター名 値

パラメーター名はダイアグラム特有のものには先頭にダイアグラム名がついています。 それらをダイアログのブロックで指定することもできます。

skinparam dialogParam1 value1
skinparam dialogParam2 value2
skinparam dialogParam3 value3
skinparam dialogParam4 value4

skinparam dialog {
  Param1 value1
  Param2 value2
  Param3 value3
  Param4 value4
}

指定可能なパラメーター

変更可能なのはダイアログで使用している要素の色や フォントの色、サイズ、スタイル、フォント名です。
指定可能なパラメーターの一覧は PlantUML のページを参考にしてください。

• PlantUML

config ファイルの使用

コマンドライン での起動時に -config オプションでファイルを指定すると そのファイルの内容が各ダイアログの記述の先頭に挿入されます。
ここに skinparam で設定を書いておくことで、全ダイアログに設定を反映させることができます。

Doxygen, PlantUML 連携スクリプト で config ファイルを指定したい場合には、run_umldoxy.rb と同じフォルダーに以下の名前のファイルを置いておくと config ファイルとして使用します。

config.txt

(config ファイルの対応は後から追加したので、動かない場合はもう一度ダウンロードしてください)

よく使う設定

よく使いそうな設定をいくつか挙げておきます。

ちなみに私がよく使っている config ファイルは次のような内容です。

config.txt :

skinparam backgroundColor transparent
skinparam classAttributeIconSize 0
skinparam componentStyle uml2

背景色

ダイアログの背景色はデフォルトでは白です。 これを変更する場合は以下の記述を追加します。

skinparam backgroundColor 色指定

背景色に限り色指定で transparent(透明) が使えます。

クラス図で可視性のアイコンの非表示にする

クラス図では可視性を指定するとアイコンで表示されます。
これを skinparam でアイコンを使わないようにすることができます。

class Foo { -m_field #method1() ~method2() +method3() }	class Foo { skinparam classAttributeIconSize 0 -m_field #method1() ~method2() +method3() }

コンポーネント図での UML 2.0 スタイルの使用

コンポーネント図ではコンポーネントのスタイルが UML 2.0 から変更になりました。 2.0 スタイルを使用したい場合は skinparam で指定します。

[Sample Compornent]	skinparam componentStyle uml2 [Sample Compornent (UML 2.0)]

ユースケース図などでのパッケージスタイル

クラス図などで使われるパッケージはデフォルトがフォルダースタイルとなっています。
クラス図はこれでいいのですが、 ユースケース図などではスタイルを変更したいところです。 ステレオタイプで変更可能ですが、 skinparam でも変更できます。

skinparam packageStyle スタイル

指定するスタイルはクラス図の説明を参考にしてください。

• PlantUML - クラス図 #パッケージスタイル | プログラマーズ雑記帳

@startuml{plantuml_skinparam_package.png}
skinparam packageStyle rect

package システム {
    (Usecase)
}
@enduml

ただし、残念ながらパッケージスタイルの指定はダイアグラム別にはできないので、 config ファイルに記述することはできません。