Parameters
Macro specific parameters
Macro Editor Label | Default | Description | Macro Parameter |
---|---|---|---|
Direction of graph (rankdir) | LR | Sets the graphviz rankdir parameter
| direction |
Node parameters | Sets the graphviz node parameter. The default node attributes are taken from the default Flowchart macro behavior. By specifying the node parameter, you can override these defaults or add additional default attributes. See the Graphviz Documentation for information on attributes and settings. | node | |
Edge parameters | Sets the graphviz edge parameter. The default edge attributes are taken from the default Flowchart macro behavior. By specifying the edge parameter, you can override these defaults or add additional default attributes. See the Graphviz Documentation for information on attributes and settings. | edge | |
Replace variables | A comma separated list of key:value pairs that is used to convert column values to attributes. If a column value for an attribute column matches one of the keys, the associated value replaces the column value. This makes it easy to associate attributes to column data. If more than one attribute needs to be specified for a key, enclose the value in a single quote so that the comma gets treated as a attribute separator. | replace | |
Table ids or numbers to include | all | Comma separated list of table ids and/or table numbers contained within the body of the macro that is used as the data for the graph. | tables |
Column numbers to include | Allows selection of the columns of the table that is used for the graph. It must be a comma separated list of 1 or more positive integers in any order. The default value of blank represents columns=1,2,3,4,5,6,7,8,9. If the table does not contain the column indicated, it is ignored. For example, if columns=3,13 then column 3 is used for the source node and column 13 is used for the target node of the relationship. All other columns are ignored. | columns |
Removal notice
Please note that the URL user and URL user password parameters were removed (see Deprecation notice: URL user and URL user password parameters). We recommend using profiles to access external data.
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 |
Profile | Specifies the profile the macro uses to read data from an external application such as GitLab or GitHub. Profiles refer to common parameters, that administrators create and configure, to access data from external sources. Contact your administrator to know more about the profiles that are configured in your instance. Refer to the administrator guide to understand more about profiles. This parameter is not available in Graph from table and Space graph macros. | ||
Location of Graphviz source | Specifies the source from where the macro reads the data.
| 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. Useful when the Graphviz image must be uploaded as a new attachment or to update an existing attachment. 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 | Specifies 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 (Removed) | Specifies the user name for URL access via basic authentication. Removal notice Please note that the URL user and URL user password parameters were removed (see Deprecation notice: URL user and URL user password parameters). We recommend using profiles to access external data. | user | |
URL user password (Removed) | Specifies the user password for URL access via basic authentication. Removal notice Please note that the URL user and URL user password parameters were removed (see Deprecation notice: URL user and URL user password parameters). We recommend using profiles to access external data. | 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 |
Other Parameters
All other parameters are passed through to Graphviz for setting any global Graphviz parameter. Some common examples are:
- ranksep - Separation in inches between nodes.
- bgcolor - Background color.
- size - Size specified as width, height in inches. Example: size="3,5".
Usage
Simple
{graph-from-table} | A | B | | A | C | {graph-from-table}
Relationship and node attributes
Note that headings are ignored
{graph-from-table} || heading 1 ignored || heading 2 ignored || | A node | B node | label="relationship 1", style=dashed | style=normal | fillcolor=lightblue | | A node | C node | | A node | D node | style=invis | {graph-from-table}
Multiple tables and using parameters
{graph-from-table:node=fillcolor=lightblue,fontsize=20|edge=style=bold,color=red| replace=key1:'style=dashed, color=blue', key2:style=invis|ranksep=2.0} | A node | B node | | shape=polygon,sides=8,peripheries=3 | | | A node | B node | | style=dashed | | A node | C node | | A node | D node | key2 | Here is a second table | E | F | key1 | | F | G | key1 | {graph-from-table}
Subgraphs - clusters
{graph-from-table:direction=LR|ranksep=1.5|node=fillcolor=lightblue,fontsize=20| edge=style=bold,color=red|replace=key1:style=dashed} | A node | B node | label="r1" | | | 100 | key1 | | F | G | key1 | | | 100 | label="cluster 100" | | X | Y | key1 | | | 200 | label="cluster 200" | 2000 | label="cluster 2000" | {graph-from-table}
Using SQL
{graph-from-table:direction=LR|edge=color=blue|displayData=true} {sql:dataSource=ConfluenceDS} select PARENTID, TITLE from CONTENT where PARENTID is not NULL {sql} {graph-from-table}
Screenshots
There are no images attached to this page. |