Dynamic options syntax formatting functions
Dynamic options syntax (DOS) is the programming syntax used in Dashboard Studio for visualization options and dynamic menu options for inputs. You can use formatting functions in DOS to transform and map the data into a desired format. See Dynamic options in Dashboard Studio to learn more about dynamic options.
Dynamic options syntax structure
Dynamic Options Syntax (DOS) structure has several parts, each separated by a pipe ( | ).
DOS Part | What it does | Required? |
---|---|---|
Data Source | An originating data source, which can be a visualization data source such as a primary data source or visualization options such as sparklineValues. The location of your data sources, searches, and options for each search you create in the visual editor. | Yes |
Selector functions | Identifies the data from the data source associated with the visualization. A dynamic option can have one or multiple selector functions. | No |
Formatting function | Formats the selected data. | Optional unless additional data formatting is needed. |
A typical DOS structure looks like the following:
Option: "> [data source] | [selector functions] | [formatting function]"
Formatting functions
You can use formatting functions to configure your selected data.
formatByType()
Select Expand to see a description, an example, and an example result for the formatting function formatByType()
:
frame()
Select Expand to see a description, an example, and an example result for the formatting function frame()
:
gradient()
Select Expand to see a description, an example, and an example result for the formatting function gradient()
:
matchValue()
Select Expand to see a description, an example, and an example result for the formatting function matchValue()
:
multiFormat()
Select Expand to see a description, an example, and an example result for the formatting function multiFormat()
:
objects()
Select Expand to see a description, an example, and an example result for the formatting function objects()
:
pick()
Select Expand to see a description, an example, and an example result for the formatting function pick()
:
prefix()
Select Expand to see a description, an example, and an example result for the formatting function prefix()
:
prepend()
Select Expand to see a description, an example, and an example result for the formatting function prepend()
:
rangeValue()
Select Expand to see a description, an example, and an example result for the formatting function rangeValue()
:
type()
Select Expand to see a description, an example, and an example result for the formatting function type()
:
maxContrast()
Select Expand to see a description, an example, and an example result for the formatting function maxContrast()
:
setColorChannel()
Select Expand to see a description, an example, and an example result for the formatting function setColorChannel()
:
Dynamic options syntax selector functions | Default configuration options |
This documentation applies to the following versions of Splunk Cloud Platform™: 9.3.2411, 9.0.2305, 9.1.2308, 9.1.2312, 9.2.2403, 9.2.2406, 9.3.2408 (latest FedRAMP release)
Feedback submitted, thanks!