Developing Views and Apps for Splunk Web

Chart and legend properties

This section covers properties for chart and legend, two of the more commonly modified flash charting elements.

Chart

Usage: charting.chart.*

Use chart to define properties specific to the type of chart being displayed. For an overview of charts and other visualization options, see the Visualization Reference. For more information about the data structures required by the various visualizations, see Data structure requirements for visualizations.

Note: All charts have data and legend properties. There are properties that are specific to single axis charts, and properties that are specific to charts with two axes. See the table below for details.

Values

The chart object has 12 possible values:

• area
• bar
• bubble
• column
• fillerGauge
• histogram
• line
• markerGauge
• pie
• radialGauge
• rangeMarker
• ratioBar
• scatter
• valueMarker

See the table below for detail on the parameters available for each chart type.

Example 1 - Forcing categories for a column chart

<option name="charting.chart">column</option>
<option name="charting.chart.useAbsoluteSpacing">true</option>
<option name="charting.chart.columnSpacing">5</option>
<option name="charting.axisX.categories">[pine,beech,mahogany,white,black]</option>

This example sets up a column chart with five preset categories to plot on the x-axis, and a space of five pixels between each column (useAbsoluteSpacing = true ensures that the columnSpacing values are measured in terms of pixels).

Example 2 - Changing colors and color order in a gauge

With gauge charts there are certain customizations that you can only make by editing the dashboard panel XML. This example shows how to pick the colors for a gauge and the order in which they display. It uses the parameter to indicate the style of the parameter, specifying minimal. The default style is shiny.

Note: When you specify range values in the xml, they override range values that are specified through the search upon which the dashboard panel is based.

<param name="charting.chart">radialGauge</param>
<param name="charting.chart.style">minimal</param>
<param name="charting.chart.rangeValues">[0,30,70,100]</param>
<param name="charting.gaugeColors">[0xBF3030,0xFFE800,0x84E900]</param>

This example reverses the order of the colors, specifying the order as red-yellow-green.

You can specify any number of colors with gaugeColors. If a gauge has more or less range intervals than the number of colors you specify, the gauge interpolates the colors as necessary.

Also used by

• layout.charts.

Enables you to specify chart layouts. See "Advanced configuration - Layout and data table properties" for more information.

Properties for all charts

All charts All chart types inherit properties from layoutSprite and have the following additional properties (see the tables above for full definitions).
Property name	Value type	Definition	Default	Supported by JSChart?
data	dataTable	Affects the form of the data table that Splunk uses to plot the chart.	See the data table for specific defaults.	Yes
legend	legend	Affects the display of the legend for the chart.	See the legend table for specific defaults.	Yes (see the legend table for details)

Properties for all single axis charts

All single axis charts The following property is applicable only to single axis chart types, such as such as range marker and value marker charts.
Property name	Value type	Definition	Default	Supported by JSChart?
axis	axis	Properties that affect the axis on which report data is plotted.	See the axis tables for specific defaults.	Some axis properties are unsupported. (See the axis tables for details.)

Properties for all dual axis charts

All dual axis charts The following properties are applicable only to dual axis chart types, such as bar, column, area, line, and scatter charts.
Property name	Value type	Definition	Default	Supported by JSChart?
axisX	axis	Properties that affect the x-axis upon which data is plotted. The x-axis is horizontal.	See the axis tables for specific defaults.	Some axis properties are unsupported. (See the axis tables for details.)
axisY	axis	Properties that affect the y-axis upon which data is plotted. The y-axis is vertical.	See the axis tables for specific defaults.	Some axis properties are unsupported. (See the axis tables for details.)
resultTruncationLimit	number	For performance reasons, the charting libraries used by Splunk have rendering limits if the total number of objects plotted in a chart exceed a certain number. This property overrides the automatic limits.	The default used depends on your browser and the chart type being used. If your browser is IE 8 or less, the default value is 1000 objects. If you're using a different browser, the default is 1200 for column and bar charts and 2000 for line and area charts.	Note: Only applies to charts rendered with JSChart. Charts rendered in Flash will always have a 2000 object limit.

Area chart properties

Area chart properties The following properties are applicable only to area charts. The area chart is a dual axis chart that renders each series in a data set as a filled area with an optional line. The data table upon which the chart is structured must contain at least two columns, where the first column contains the values to be plotted on the x-axis (such as _time values for a timechart) and each additional column contains a series of values to be plotted on the y-axis.
Property name	Value type	Definition	Default	Supported by JSChart?
areaBrushPalette	brushPalette	Indicates the brush palette used for painting the filled areas in area charts. Reference an existing palette with the @ symbol: @mybrushpalette.	See the brushPalette table for specific defaults.	No
areaStyle	style<sprite>	Indicates the properties to apply to area sprites in area charts.	See the sprite table for specific defaults.	No
lineBrushPalette	brushPalette	Indicates the brush palette to use for painting lines in area charts. Reference an existing palette with the @ symbol: @mybrushpalette.	See the brushPalette table for specific defaults.	No
lineStyle	style<sprite>	The properties to apply to line sprites in area charts.	See the sprite table for specific defaults.	No
showLines	boolean	Indicates whether or not lines should be painted in area charts.	true	Yes
stackMode	string	Used to set up stacked area charts. Valid values are default, stacked, stacked100.	default	Yes
nullValueMode	string	Determines how the area chart handles null values. Valid values are gaps, zero, and connect.	gaps	Yes

Bar chart properties

Bar chart properties The following properties are applicable only to bar charts. The bar chart is a dual axis chart that renders data as horizontal bars. The data set must contain at least two columns, where the first column contains the values to be plotted on the y-axis and each additional column contains a series of values to be plotted on the x-axis.
Property name	Value type	Definition	Default	Supported by JSChart?
barBrushPalette	brushPalette	Indicates he brush palette used for painting the bars in bar charts. Reference an existing palette with the @ symbol: @mybrushpalette.	See the brushPalette table for specific defaults.	No
barShapePalette	shapePalette	Indicates the shape palette that defines the shapes of bars in bar charts. Reference an existing palette with the @ symbol: @myshapepalette.	See the shapePalette table for specific defaults.	No
barStyle	style<sprite>	The properties to apply to bar sprites in bar charts.	See the sprite table for specific defaults.	No
barAlignment	number	Controls the alignment of bars relative to their position on the y axis. Typical values are between 0 (top aligned) and 1 (bottom aligned).	0.5 (a middle alignment)	No
barSpacing	number	Controls the spacing between bars in a bar chart. Whether this property is measured in pixels or is relative to the bar heights depends on the setting of useAbsoluteSpacing (below).	1.	Yes
seriesSpacing	number	Controls the spacing between clustered series in a bar chart when stackMode = default. Whether this property is measured in pixels or is relative to the bar heights depends on the setting of useAbsoluteSpacing (below).	0	Yes
useAbsoluteSpacing	boolean	Determines whether the values of barSpacing and seriesSpacing are pixels (true) or relative to the bar heights (false)	false	No
stackMode	string	Sets up stacked bar charts. Valid values are default, stacked, and stacked100.	default	Yes

Bubble chart properties

Bubble chart properties The following properties are applicable only to bubble charts. The bubble chart is a dual axis chart that renders data as scattered "bubbles" whose size is determined by a third dimension of data. There are two possible forms for the data set upon which the chart is based: 1. A single series structure that contains 3 columns. The first column (column 0) contains the values to be plotted on the x-axis. The second column (column 1) contains the values to be plotted on the y-axis. And the third column (column 2) contains the values to be plotted on the z-axis. 2. A multiple series structure with 4 columns. Column 0 contains the series names, and the next 3 columns contain the values to be plotted on each axis (as in the first form, above).
Property name	Value type	Definition	Default	Supported by JSChart?
axisZ	axis	A third axis used for plotting the bubble values.	See the axis table for specific defaults.	No
bubbleBrushPalette	brushPalette	Indicates the brush palette used for painting the bubbles in bubble charts. Reference an existing palette with the @ symbol: @mybrushpalette.	See the brushPalette table for specific defaults.	No
bubbleShapePalette	shapePalette	Indicates the shape palette that defines the shapes of bubbles in bubble charts. Reference an existing palette with the @ symbol: @myshapepalette.	See the shapePalette table for specific defaults.	No
bubbleStyle	style<sprite>	The properties to apply to bubble sprites in bubble charts.	See the sprite table for specific defaults.	No
bubbleMinimumSize	number	The minimum size of bubbles in pixels.	10	No
bubbleMaximumSize	number	The maximum size of bubbles in pixels.	50	No
defaultSeriesName	string	The series name to use for indexing into palettes and legends when only 3 columns are present in the data.	bubble	No

Column chart properties

Column chart properties The following properties are applicable only to column charts. The column chart is a dual axis chart that renders data as vertical columns. The data table upon which the chart is structured must contain at least two columns, where the first column contains the values to be plotted on the x-axis, and each additional column contains a series of values to be plotted on the y-axis.
Property name	Value type	Definition	Default	Supported by JSChart?
columnBrushPalette	brushPalette	Indicates the brush palette used for painting the columns in column charts. Reference an existing palette with the @ symbol: @mybrushpalette.	See the brushPalette table for specific defaults.	No
columnShapePalette	shapePalette	Indicates the shape palette that defines the shapes of columns in column charts. Reference an existing palette with the @ symbol: @myshapepalette.	See the shapePalette table for specific defaults.	No
columnStyle	style<sprite>	The properties to apply to column sprites in column charts.	See the sprite table for specific defaults.	No
columnAlignment	number	The alignment of columns relative to their position on the x-axis. Typical values are between 0 (left aligned) and 1 (right aligned).	0.5 (a centered alignment)	No
columnSpacing	number	Controls the spacing between columns in a column chart	1	Yes
seriesSpacing	number	Controls the spacing between clustered series in a column chart when stackMode = default	0	Yes
useAbsoluteSpacing	boolean	Determines whether the values of columnSpacing and seriesSpacing are pixels (true) or relative to the column heights (false)	false	No
stackMode	string	Sets up stacked column charts. Valid values are default, stacked, and stacked100.	default	Yes

Filler gauge properties

Filler gauge properties The following properties are applicable only to fillerGauge charts. The filler gauge, like the other gauge chart types, enables the visualization of a single numerical value mapped against a range of colors that may have particular business meaning or logic. The filler gauge is similar in appearance to a thermometer, with a liquid-like filler indicator that changes color as it rises or lowers and passes range boundaries. The gauge range can be provided in the search or hardcoded using the rangeValues property (which overrides any range values present in the data). At least two range values are required to define a minimum and maximum range; additional values can be supplied to define intervals between the minimum and maximum. By default Splunk assigns colors to each defined interval within the range; the filler gauge takes on the color of the interval that the gauge value belongs to. For more information about filler gauges, see Single-value visualizations.
Property name	Value type	Definition	Default	Supported by JSChart?
orientation	string	Sets the gauge orientation. Valid values are x (horizontal) and y (vertical).	y	Yes
style	string	Enables the choice between two basic gauge appearances. The shiny style is a graphically stylized version of the gauge with with chrome, shading, and so on so that it mimics those in the real world. The minimal style is a stripped-down "just the basics" version of the gauge.	shiny	Yes
fillerBrushPalette	brushPalette	Indicates the brush palette to use for drawing the variable colored fill within the indicator. If null, a solid black fill is drawn. Reference an existing palette with the @ symbol: @myfillerbrushpalette.	See the brushPalette table for specific defaults.	No
fillerStyle	style<sprite>	The style to apply to the filler.	See the sprite table for specific defaults.	No
fillerPlacement1	number	The starting placement of the filler indicator, in pixels centered around the orientation axis.	-20	No
fillerPlacement2	number	The ending placement of the filler indicator, in pixels centered around the orientation axis.	20	No
rangeValues	array<number>	A numeric array that represents the overall numerical range represented by the gauge, and the relative size of the color-coded subranges within that overall range. For example, a range of [0,30,70,100] would indicate that the gauge starts at zero, ends at 100, and has three subranges that are each identified by another filler color. If the search returns a value of 71, the filler rises to that value on the gauge and takes on the color assigned to the top range (71-100). Note: When you specify range values in the xml, they override range values that are specified through the search upon which the dashboard panel is based.	Not assigned.	Yes
rangePadding	Number	The padding to place on either end of the range, in pixels.	20	No
gaugeColors	array<number>	A list of hexadecimal color values from which the range band colors are generated. Colors display in the order indicated in the array. For example, you can reverse the default green-yellow-red sequence by changing the gaugeColors value to [0xBF3030,0xFFE800,0x84E900]. You can specify any number of colors. If your gauge has more or less range intervals (either specified via the search language or the rangeValues parameter) than the number of rangeColors, Splunk will interpolate the colors as necessary.	[0x84E900,0xFFE800,0xBF3030]	Yes
majorTickBrush	brush	The brush that is used to draw the major tick marks.	See the brush table for specific defaults.	No
majorTickStyle	style<sprite>	Indicates the style properties that are applied to major tick marks.	See the sprite table for specific defaults.	No
majorTickPlacement1	number	The starting placement of the major tick marks, in pixels centered around the orientation axis.	20	No
majorTickPlacement2	number	The ending placement of the major tick marks, in pixels centered around the orientation axis.	40	No
majorUnit	number	The spacing at which major tick marks are placed.	auto	Yes
minorTickBrush	brush	The brush that draws the minor tick marks.	See the brush table for specific defaults.	No
minorTickStyle	style<sprite>	The style properties that are applied to minor ticks.	See the sprite table for specific defaults.	No
minorTickPlacement1	number	The starting placement of the minor tick marks, in pixels centered around the orientation axis.	20	No
minorTickPlacement2	number	The ending placement of the minor tick marks, in pixels centered around the orientation axis.	30	No
minorUnit	number	The spacing at which minor tick marks are placed.	auto	No
labelStyle	style<textBlock>	The style properties to apply to tick labels.	See the textBlock table for specific defaults.	No
labelPlacement	number	The placement of the tick labels, in pixels centered around the orientation axis.	40	No
valueStyle	style<textBlock>	Provides the style properties for the value at the bottom of the gauge. Note that valueStyle can be used to change the way the value displays (font, bolding, italicization, and so on.), but it can't be used to actually change the text itself. For example, you can't use valueStyle to replace the value with a specific text string.	See the textBlock table for specific defaults.	No
valuePlacement	number	The placement of the value, in pixels centered around the orientation axis.	-20	No
warningBrush	brush	The brush to use when drawing the warning indicator.	See the brush table for specific defaults.	No
warningShape	shape	The shape to use when drawing the warning indicator.	See the shape table for specific defaults.	No
warningStyle	style<sprite>	The style properties to apply to the warning indicator.	See the sprite table for specific defaults.	No
warningPlacement	number	The placement of the warning indicator, in pixels centered around the orientation axis.	70	No
warningSize	number	The size of the warning indicator, in pixels.	20	No
foregroundBrush	brush	The brush to use for drawing the gauge foreground.	See the brush table for specific defaults.	No
foregroundStyle	style<sprite>	The style properties to apply to the gauge foreground.	See the sprite table for specific defaults.	No
foregroundPlacement1	number	The starting placement of the gauge foreground, in pixels around the orientation axis.	-20	No
foregroundPlacement2	number	The ending placement of the gauge foreground, in pixels around the orientation axis.	20	No
foregroundPadding	number	The padding to place on either end of the gauge foreground, in pixels.	20	No
backgroundBrush	brush	The brush to use for drawing the gauge background.	See the brush table for specific defaults.	No
backgroundStyle	style<sprite>	The style properties to apply to the gauge background.	See the sprite table for specific defaults.	No
backgroundPlacement1	number	The starting placement of the gauge background, in pixels around the orientation axis.	-20	No
backgroundPlacement2	number	The ending placement of the gauge background, in pixels around the orientation axis.	20	No
backgroundPadding	number	The padding to place on either end of the gauge background, in pixels.	20	No
layers	array<string>	The layering order of the visual elements that make up the filler gauge. The elements are presented as a list; the element order determines how the elements are layered on top of one another (first on bottom, last on top). Elements not specified in this list remain in their default order below all the specified elements.	[ background, minorTicks, majorTicks, labels, warning, filler, value, foreground ]	No
usePercentageRange	boolean	Determines whether the range values should be formatted as percentages.	false	Yes
usePercentageValue	boolean	Determines whether to format the gauge value as a percentage.	false	Yes
showMajorTicks	boolean	Determines whether the gauge should display major tick marks.	true	Yes
showMinorTicks	boolean	Determines whether the gauge should display minor tick marks.	true	Yes
showLabels	boolean	Determines whether the gauge should display labels.	true	Yes
showValue	boolean	Determines whether the gauge should show its value.	true	Yes

Histogram properties

Histogram properties The following properties are applicable only to histogram charts. The histogram chart is a dual axis chart that renders data as vertical columns whose width is determined by separate start and end values. The data table upon which the chart is structured must contain at least three columns, where column 0 contains the starting values to be plotted on the x-axis, column 1 contains the ending values to be plotted on the x-axis, and column 2 contains the values to be plotted on the y-axis. Multiple series are currently unsupported and additional columns are ignored.
Property name	Value type	Definition	Default	Supported by JSChart?
columnBrushPalette	brushPalette	Indicates the brush palette used for painting the columns in histogram charts. Reference an existing palette with the @ symbol: @mybrushpalette.	See the brushPalette table for specific defaults.	No
columnShapePalette	shapePalette	Indicates the shape palette that defines the shapes of columns in histogram charts. Reference an existing palette with the @ symbol: @myshapepalette.	See the shapePalette for specific defaults.	No
columnStyle	style<sprite>	The properties to apply to column sprites in histogram charts.	See the sprite table for specific defaults.	No

Line chart properties

Line chart properties The following properties are applicable only to line charts. The line chart is a dual axis chart that renders each series in a data set as a line with optional markers. The data table upon which the chart is structured must contain at least two columns, where the first column contains the values to be plotted on the x-axis (such as _time values for a timechart) and each additional column contains a series of values to be plotted on the y-axis.
Property name	Value type	Definition	Default	Supported by JSChart?
lineBrushPalette	brushPalette	The brush palette to use for painting lines in line charts.	See the brushPalette table for specific defaults.	No
lineStyle	style<sprite>	The properties to apply to line sprites in line charts.	See the sprite table for specific defaults.	No
markerBrushPalette	brushPalette	Indicates the brush palette to use for painting markers in line charts. Reference an existing palette with the @ symbol: @mybrushpalette.	See the brushPalette table for specific defaults.	No
markerShapePalette	shapePalette	Indicates the shape palette that defines the shape of markers in line charts. Reference an existing palette with the @ symbol: @myshapepalette.	See the shapePalette table for specific defaults.	No
markerStyle	style<sprite>	The properties to apply to marker sprites in line charts.	See the sprite table for specific defaults.	No
showMarkers	boolean	Indicates whether or not markers should be painted in line charts.	false	Yes
stackMode	string	Used to set up stacked line charts. Valid values are default, stacked, stacked100.	default	Yes
nullValueMode	string	Determines how the line chart handles null values. Valid values are gaps, zero, and connect.	gaps	Yes

Marker gauge properties

Marker gauge properties The following properties are applicable only to markerGauge charts. The marker gauge, like the other gauge chart types, enables the visualization of a single numerical value mapped against a range of colors that may have particular business meaning or logic. The marker gauge is similar in appearance to a slide rule, with a linear range scale and a sliding marker that rests at the value returned by the search. The gauge range can be provided in the search language or hardcoded using the rangeValues property (which overrides any range values present in the search language). At least two range values are required to define a minimum and maximum range; additional values can be supplied to define intervals between the minimum and maximum. By default Splunk assigns colors to each defined interval within the range. A band running in parallel with the range maps these colors to specific sections of the range. For more information about marker gauges, see Single-value visualizations.
Property name	Value type	Definition	Default	Supported by JSChart?
orientation	string	Sets the gauge orientation. Valid values are x (horizontal) and y (vertical).	y	Yes
style	string	Enables the choice between two basic gauge appearances. The shiny style is a graphically stylized version of the gauge with with chrome, shading, and so on so that it mimics those in the real world. The minimal style is a stripped-down "just the basics" version of the gauge.	shiny	Yes
markerBrush	brush	The brush to use for drawing the gauge marker.	See the brush table for specific defaults.	No
markerShape	shape	The shape to use when drawing the gauge marker.	See the shape table for specific defaults.	No
markerStyle	style<sprite>	The properties to apply to the gauge marker.	See the sprite table for specific defaults.	No
markerPlacement1	number	The placement of the base of the gauge marker, in pixels centered around the orientation axis.	-20	No
markerPlacement2	number	The placement of the tip of the gauge marker, in pixels centered around the orientation axis.	20	No
markerThickness	number	The thickness of the gauge marker, in pixels.	5	No
rangeValues	array<number>	A numeric array that represents the overall numerical range represented by the gauge, and the relative size of the color-coded subranges within that overall range. For example, a range of [0,30,70,100] would indicate that the gauge starts at zero, ends at 100, and has three subranges that are each identified by a different color on the range band. If the search returns a value of 71, the gauge marker moves to the spot where 71 would be on the gauge, and where the range band has the color assigned to the middle range (61-85). Note: When you specify range values in the xml, they override range values that are specified through the search upon which the dashboard panel is based.	Not assigned.	Yes
rangePadding	Number	The padding to place on either end of the range, in pixels.	20	No
gaugeColors	array<number>	A list of hexadecimal color values from which the range band colors are generated. Colors display in the order indicated in the array. For example, you can reverse the default green-yellow-red sequence by changing the gaugeColors value to [0xBF3030,0xFFE800,0x84E900]. You can specify any number of colors. If your gauge has more or less range intervals (either specified via the search language or the rangeValues parameter) than the number of rangeColors, Splunk will interpolate the colors as necessary.	[0x84E900,0xFFE800,0xBF3030]	Yes
rangeBandBrushPalette	brushPalette	Indicates the brush palette to use for drawing the variable colored range band. Reference an existing palette with the @ symbol: @mybrushpalette.	See the brushPalette table for specific defaults.	No
rangeBandStyle	style<sprite>	The style properties to apply to the variable colored range band.	See the sprite table for specific defaults.	No
rangeBandPlacement1	number	The placement of the first edge of the variable colored range band, in pixels centered around the orientation axis.	-20	No
rangeBandPlacement2	number	The placement of the second edge of the variable colored range band, in pixels centered around the orientation axis.	20	No
majorTickBrush	brush	The brush that is used to draw the major tick marks.	See the brush table for specific defaults.	No
majorTickStyle	style<sprite>	Indicates the style properties that are applied to major tick marks.	See the sprite table for specific defaults.	No
majorTickPlacement1	number	The starting placement of the major tick marks, in pixels centered around the orientation axis.	20	No
majorTickPlacement2	number	The ending placement of the major tick marks, in pixels centered around the orientation axis.	40	No
majorUnit	number	The spacing at which to place major tick marks.	auto	Yes
minorTickBrush	brush	The brush that is used to draw the minor tick marks.	See the brush table for specific defaults.	No
minorTickStyle	style<sprite>	Indicates the style properties that are applied to minor tick marks.	See the sprite table for specific defaults.	No
minorTickPlacement1	number	The starting placement of the minor tick marks, in pixels centered around the orientation axis.	20	No
minorTickPlacement2	number	The ending placement of the minor tick marks, in pixels centered around the orientation axis.	30	No
minorUnit	number	The spacing at which to place minor tick marks.	auto	No
labelStyle	style<textBlock>	The style properties to apply to tick labels.	See the textBlock table for specific defaults.	No
labelPlacement	number	The placement of the tick labels, in pixels centered around the orientation axis.	40	No
valueStyle	style<textBlock>	Provides the style properties for the value at the bottom of the gauge. Note that valueStyle can be used to change the way the value displays (font, bolding, italicization, and so on.), but it can't be used to actually change the text itself. For example, you can't use valueStyle to replace the value with a specific text string.	See the textBlock table for specific defaults.	No
valuePlacement	number	The placement of the value, in pixels centered around the orientation axis.	-20	No
warningBrush	brush	The brush to use when drawing the warning indicator.	See the brush table for specific defaults.	No
warningShape	shape	The shape to use when drawing the warning indicator.	See the shape table for specific defaults.	No
warningStyle	style<sprite>	The style properties to apply to the warning indicator.	See the sprite table for specific defaults.	No
warningPlacement	number	The placement of the warning indicator, in pixels centered around the orientation axis.	70	No
warningSize	number	The size of the warning indicator, in pixels.	20	No
foregroundBrush	brush	The brush to use for drawing the gauge foreground.	See the brush table for specific defaults.	No
foregroundStyle	style<sprite>	The style properties to apply to the gauge foreground.	See the sprite table for specific defaults.	No
foregroundPlacement1	number	The starting placement of the gauge foreground, in pixels around the orientation axis.	-20	No
foregroundPlacement2	number	The ending placement of the gauge foreground, in pixels around the orientation axis.	20	No
foregroundPadding	number	The padding to place on either end of the gauge foreground, in pixels.	20	No
backgroundBrush	brush	The brush to use for drawing the gauge background.	See the brush table for specific defaults.	No
backgroundStyle	style<sprite>	The style properties to apply to the gauge background.	See the sprite table for specific defaults.	No
backgroundPlacement1	number	The starting placement of the gauge background, in pixels around the orientation axis.	-20	No
backgroundPlacement2	number	The ending placement of the gauge background, in pixels around the orientation axis.	20	No
backgroundPadding	number	The padding to place on either end of the gauge background, in pixels.	20	No
layers	array<string>	The layering order of the visual elements that make up the filler gauge. The elements are presented as a list; the element order determines how the elements are layered on top of one another (first on bottom, last on top). Elements not specified in this list remain in their default order below all the specified elements.	[ background, rangeBand, minorTicks, majorTicks, labels, warning, marker, value, foreground ]	No
usePercentageRange	boolean	Determines whether the range values should be formatted as percentages.	false	Yes
usePercentageValue	boolean	Determines whether to format the gauge value as a percentage.	false	Yes
showRangeBand	boolean	Determines whether the gauge should display the variable colored range band.	true	Yes
showMajorTicks	boolean	Determines whether the gauge should display major tick marks.	true	Yes
showMinorTicks	boolean	Determines whether the gauge should display minor tick marks.	true	Yes
showLabels	boolean	Determines whether the gauge should display labels.	true	Yes
showValue	boolean	Determines whether the gauge should show its value.	true	Yes

Pie chart properties

Pie chart properties The following properties are applicable only to pie charts. The pie chart is a basic chart that renders data as a circle divided into "slices." The data table upon which the chart is structured must contain at least two columns, where the first column contains the labels for each pie chart slice, and the second column contains the values for those slices. Splunk pie charts do not currently support multiple series, and additional columns are not supported.
Property name	Value type	Definition	Default	Supported by JSChart?
sliceBrushPalette	brushPalette	The brush palette to use for painting slices in pie charts. Reference an existing palette with the @ symbol: @mybrushpalette.	See the brushPalette table for specific defaults.	No
sliceStyle	style<sprite>	The properties to apply to slice sprites in line charts.	See the sprite table for specific defaults.	No
sliceCollapsingThreshold	number	The threshold at which smaller slices should be collapsed into a consolidated slice. Valid values are between 0 (no collapsing) and 1 (all slices are collapsed into a single pie).	0.01 (slices smaller than 1% of the whole pie are collapsed)	Yes
sliceCollapsingLabel	string	The label for the consolidated slice.	other	Yes
labelStyle	style<textBlock>	Applies properties to pie slice labels	See the textBlock table for specific defaults.	No
labelLineBrush	brush	Indicates the brush to use for painting label lines. Reference an existing palette with the @ symbol: @mybrushpalette.	See the brush table for specific defaults.	No
showLabels	boolean	Determines whether or not pie chart labels are displayed.	true	Yes
showPercent	boolean	Determines whether percentage values are shown along with the labels.	false	Yes

Radial gauge properties

Radial gauge properties The following properties are applicable only to radialGauge charts. The radialGauge, like the other gauge chart types, enables the visualization of a single numerical value mapped against a range of colors that may have particular business meaning or logic. The radial gauge is similar in appearance to a speedometer in appearance; it has an arced range scale and a rotating needle. The gauge range can be provided in the search or hardcoded using the rangeValues property (which overrides any range values present in the data). At least two range values are required to define a minimum and maximum range; additional values can be supplied to define intervals between the minimum and maximum. By default Splunk assigns colors to each defined interval within the range. For more information about radial gauges, see Single-value visualizations.
Property name	Value type	Definition	Default	Supported by JSChart?
style	string	Enables the choice between two basic gauge appearances. The shiny style is a graphically stylized version of the gauge with with chrome, shading, and so on so that it mimics those in the real world. The minimal style is a stripped-down "just the basics" version of the gauge.	shiny	Yes
needleBrush	brush	The brush to use for drawing the gauge needle.	See the brush table for specific defaults.	No
needleShape	shape	The shape to use when drawing the gauge needle.	See the shape table for specific defaults.	No
needleStyle	style<sprite>	The properties to apply to the gauge needle.	See the sprite table for specific defaults.	No
needleRadius1	number	The radius of the base of the gauge needle, in relative coordinates (typically between -1 and 1).	0	No
needleRadius2	number	The radius of the tip of the gauge needle, in relative coordinates (typically between 0 and 1).	0.9	No
needleThickness	number	The thickness of the gauge needle, in relative coordinates (typically between 0 and 1).	0.05	No
rangeValues	array<number>	A numeric array that represents the overall numerical range represented by the gauge, and the relative size of the color-coded subranges within that overall range. For example, a range of [0,30,70,100] would indicate that the gauge starts at zero, ends at 100, and has three subranges that are each identified by a different color on the range band. If the search returns a value of 71, the gauge needle moves to the spot where 71 would be on the gauge, and where the radial gauge is shaded with the color assigned to the middle range (61-85). If the value ever falls outside of the top or bottom range of the gauge, the needle "flutters" at the boundary and a warning icon appears. Note: When you specify range values in the xml, they override range values that are specified through the search upon which the dashboard panel is based.	Not assigned.	Yes
gaugeColors	array<number>	A list of hexadecimal color values from which the range band colors are generated. Colors display in the order indicated in the array. For example, you can reverse the default green-yellow-red sequence by changing the gaugeColors value to [0xBF3030,0xFFE800,0x84E900]. You can specify any number of colors. If your gauge has more or less range intervals (either specified via the search language or the rangeValues parameter) than the number of rangeColors, Splunk will interpolate the colors as necessary.	[0x84E900,0xFFE800,0xBF3030]	Yes
rangeStartAngle	number	The angle (clockwise starting from the bottom of the gauge) at which to begin drawing the range arc, in degrees.	45	Yes
rangeArcAngle	number	The length of the range arc, in degrees (positive values are clockwise, negative values are counterclockwise).	270	Yes
rangeBandBrushPalette	brushPalette	Indicates the brush palette to use for drawing the variable colored range band. Reference an existing palette with the @ symbol: @myrangebandbrushpalette.	See the brushPalette table for specific defaults.	No
rangeBandStyle	style<sprite>	The style properties to apply to the variable colored range band.	See the sprite table for specific defaults.	No
rangeBandRadius1	number	The inner radius of the variable colored range band, in relative coordinates (typically between 0 and 1).	0.8	No
rangeBandRadius2	number	The outer radius of the variable colored range band, in relative coordinates (typically between 0 and 1).	0.9	No
majorTickBrush	brush	The brush that is used to draw the major tick marks.	See the brush table for specific defaults.	No
majorTickStyle	style<sprite>	Indicates the style properties that are applied to major tick marks.	See the sprite table for specific defaults.	No
majorTickRadius1	number	The inner radius of the major tick marks, in relative coordinates (typically between 0 and 1).	0.7	No
majorTickRadius2	number	The outer radius of the major tick marks, in relative coordinates (typically between 0 and 1).	0.8	No
majorUnit	number	The spacing at which to place major tick marks.	auto	Yes
minorTickBrush	brush	The brush that is used to draw the minor tick marks.	See the brush table for specific defaults.	No
minorTickStyle	style<sprite>	Indicates the style properties that are applied to minor tick marks.	See the sprite table for specific defaults.	No
minorTickRadius1	number	The inner radius of the minor tick marks, in relative coordinates (typically between 0 and 1).	0.75	No
minorTickRadius2	number	The outer radius of the minor tick marks, in relative coordinates (typically between 0 and 1).	0.8	No
minorUnit	number	The spacing at which to place minor tick marks.	auto	No
labelStyle	style<textBlock>	The style properties to apply to labels along the range arc.	See the textBlock table for specific defaults.	No
labelRadius	number	The radius at which to place labels, in relative coordinates (typically between 0 and 1).	0.7	No
valueStyle	style<textBlock>	Provides the style properties for the value at the bottom of the gauge. Note that valueStyle can be used to change the way the value displays (font, bolding, italicization, and so on.), but it can't be used to actually change the text itself. For example, you can't use valueStyle to replace the value with a specific text string.	See the textBlock table for specific defaults.	No
valueRadius	number	The radius at which to place the value, in relative coordinates (typically between 0 and 1).	0.8	No
warningBrush	brush	The brush to use when drawing the warning indicator.	See the brush table for specific defaults.	No
warningShape	shape	The shape to use when drawing the warning indicator.	See the shape table for specific defaults.	No
warningStyle	style<sprite>	The style properties to apply to the warning indicator.	See the sprite table for specific defaults.	No
warningRadius	number	The radius at which to place the warning indicator, in relative coordinates (typically between 0 and 1).	1	No
warningSize	number	The size of the warning indicator, in relative coordinates (typically between 0 and 1).	0.1	No
foregroundBrush	brush	The brush to use for drawing the gauge foreground.	See the brush table for specific defaults.	No
foregroundStyle	style<sprite>	The style properties to apply to the gauge foreground.	See the sprite table for specific defaults.	No
foregroundRadius	number	The radius of the gauge foreground, in relative coordinates (typically between 0 and 1).	1	No
backgroundBrush	brush	The brush to use for drawing the gauge background.	See the brush table for specific defaults.	No
backgroundStyle	style<sprite>	The style properties to apply to the gauge background.	See the sprite table for specific defaults.	No
backgroundRadius	number	The radius of the gauge background, in relative coordinates (typically between 0 and 1).	1	No
layers	array<string>	The layering order of the visual elements that make up the radial gauge. The elements are presented as a list; the element order determines how the elements are layered on top of one another (first on bottom, last on top). Elements not specified in this list remain in their default order below all the specified elements.	[ background, rangeBand, minorTicks, majorTicks, labels, value, warning, needle, foreground ]	No
usePercentageRange	boolean	Determines whether the range values should be formatted as percentages.	false	Yes
usePercentageValue	boolean	Determines whether to format the gauge value as a percentage.	false	Yes
showRangeBand	boolean	Determines whether the gauge should display the variable colored range band.	true	Yes
showMajorTicks	boolean	Determines whether the gauge should display major tick marks.	true	Yes
showMinorTicks	boolean	Determines whether the gauge should display minor tick marks.	true	Yes
showLabels	boolean	Determines whether the gauge should display labels.	true	Yes
showValue	boolean	Determines whether the gauge should display its value.	true	Yes

Range marker properties

Range marker properties The following properties are applicable only to rangeMarker charts. The range marker is a single-axis chart that renders a fill spanning the area between two points on an axis. The data table upon which the chart is structured must contain at least one column with two rows, where the first row contains the minimum value to be plotted on the axis, and the second row contains the maximum value. The minimumValue and maximumValue properties may optionally be used in place of the data set. Range marker charts are related to value marker charts in that they are mainly useful as overlays above another chart, such as a line chart.
Property name	Value type	Definition	Default	Supported by JSChart?
minimumValue	string	The optional minimum value to plot.	Not assigned.	No
maximumValue	string	The optional maximum value to plot.	Not assigned.	No
orientation	string	Determines the range marker orientation. Valid values are x (horizontal) and y (vertical).	x	No
lineBrush	brush	Indicates the brush to use for painting label lines. Reference an existing palette with the @ symbol: @mybrushpalette.	See the brush table for specific defaults.	No
innerFillBrush	brush	Indicates the brush to use for painting the fill inside the minimum and maximum range marker values. Reference an existing palette with the @ symbol: @mybrushpalette.	See the brush table for specific defaults.	No
outerFillBrush	brush	Indicates the brush to use for painting the fill outside the minimum and maximum range marker values. Reference an existing palette with the @ symbol: @mybrushpalette.	See the brush table for specific defaults.	No

Ratio bar chart properties

Ratio bar chart properties The following properties are applicable only to ratioBar charts. The ratio bar chart is a basic chart that renders data as a divided bar. The data table upon which the chart is structured must contain at least two columns, where the first column contains the labels for each bar and the second column contains the values that correspond to each label. Multiple series are currently not supported, and additional columns are ignored.
Property name	Value type	Definition	Default	Supported by JSChart?
orientation	string	Determines the ratio bar orientation. Valid values are x (horizontal) and y (vertical).	x	No
barBrushPalette	brushPalette	Indicates the brush palette used for painting the bars in ratio bar charts. Reference an existing palette with the @ symbol: @mybrushpalette.	See the brushPalette table for specific defaults.	No
barStyle	style<sprite>	The properties that can be applied to bar sprites in ratio bar charts.	See the sprite table for specific defaults.	No
barCollapsingThreshold	number	Controls the threshold at which smaller ratio bars are collapsed into a consolidated bar. Valid values are between 0 (no collapsing) and 1 (all bars are collapsed into a consolidated bar).	0.01 (bars smaller than 1% of the whole are collapsed).	No
sliceCollapsingLabel	string	The label for the consolidated ratio bar.	other	No
labelStyle	style<textBlock>	Applies properties to ratio bar labels	See the textBlock table for specific defaults.	No
labelLineBrush	brush	Indicates the brush to use for painting label lines. Reference an existing palette with the @ symbol: @mybrushpalette.	See the brush table for specific defaults.	No
showLabels	boolean	Determines whether ratio bar chart labels are displayed.	true	No
showPercent	boolean	Determines whether percentages are displayed along with the labels.	true	No

Scatter chart properties

Scatter chart properties The following properties are applicable only to scatter charts. The scatter chart is a dual axis chart that renders data as scattered markers. The data must be in one of two forms: 1. A single series setup, where the chart is structured on a data table that contains 2 columns, where the first column (column 0) contains the values to be plotted on the x-axis, and the second column (column 1) contains the values to be plotted on the y-axis. 2. A multiple series setup, where the chart is structured on a data table that contains 3 columns. The first column (column 0) contains the series names, and the next two columns contain the values to be plotted on the x- and y-axes, respectively (see form 1, above).
Property name	Value type	Definition	Default	Supported by JSChart?
markerBrushPalette	brushPalette	Indicates the brush palette to use for painting markers. Reference an existing palette with the @ symbol: @mybrushpalette.	See the brushPalette table for specific defaults.	No
markerShapePalette	shapePalette	Indicates the shape palette that defines the shapes of markers. Reference an existing palette with the @ symbol: @myshapepalette.	See the shapePalette table for specific defaults.	No
markerStyle	style<sprite>	Applies properties to marker sprites.	See the sprite table for specific defaults.	No
markerSize	number	The size of the scatter chart markers, in pixels.	4	Yes
defaultSeriesName	string	The series name to use for indexing into palettes and legends when only 2 columns can be present in the data.	scatter	No

Value marker properties

Value marker properties The following properties are applicable only to valueMarker charts. Value marker charts are single-axis charts that render a line at a single point on an axis. The data table upon which the chart is structured must contain at least one column with one row, where the row contains the value to be plotted on the axis, and the second row contains the maximum value. The value property can optionally be used in place of the data set. Value marker charts are related to range marker charts in that they are mainly useful as overlays above another chart, such as a line chart.
Property name	Value type	Definition	Default	Supported by JSChart?
value	string	The optional value to plot.	Not assigned.	No
orientation	string	Determines the value marker orientation. Valid values are x (horizontal) and y (vertical).	x	No
lineBrush	brush	Indicates the brush to use for painting the value marker line. Reference an existing palette with the @ symbol: @mybrushpalette.	See the brush table for specific defaults.	No

Legend

Usage: charting.legend.*

The legend element controls the chart legend. It is used by all chart types.

Note: You can also take advantage of a predefined external legend element called externalLegend. externalLegendis a non-visual object that connects to an external source responsible for synchronizing legends across multiple charting modules in a view. It has no additional properties. It is referenced by the masterLegend parameter (see below). You can also refer to it directly if necessary using the @ symbol: @externalLegend.

For more information about making element and property references see Chart customization.

Values

• legend

Example

<option name="charting.legend">legend</option>
<option name="charting.legend.placement">left</option>
<option name="charting.legend.labelStyle.maximumWidth">500</option>
<option name="charting.legend.labelStyle.defaultTextFormat">{italic:true,size:14}</option>

These settings have the legend appearing to the left of the chart, with a maximum allowable width of 500 pixels, and text that is 14 points in size and italicized.

defaultTextFormat and maximumWidth are textBlock properties. maximumWidth is a property that is ultimately inherited from layoutSprite. defaultTextFormat enables you to set a variety of text formatting properties in one line. See the table below for the full list of legend properties.

Also used by

• layout.legends

Enables you to specify a list of legend types. See "Advanced configuration - Layout and data table properties" for more information.

Properties

Legend properties The legend is the main visual legend type that displays labels and their corresponding color swatches. It inherits properties from layoutSprite and has the following additional properties.
Property name	Value type	Definition	Default	Supported by JSChart?
labels	array<string>	A comma-separated list of labels to pre-populate the legend with.	Not assigned	Yes
defaultSwatchBrushPalette	brushPalette	The brush palette to use for painting swatches that have not been provided by a chart. Reference an existing palette with the @ symbol: @mybrushpalette.	Not assigned	No
masterLegend	legend	If you want all charts in a particular dashboard view to use the same colors in their legends, you can use masterLegend to act as a "master legend" for each of them. You can reference an existing legend for your charts with the @ symbol: @mylegend. Note: This parameter influences series color mappings made with seriesColors. For more information, see Chart colors.	Not assigned	Yes, but only an empty tag or "null" are supported and have the effect of disabling the master legend interaction. Any other value will cause the chart to revert to Flash.
placement	string	The placement of the legend within a dual axis layout. Valid values are left, right, top, bottom, center, and none.	right	Yes
orientation	string	Controls the orientation of the legend in relation to the chart axes. Valid values are x, y, and auto.	auto	No
swatchPlacement	string	Controls the placement of legend swatches in relation to legend labels. Valid values are left, right, top, and bottom.	left	No
labelStyle	style<textBlock>	Applies properties to legend labels. See the textBlock properties for more information.	Not assigned	No
swatchStyle	style<layoutSprite>	Applies layoutSprite properties to legend swatches.	Not assigned	No
itemStyle	style<layoutSprite>	Applies layoutSprite properties to legend items.	Not assigned	No