The following parameters are available with all Graphviz macros:
Macro editor label | Default | Description | Macro parameter |
---|---|---|---|
Template | Enables users to pick a pre-configured template and make simple changes as per their requirement. Since 3.2.
| template | |
Output type | png | Specifies the output type to be generated by Graphviz. Since 2.1.0.
| output |
Location of <type> source (Where 'type' includes Graphviz/ UML) | Specifies the source from where the macro reads the data.
Graphviz recognizes the commands only when you nest the commands under "noformat", "wiki-markup", "code", or "code-pro" macros, for the sources mentioned below:
| script | |
Show <type> markup code (Where 'type' includes Graphviz/ UML) | False | Shows the markup code, Graphviz or UML, 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 | Specify 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 | Specify 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. | attachmentLimit | |
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 | Used 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 the Graph from table and Space graph macros. | macros |
Layout | dot | Specifies which default layout algorithm to use. Since 3.2.
This parameter is not available in the PlantUML macro. | layout |
URL to <macro> file (Where 'macro' includes Graphviz/ Diagraph/ Graph/ PlantUML) | Specifies the URL link to the Graphviz file. Administrators may restrict use. Since 3.2.
| URL | |
URL user | Specify the user name to access the specified URL via basic authentication. Since 3.2. | user | |
URL user password | Specify the user password to access the specified URL via basic authentication. Since 3.2. | password | |
URL connection timeout | Specify the time in milliseconds used to increase the wait time to access the specified URL on slower connections. Since 3.2. | timeout | |
File encoding | Specify the encoding of the file attachment 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.