The following parameters are available with all Graphviz macros:
Macro Editor Label | Default | Description | Macro Parameter |
---|---|---|---|
Template | Templates are used to get quickly started with creating diagrams. Pick a template to initialize a diagram, from which, you can make further changes. Since 3.2. You can only choose a template for a new diagram for the type of Graphviz macro you are using. If the macro contains a diagram, the Template list is hidden. | template | |
Output type | png | Specifies the output type to be generated by Graphviz. Since 2.1.0.
For PDF files, it is recommended that you fill in the field Attachment name in the format file_name.pdf. Not doing so will give you a blank output. | output |
Location of Graphviz source | Specifies the source from where the macro reads the data.
It is recommended that you nest the commands under "noformat", "wiki-markup", "code", or "code-pro" macros for Graphviz to recognize the commands for the sources mentioned below:
| script | |
Show Graphviz markup code | False | Shows the Graphviz markup code below the generated graph. Useful for fixing syntax errors or to see the markup that is generated by macro processing or macros like the Space graph macro. | showCode |
Attachment name | The name of the attachment to use, create or update. Use of attachments is optional but can be useful for linking from other places and to work with the Cache Macro to improve display performance. Examples:
| attachment | |
Attachment version | new | Specifies how the generated graph is persisted as an attachment.
| attachmentVersion |
Attachment comment | The comment on the attachment that is created or updated. | attachmentComment | |
Attachment versions to keep | Limits the number of attachment versions of a file that is attached to a page. If the maximum number of attachments exceeds the limit, then the oldest version is deleted. Since version 3.2. This parameter is only applicable if you select New from the drop-down list under Attachment version, in the macro editor. | attachment limit | |
Thumbnail | False | Used when an attachment is specified, and output is png, jpg, or gif. Renders graph as a thumbnail.
| thumbnail |
Render wiki markup macros in body | False | Set to true to render wiki markup macros found in the body before processing as Graphviz markup. This is useful to run macros from Scripting for Confluence or similar that can produce Graphviz markup as output. Since 3.2. This parameter is not available in Graph from table and Space graph macros. | macros |
Layout | dot | Specifies which default layout algorithm to use. Since 3.2.
| layout |
URL to 'macro' file (macro ~ Graphviz/ Diagraph/ Graph) | Specifies the URL link to the Graphviz file. Administrators may restrict use. Since 3.2.
| URL | |
URL user | The user name for URL access via basic authentication. Since 3.2. | user | |
URL user password | User password for URL access via basic authentication. Since 3.2. | password | |
URL connection timeout | Used to increase the wait time for URL access on slower connections. Since 3.2. | timeout | |
File encoding | Allows the user to specify the encoding if it is different from the Confluence default (like Windows-1252, UTF-8, MacRoman). Since 3.2. | encoding |
For multiple macro sources (i.e. template, attachment, and URL), the order of precedence is URL > attachment > template.