Custom visualizations in Simple XML
Include custom visualizations in Simple XML dashboards.
Guidelines
Add a custom visualization to a panel
Use the app name and visualization name for the <viz>
type value.
To add a custom visualization to a dashboard panel, indicate the visualization using the following syntax.
<viz type="[app_name.viz_name]"> ... </viz>
For example, add the sample_viz custom visualization to a dashboard panel.
<viz type="viz_sample_app.sample_viz"> ... </viz>
Configure visualization properties in Simple XML
Users can specify Simple XML option values for any visualization properties using this syntax:
<option name="[app].[visualization_name].[property_name]">[specified_value]</option>
For example, specify a maximum value for a custom visualization using this option. In this case, the app name is viz_sample_app and the visualization name is sample_viz.
<option name="viz_sample_app.sample_viz.maxValue">200</option>
Example Simple XML
This example shows how to include and configure a custom visualization in a Simple XML dashboard panel.
In this example, the custom visualization app name is viz_sample_app and the visualization name is sample_viz.
<dashboard> <label>Sample</label> <row> <panel> <viz type="viz_sample_app.sample_viz"> <search> <query>index=_internal | stats count</query> </search> <option name="viz_sample_app.sample_viz.maxValue">200</option> <option name="viz_sample_app.sample_viz.minValue">0</option> </viz> </panel> </row> </dashboard>
Design guidelines | Custom visualizations in SplunkJS |
This documentation applies to the following versions of Splunk® Enterprise: 7.0.0, 7.0.1, 7.0.2, 7.0.3, 7.0.4, 7.0.5, 7.0.6, 7.0.7, 7.0.8, 7.0.9, 7.0.10, 7.0.11, 7.0.13, 7.1.0, 7.1.1, 7.1.2, 7.1.3, 7.1.4, 7.1.5, 7.1.6, 7.1.7, 7.1.8, 7.1.9, 7.1.10, 7.2.0, 7.2.1, 7.2.2, 7.2.3, 7.2.4, 7.2.5, 7.2.6, 7.2.7, 7.2.8, 7.2.9, 7.2.10, 7.3.0, 7.3.1, 7.3.2, 7.3.3, 7.3.4, 7.3.5, 7.3.6, 7.3.7, 7.3.8, 7.3.9, 8.0.0, 8.0.1, 8.0.2, 8.0.3, 8.0.4, 8.0.5, 8.0.6, 8.0.7, 8.0.8, 8.0.9, 8.0.10, 8.1.1, 8.1.2, 8.1.3, 8.1.4, 8.1.5, 8.1.6, 8.1.7, 8.1.8, 8.1.9, 8.1.13, 8.1.14, 8.2.0, 8.2.1, 8.2.2, 8.2.3, 8.2.4, 8.2.5, 8.2.6, 8.2.7, 8.2.8, 8.2.9, 8.2.10, 8.2.11, 8.2.12, 9.0.0, 9.0.1, 9.0.2, 9.0.3, 9.0.4, 9.0.5, 9.0.6, 9.0.7, 9.0.8, 9.0.9, 9.0.10, 9.1.0, 9.1.1, 9.1.2, 9.1.3, 9.1.4, 9.1.5, 9.1.6, 9.2.0, 9.2.1, 9.2.2, 9.2.3, 9.3.0, 9.3.1, 8.1.0, 8.1.10, 8.1.11, 8.1.12
Feedback submitted, thanks!