Images generation
<image> tag must be defined under a <gendoc> tag.
It shall define one of the following attributes:
The drawing are correspond to the entire text box:
<context
model='D:/…/myModel.uml'/> <gendoc>
|
[for (p:Package | Package.allInstances())] |
<image … /> |
</for>
|
|
Customize image size
<image> tag provides the following attributes to
handle image size customization: keepW, keepH, maxW, maxH. They are used
in association with the dimensions of the drawing area inside
<image> tag:
- keepW: output image width will be the same as drawing
area width
- keepH: output image height will be the same as
drawing area height
- maxW: output image width will not oversize drawing
area width
- maxH: output image height will not oversize drawing
area height
Possible values for these attributes: false(default),
true.
For the following initial image:

- Fix image width, height is computed proportionally, the image overlap
partially the next boxes.
Template content
|
Output
|
<gendoc> |
<image object='…' keepW=‘true’
keepH=‘false’/> |
</gendoc> |
|
|
|
- Fix image height, width is computed proportionally
Template content
|
Output
|
<gendoc> |
<image object='…' keepW=‘false’
keepH=‘true’/> |
</gendoc> |
|
|
|
- TO BE AVOIDED : Fix image height and width
Template content
|
Output
|
<gendoc> |
<image object='…' keepW=‘true’
keepH=‘true’/> |
</gendoc> |
|
|
|
- Ensure the image will not oversize a specified width
- Case 1 : Image is smaller than the drawing area
Output corresponds to origin image dimensions, and the picture may
overlap with the following rows.
Template content
|
Output
|
<gendoc> |
<image object='…' maxW=‘true’/> |
</gendoc> |
|
|
|
- Case 2 : Image is larger than the drawing area
Output corresponds to drawing area dimension:
Template content
|
Output
|
<gendoc> |
<image object='…' maxW=‘true’/> |
</gendoc> |
|
|
|
- Ensure the image will not oversize a specified height
- Case 1 : Image is smaller than the drawing area
Output corresponds to origin image dimensions
Template content
|
Output
|
<gendoc> |
<image object='…' maxH=‘true’/> |
</gendoc> |
|
|
|
- Case 2 : Image is larger than the drawing area
Output corresponds to drawing area dimension:
Template content
|
Output
|
<gendoc> |
<image object='…' maxH=‘true’/> |
</gendoc> |
|
|
|
Displaying diagrams
Attribute object shall be filled by an ID
of the diagram. Diagram ID can be generated by service
getDiagram from bundle gmf, called on the diagram:
Template content
|
<context model='${model}'
importedBundles='gmf;papyrus'/>
<gendoc>
[for (diag : Diagram|
self.getPapyrusDiagrams()] |
<image
object='[diag.getDiagram()/]' maxW='true'
keepH='false'/> |
[/for]
</gendoc> |
|
|
Displaying static images
<image> tag can also be used for static
image generation, with the following content:
- attribute filePath shall contain the
absolute path of the static image.
The following image formats are supported : GIF, JPG, JPEG, BMP, PNG,
SVG
- <image> tag shall contain an empty
drawing area (alignment, text adaptation, …)
- size attributes can be used : keepW, keepH, maxW, maxH
The following example shows the display of a static image:
Template content
|
Output
|
<context
model='${model_path}'/>
<gendoc>
Project logo is displayed below : |
<image
filePath='D:/gendoc_logo.jpg' maxW='true'/> |
[/for]
</gendoc> |
|
|
Project logo is displayed
below :
|
 |
[/for]
</gendoc> |
|
|