======Component Diagram======
To be able to generate those diagrams, you must have Graphviz_software
installed on your machine in the default directory c:\Program
Files\GraphvizX.XX or /usr/bin/dot.
You can have_a_look_here_if_you_have_installed_Graphviz_somewhere_else.
Let's have a fews examples :
======Components======
Components must be bracketed.
You can also use the component keyword to defines a component. And you can
define an alias, using the as keyword. This alias will be used latter, when
defining relations.
[First component]
[Another component] as Comp2
component Comp3
component [Last\ncomponent] as Comp4
======Interfaces======
Interface can be defined using the () symbol (because this looks like a
circle).
You can also use the interface keyword to defines an interface. And you can
define an alias, using the as keyword. This alias will be used latter, when
defining relations.
We will see latter that interface definition is optional.
() "First Interface"
() "Another interface" as Interf2
interface Interf3
interface "Last\ninterface" as Interf4
======Basic example======
Links between elements are made using combinations of dotted line (..),
straight line (--), and arrows (-->) symbols.
DataAccess - [First Component]
[First Component] ..> HTTP : use
======Using notes======
You can use the note left of , note right of , note top of , note bottom of
keywords to define notes related to a single object.
A note can be also define alone with the note keywords, then linked to other
objects using the .. symbol.
interface "Data Access" as DA
DA - [First Component]
[First Component] ..> HTTP : use
note left of HTTP : Web Service only
note right of [First Component]
A note can also
be on several lines
end note
======Grouping Components======
You can use several keywords to group components and interfaces together:
* package
* node
* folder
* frame
* cloud
* database
package "Some Group" {
HTTP - [First Component]
[Another Component]
}
node "Other Groups" {
FTP - [Second Component]
[First Component] --> FTP
}
cloud {
[Example 1]
}
database "MySql" {
folder "This is my folder" {
[Folder 3]
}
frame "Foo" {
[Frame 4]
}
}
[Another Component] --> [Example 1]
[Example 1] --> [Folder 3]
[Folder 3] --> [Frame 4]
======Changing arrows direction======
By default, links between classes have two dashes -- and are vertically
oriented. It is possible to use horizontal link by putting a single dash (or
dot) like this:
[Component] --> Interface1
[Component] -> Interface2
You can also change directions by reversing the link:
Interface1 <-- [Component]
Interface2 <- [Component]
It is also possible to change arrow direction by adding left, right, up or down
keywords inside the arrow:
[Component] -left-> left
[Component] -right-> right
[Component] -up-> up
[Component] -down-> down
You can shorten the arrow by using only the first character of the direction
(for example, -d- instead of -down-) or the two first characters (-do-).
Please note that you should not abuse this functionality : Graphviz gives
usually good results without tweaking.
======Title the diagram======
The title keywords is used to put a title.
You can use title and end title keywords for a longer title, as in sequence
diagrams.
title Very simple component\ndiagram
interface "Data Access" as DA
DA - [First Component]
[First Component] ..> HTTP : use
======Use UML2 notation======
The skinparam componentStyle uml2 command is used to switch to UML2 notation.
skinparam componentStyle uml2
interface "Data Access" as DA
DA - [First Component]
[First Component] ..> HTTP : use
======Skinparam======
You can use the skinparam command to change colors and fonts for the drawing.
You can use this command :
* In the diagram definition, like any other commands,
* In an included_file,
* In a configuration file, provided in the command_line or the ANT_task.
You can define specific color and fonts for stereotyped components and
interfaces.
skinparam component {
FontSize 13
InterfaceBackgroundColor RosyBrown
InterfaceBorderColor orange
BackgroundColor<> Red
BorderColor<> #FF6655
FontName Courier
BorderColor black
BackgroundColor gold
ArrowFontName Impact
ArrowColor #FF6655
ArrowFontColor #777777
}
() "Data Access" as DA
DA - [First Component]
[First Component] ..> () HTTP : use
HTTP - [Web Server] << Apache >>
[AA] <>
[BB] <>
[CC] <>
node node1
node node2 <>
database Production
skinparam component {
backgroundColor<> DarkKhaki
backgroundColor<> Green
}
skinparam node {
borderColor Green
backgroundColor Yellow
backgroundColor<> Magenta
}
skinparam databaseBackgroundColor Aqua