Splunk® Enterprise

Developing Views and Apps for Splunk Web

Download manual as PDF

Download topic as PDF

Customize dashboard styling and behavior

Customize dashboard appearance and behavior using custom .css and .js files. You can customize a specific dashboard within an app or all dashboards in a particular app.

Including custom JavaScript files can cause dashboard rendering issues. You might see a warning about custom scripts when you open a dashboard in Edit mode.

Customize styling and behavior for one dashboard

Create custom files

To customize a specific dashboard, start by creating one or more .css or .js files to define styling and behavior.

Depending on the app to which the dashboard belongs, place these files in the app's appserver/static directory, located here.

$SPLUNK_HOME/etc/apps/<app_name>/appserver/static

For example, to customize styling and behavior for a dashboard in Search and Reporting, use this directory path.

$SPLUNK_HOME/etc/apps/search/appserver/static

Add custom files to the dashboard

When custom files are in the app's appserver/static directory, add them to the dashboard. Use the following syntax.

<dashboard stylesheet="<style_filename>.css" script="<script_filename>.js">


You can use several custom files for a dashboard. For multiple .css or .js files, use the following syntax.

<dashboard stylesheet="<style_filename1>.css, <style_filename2>.css" script="<script_filename1>.js, <script_filename2>.js">

Note: Forms have the <form> root element in Simple XML instead of <dashboard>. Use <form stylesheet="..."> if you are adding a custom file to a form.

Add custom files from a different app to a dashboard

You can add custom files from one app's appserver/static directory to another app's dashboard. Use this syntax to indicate the other app context for custom files.

<dashboard stylesheet="<app_name>:<style_filename>.css" script="<app_name>:<script_filename>.js">

For example, to refer to files located in the Search and Reporting app context, use this syntax.

<dashboard stylesheet="search:my_custom_styles.css" script="search:my_custom_script.js">

Note: Ensure that custom files exist in the indicated app's appserver/static directory. Dependency checking and warning messages are not supported when files are not found.

Customize styling and behavior for all dashboards in an app

Dashboards automatically load dashboard.js and dashboard.css from the appserver/static directory. To customize styling and behavior for all dashboards in an app, create one or both of the following files.

  • dashboard.js
  • dashboard.css

Place the files in the following directory.
$SPLUNK_HOME/etc/apps/<app_name>/appserver/static



Last modified on 24 August, 2018
PREVIOUS
Customize the login page
  NEXT
UI internationalization

This documentation applies to the following versions of Splunk® Enterprise: 6.5.0, 6.5.1, 6.5.2, 6.5.3, 6.5.4, 6.5.5, 6.5.6, 6.5.7, 6.5.8, 6.5.9, 6.5.10, 6.6.0, 6.6.1, 6.6.2, 6.6.3, 6.6.4, 6.6.5, 6.6.6, 6.6.7, 6.6.8, 6.6.9, 6.6.10, 6.6.11, 6.6.12, 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, 8.0.0, 8.0.1, 8.0.3, 8.0.2, 8.0.4, 8.0.5, 8.0.6


Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters