Common parameters

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. png svg pdf jpg gif For PDF files, it is mandatory to fill in the field Attachment name in the format file_name.pdf.	output
Location of Graphviz source		Specifies the source from where the macro reads the data. blank - The body will be used. ^attachment - Data is read from an attachment to the current page. page^attachment - Data is read from an attachment to the page name provided. space:page^attachment - Data is read from an attachment to the page name provided in the space indicated. #filename - Data is read from the file located in the Confluence home directory/script/filename. Subdirectories can be specified. global page template name - Data is read from a global page template. space:page template name - Data is read from a space template. Nest the commands under "noformat", "wiki-markup", "code", or "code-pro" macros for the sources mentioned below: global page template name space:page template name	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: graphviz.png — the image is saved as an attachment to the current page. page^graphviz.png — the image is saved as an attachment to the page name provided. Space:page^graphviz.png — the image is saved as an attachment to the page name provided in the space indicated.	attachment
Attachment version	new	Specifies how the generated graph is persisted as an attachment. New — creates a new version of the attachment. Replace — replaces all previous versions of the attachment. To replace an existing attachment, the user must be authorized to remove attachments for the page specified. Keep — only saves a new attachment if there is no existing attachment. An existing attachment will not be changed or updated.	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. dot − filter for drawing directed graphs neato − filter for drawing undirected graphs twopi − filter for radial layouts of graphs circo − filter for a circular layout of graphs fdp − filter for drawing undirected graphs	layout
URL to 'macro' file (macro ~ Graphviz/ Diagraph/ Graph)		Specifies the URL link to the Graphviz file. Administrators may restrict use. Since 3.2. The URLs are restricted to the whitelisted URLs. This parameter is not available in Graph from table and Space graph macros.	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.