Splunk Cloud Platform

Splunk Dashboard Studio

Acrobat logo Download manual as PDF


This documentation does not apply to the most recent version of SplunkCloud. Click here for the latest version.
Acrobat logo Download topic as PDF

Add text and Markdown

You can add and customize text in your dashboard using the visual editor. To add a text box to a dashboard in the absolute layout, see Add a text box in the absolute layout. To add Markdown text to a dashboard in either the grid or absolute layout, see Add Markdown text.

Add a text box in the absolute layout

You can add a text box to your dashboard and choose from various font styles, sizes, and colors. This feature is only available if you are using the absolute layout.

Image of a text box with nodes for sizing and UI elements for layering, cloning, or deleting.

Select the visual editor's text box by clicking the Add Text button ( The 'Add Text button in the editing toolbar. ) in the editing toolbar.

Configuration panel options for text boxes

You can use the Configuration panel to configure the following text box components.

Position & Size
You can use either your mouse to change the size or location of the visualization, or the Position & Size section of the Configuration panel for pixel perfect sizing and placement.

Rotation
Use Degrees to rotate your text box. The default setting is zero. Higher positive values will rotate the text box clockwise. Higher negative values will rotate the box counterclockwise. The center of rotation is the top right of the text.

Font settings

  • Font
    Choose from the following font style options:
    • Splunk Platform Sans
    • Splunk Data Sans
    • Splunk Platform Mono
    • Arial
    • Helvetica
    • Times New Roman
    • Comic Sans MS
  • Font Size
    Choose the size of your font in pixels.
  • Text Color
    Choose your text color. You can choose from the preset palette by clicking the color box, or enter a hexadecimal code in the field provided. For example, enter #FFFF00 for bright yellow.
  • Weight
    Choose the thickness of your text.
    • Normal
    • Bold
    • Light

Background Color
Choose the background color for the text box. You can choose from the preset palette by clicking the color box, or enter a hexadecimal code in the field provided. For example, enter #FFFF00 for bright yellow.

Drilldown Settings
Specify a URL to go to when a user clicks the text box.

Code
Select your visualization or its search to view and edit the source code in real-time. You can also change the Visualization ID to a more readable ID to help identify this visualization in the source code.

Source options for text boxes


The following options are available for editing text in the source editor:

Property Type Default Description
fontFamily string Splunk Platform Sans Specify the font family. For example, Comic Sans MS. Note that the font needs to be available in your end user's environment.
fontSize number 24 Specify the font size in pixels.
fontWeight (normal | bold | light) normal Specify the font weight.
lineHeight (number | percent) 120% Specify the line height for the text block.
rotation number 0 Specify the text angle in degrees.
color string Specify the text color using a hex code. For example, "#FF0000".
backgroundColor string transparent Specify the background color using a hex code. For example, "#FF0000".
content string N/A Specify the text content.

Add Markdown text

You can add text to your dashboard using standard Markdown formatting. This feature is available for the grid and absolute layout. To add Markdown text, click the Add Markdown Text button (An uppercase letter M and an arrow pointing downward as an icon.) in the editing toolbar using the visual editor.

Configuration panel options for Markdown text

You can use the Configuration panel to configure the following Markdown components.

Position & Size
You can use either your mouse to change the size or location of the visualization, or the Position & Size section of the Configuration panel for pixel perfect sizing and placement.

Markdown settings
Edit Markdown text using the following buttons provided in visual editor:

  • Insert link (Link icon)
  • Insert blockquote (Blockquote icon)
  • Insert code (Code icon)
    • The code will format differently for a single line of code versus a multiple-line code block. A single line of code will format with a grey background that extends to the last bit of code. A large code block will have syntax highlighting, and the grey background extends to the edge of the markdown panel.
  • Insert image (Image icon)
  • Insert unordered list (Unordered list icon)
  • Insert ordered list (Ordered list icon)
  • Insert heading (Heading icon)
    • Headings sizes correlate to the number of hashtags before the heading. For example, #heading is the largest font size, and ##heading is one size smaller than the largest.
  • Bold text (Bold icon)
  • Italicize text (Italicize icon)

You can also include standard Markdown formatting beyond what is provided in the visual editor. Select Preview to view the text as it will appear in the dashboard. Select Write to continue editing. Make sure to Save your changes.

General

  • Font Color - Specify the text color using hexadecimal codes or RGBA values, such as "#FF0000" or "rgba(25,12,13,0.1)".
  • Background Color - Specify the background color using a hexadecimal code such as "#FF0000".

Code
Select your visualization or its search to view and edit the source code in real-time. You can also change the Visualization ID to a more readable ID to help identify this visualization in the source code.

Source options for Markdown text


The following options are available for editing Markdown text in the source editor:

Property Type Default Description
markdown string n/a Add text using basic markdown syntax.
backgroundColor string transparent Specify the background color using a hexadecimal code such as "#FF0000".
fontColor string > themes.defaultFontColor Specify the text color using hexadecimal codes or RGBA values, such as "#FF0000" or "rgba(25,12,13,0.1)". The default for enterprise light is "#3c444d". The default for enterprise dark is "#FFFFFF". The default for prisma dark is "rgba(255, 255, 255, 0.7)".
Last modified on 24 March, 2022
PREVIOUS
Add a custom icon
  NEXT
Generate a choropleth map

This documentation applies to the following versions of Splunk Cloud Platform: 8.2.2109, 8.2.2111, 8.2.2112


Was this documentation topic helpful?


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