Scalable Vector Graphics

ScalableVector Graphics (SVG) es un formato gráfico conocido por su escalabilidad, que garantiza que sus diagramas mantengan su calidad en cualquier nivel de zoom, proporcionando un resultado de impresión óptimo. En esta guía, profundizamos en cómo puede habilitar la generación de SVG con PlantUML, explorando varias configuraciones y directivas que mejoran su salida SVG.

PlantUML ofrece múltiples vías para habilitar la generación de SVG, cada una de ellas adaptada a diferentes entornos. A continuación, describimos los métodos disponibles:

Línea de comandos

Utilice la bandera -tsvg con la línea de comandos de PlantUML para habilitar la generación SVG. Obtenga más información en nuestra guía de línea de comandos.

Tarea Ant

Incorpore la configuración format="svg" en su definición de tarea Ant para facilitar la generación de SVG. Encontrará instrucciones detalladas en nuestra guía de tareas Ant.

<target name="main">
  <plantuml dir="./src" format="svg" />
</target>

Java

También puede generar SVG directamente desde Java. Descubra cómo configurarlo en nuestra guía de la API de Java.

Specific Skin Parameters for SVG

Enhance your SVG diagrams with specific skin parameters that allow you to customize various aspects of the output. Here we delve into some of the parameters you can use:

svgLinkTarget

The svgLinkTarget setting allows you to modify the target attribute in the hyperlinks generated in the SVG output, thereby controlling how the links will open when clicked.

Referencing the HTML specification, you have the following options:
  • _blank: Opens the link in a new window or tab
  • _parent: Opens the link in the parent frame
  • _self: Opens the link in the same frame where it was clicked (default setting)
  • _top: Opens the link in the full body of the window

The default setting is _top, applied when the svgLinkTarget is left empty.

pathHoverColor

Utilize the skinparam pathHoverColor setting to specify a color that will be applied to links when hovered over with the mouse pointer, enhancing user interaction with your diagrams.

@startuml
skinparam pathHoverColor green
class Foo2 [[http://www.yahoo.com/Foo2]] {
  +double[] x
  +double y
}
Foo2 --> Foo3
@enduml

[Reference: QA-5453]

svgDimensionStyle

If you prefer not to include the style, width, and height attributes in the SVG output header, set the skinparam svgDimensionStyle to false. This gives you cleaner output, focusing solely on the essential elements of your diagram.

@startuml
skinparam svgDimensionStyle false

component a {
}
component b {
}
a -(0- b
@enduml

[Reference QA-7334]

Specifying Pragma for SVGs

Leverage the svgSize pragma directive to define custom sizes for specific SVG elements in your PlantUML diagrams.

Using the svgSize Pragma Directive

The !pragma svgSize <U+hhhhh> XX directive informs PlantUML to assume the size of the <U+hhhhh> element to be equivalent to the 'XX' value specified.

Here are different ways you can use this directive to obtain the ideal setting:

  • !pragma svgSize <U+hhhhh> XX
  • !pragma svgSize <U+hhhhh> I

Example Usage

Below is an example PlantUML code utilizing the svgSize directive:

@startuml
!pragma svgSize <U+1F610> XX

test: text <U+1F610>
test_size45: text <size:45><U+1F610>
@enduml

Command-Line Options

You can specify the svgSize pragma using the -P option on the command-line. Remember to:

  • Enclose the argument in quotes, especially when it contains spaces.
  • Use this option multiple times in a single command, if necessary.

Example

java -jar plantuml.jar "-PsvgSize=<U+1F610> XX" "-PsvgSize=<U+1F611> I"

References


Privacy Policy      Advertise