The following parameters are available with all Graphviz macros:
Macro Editor Label | Default | Description | Macro Parameter |
---|---|---|---|
Output type | svg | Specifies the output type to be generated by Graphviz.
| output |
Location of Graphviz source | Specifies the source from where the macro reads the data.
Graphviz recognizes the commands only when you nest the commands under "noformat", or "code" macro, 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. 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. 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 with default size 128x128px.
| 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.
| macros |
Layout | dot | Specifies which default layout algorithm to use.
| layout |
URL to 'macro' file (macro ~ Graphviz/ Diagraph/ Graph) | Specifies the URL link to the Graphviz file. Administrators may restrict use.
| URL | |
URL user | The user name for URL access via basic authentication. | user | |
URL user password | User password for URL access via basic authentication. | password | |
URL connection timeout | Used to increase the wait time for URL access on slower connections. | timeout | |
File encoding | Allows the user to specify the encoding if it is different from the Confluence default (like Windows-1252, UTF-8, MacRoman). | encoding |
It is recommended to publish the page to view the changes made to any of the Graphviz macros. Your changes may not be reflected as expected when you preview the macro or page because the ability to preview the changes is not available currently.