Selector and formatting functions

You can use selector and formatting functions in the dynamic options syntax (DOS) to specify which aspects of the data you want to reflect in your visualizations.

Selector functions

Selector functions select the data of interest when configuring a dynamic option. The following are common selector functions.

Selector	Description
max()	Finds the global maximum value in the data series.
min()	Finds the global minimum value in the data series.
seriesByIndex(index)	Returns the data series at the given index. Index in this context refers to the numerical index as it relates to returned fields. For example, in a table of results, the first field is index = 0, the second field is index = 1, and the third field is index = 2.
seriesByName(field)	Finds series in the data source results by field name.
seriesByType(type)	Finds series in the data source by first data type match.
delta(index)	Finds the delta between the last point and the point at the given index. Index in this context refers to the numerical index. A negative index can be used, indicating an offset from the end of the sequence.
firstPoint()	Returns the first dataPoint in series.
lastPoint()	Returns the last dataPoint in series.

Formatting functions

Formatting functions transform and map the data into the desired format. The following are common formatting functions.

Formatter	Description	Context	Options
gradient()	Based on stops and colors, this formatter maps the value to an associated color.	"gradientConfig": { "stops": [0,100,230], "colors": ["red", "green", "blue"] }	"colorOption": "> primary | seriesByIndex(0) | gradient(gradientConfig)"
matchValue()	Maps each element in the data series to find a corresponding match value and returns the matched value if found, or the default value if present.	"colorMatches": [ { "match": "critical", "value": "red" }, { "match": "moderate", "value": "orange" }, { "match": "low", "value": "green" } ]	"colorOption": "> majorValue | matchValue(colorMatches)"
rangeValue()	Takes the list of ranges and a default value (if no range is found) and assigns a color value based on the threshold.	"colorThresholds": [ { "from": 1321, "value": "#FF0000" }, { "to": 1321, "value": "#00FF00" } ]	"colorOption": "> deltaValue | rangeValue(colorThresholds)"