
Simple XML for Sankey diagrams
Custom visualizations use a namespaced syntax for Simple XML. Specific visualization properties are appended to the app and visualization context.
Add a Sankey diagram to a dashboard panel
You can add a Sankey diagram to a dashboard panel using Simple XML. Use this syntax to specify the app and visualization context.
<viz type="sankey_diagram_app.sankey_diagram"> </viz>
Configure Sankey diagram properties
To configure a Sankey diagram property, add any of the following property names and a value to this syntax.
<option name= "sankey_diagram_app.sankey_diagram.[property_name]">[property_value] </option>
Option name | Accepted values | Default | Example |
---|---|---|---|
showLabels | [ true | false] | true | <option name="sankey_diagram_app.sankey_diagram.showLabels">false</option> |
showLegend | [ true | false] | true | <option name="sankey_diagram_app.sankey_diagram.showLegend">false</option> |
showTooltip | [ true | false] | true | <option name="sankey_diagram_app.sankey_diagram.showTooltip">false</option> |
useColors | [ true | false] | true | <option name="sankey_diagram_app.sankey_diagram.useColors">false</option> |
colorMode | [ categorical | sequential] | categorical | <option name="sankey_diagram_app.sankey_diagram.colorMode">categorical</option> |
minColor | Any valid CSS color string. | #d93f3c | <option name="sankey_diagram_app.sankey_diagram.minColor">#3fc77a</option> |
maxColor | Any valid CSS color string. | #3fc77a | <option name="sankey_diagram_app.sankey_diagram.maxColor">#6db7c5</option> |
numBins | Any number from 3-9 | 6 | <option name="sankey_diagram_app.sankey_diagram.numOfBins">5</option> |
showSelf | [ true | false] | false | <option name="sankey_diagram_app.sankey_diagram.showSelf">true</option> |
showBackwards | [ true | false] | false | <option name="sankey_diagram_app.sankey_diagram.showBackwards">true</option> |
styleBackwards | [ true | false] Use true for dashed backwards links. Use false for solid backwards links. |
false | <option name="sankey_diagram_app.sankey_diagram.styleBackwards">true</option> |
Example Simple XML source
Here is an example dashboard panel.
<dashboard> <label>Sankey Diagram Example</label> <row> <panel> <title>Sankey example dashboard</title> <viz type="sankey_diagram_app.sankey_diagram"> <search> <query>index=_internal sourcetype=splunk_web_access NOT uri_path=*/static/* uri_path=*/app/* OR uri_path=*/manager/* | rex field=referer "https?://.+?/.+?(?<referer_path>/[^\\?]+)" | rex field=uri_path "/.+?(?<path>/.+)" | rename referer_path as from path as to | stats count, avg(bytes) by from to</query> <earliest>@w0</earliest> <latest>now</latest> </search> <option name="sankey_diagram_app.sankey_diagram.showLabels">true</option> <option name="sankey_diagram_app.sankey_diagram.showLegend">true</option> <option name="sankey_diagram_app.sankey_diagram.showTooltip">true</option> <option name="sankey_diagram_app.sankey_diagram.useColors">true</option> <option name="sankey_diagram_app.sankey_diagram.colorMode">categorical</option> <option name="sankey_diagram_app.sankey_diagram.minColor">#ff0000</option> <option name="sankey_diagram_app.sankey_diagram.maxColor">#3fc77a</option> <option name="sankey_diagram_app.sankey_diagram.numOfBins">6</option> <option name="sankey_diagram_app.sankey_diagram.showSelf">true</option> <option name="sankey_diagram_app.sankey_diagram.showBackwards">true</option> <option name="sankey_diagram_app.sankey_diagram.styleBackwards">true</option> </viz> </panel> </row> </dashboard>
PREVIOUS Add a Sankey diagram to a dashboard |
NEXT Release notes |
This documentation applies to the following versions of Sankey Diagram: 1.0.0, 1.1.0, 1.2.0, 1.3.0, 1.5.0, 1.6.0
Feedback submitted, thanks!