Splunk® Enterprise

Splunk Dashboard Studio

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Object options and defaults reference

The source options currently available for each chart, shape, and single value visualization are listed in this section. Note that boolean values and numbers are not encased in quotes. All strings and other options must be.

Area chart

Area chart options

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

Property Type Default Description
annotation.categoryColors object n/a Map comma-delimited, hexadecimal color values to specified categories. For example, {"count": "#ff0000","percent": "#cb3b43"}.
areaFillOpacity number 0.75 Specify the opacity for the area fill using numbers between and including 0 and 1. This relates to the opacity percentages in the visual editor. 0 is transparent and 1 is completely opaque.
axisY2.enabled boolean false Enable a y2-axis for chart overlays.
axisY2.fields string n/a Specify a field that you want to map to a second y-axis for chart overlays.
axisY.includeZero boolean false Specify whether the y-axis range includes zero.
axisY2.includeZero boolean false Specify whether the y2-axis range includes zero.
axisY.maximumNumber (number | auto) auto Specify the maximum number for the visible y-axis range.
axisY2.maximumNumber (number | auto) auto Specify the maximum number for the visible y2-axis range.
axisY.minimumNumber (none | auto) auto Specify the minimum number for the visible y-axis range.
axisY2.minimumNumber (none | auto) auto Specify the minimum number for the visible y2-axis range.
axisY.scale (linear | log) linear Specify the scale type that applies to a numerical y-axis.
axisY2.scale (linear | log) linear Specify the scale type that applies to a numerical y2-axis.
axisLabelsY2.integerUnits boolean false Specify whether to extend the y2-axis to include whole major tick marks.
axisLabelsX.majorTickVisibility string hide Specify whether major tick marks on the x-axis are visible.
axisLabelsY.majorTickVisibility string hide Specify whether major tick marks on the y-axis are visible.
axisLabelsY2.majorTickVisibility string hide Specify whether major tick marks on the y2-axis are visible.
axisLabelsX.majorUnit (number | auto) auto Specify the spacing unit between major tick marks along the numeric x-axis.
axisLabelsY.majorUnit (number | auto) auto Specify the spacing unit between major tick marks along the numeric y-axis.
axisLabelsY2.majorUnit (number | auto) auto Specify the spacing unit between major tick marks along the numeric y2-axis.
axisTitleX.text string n/a Specify the title of the x-axis.
axisTitleY.text string n/a Specify the title of the y-axis.
axisTitleY2.text string n/a Specify the title of the y2-axis.
axisTitleX.visibility (visible | collapsed) visible Specify whether to show the title of the x-axis.
axisTitleY.visibility (visible | collapsed) visible Specify whether to show the title of the y-axis.
axisTitleY2.visibility (visible | collapsed) visible Specify whether to show the title of the y2-axis.
backgroundColor string n/a Specify the color used for the chart background by using the hex code. For example, "#0000FF" .
chart.nullValueMode (gaps | zero | connected) gaps Specify how area and line charts handle null values.
chart.overlayFields string n/a Specify a space, or a field or comma-delimited list of fields, to map to the y2-axis.
chart.resultTruncationLimit number 50000 Specify a limit for the number of data points rendered in a chart.
chart.showDataLabels (none | all | minmax) none Specify whether you want area charts to display no labels, all labels, or only the min and max labels.
chart.showLines boolean true Specify whether you want lines to show in area charts.
chart.stackMode (default | stacked | stacked100) default Specify stacking options.
data.fieldHideList array n/a Specify a list of fields to hide in the results. ["#FF0000", "#000000", "#FFFFFF"].
data.fieldListMode (show_hide | hide_show) hide_show Specify the order in which to apply the fieldShowList and fieldHideList filters.
data.fieldShowList array n/a Specify a list of fields to show in the results. For example: ["#FF0000", "#000000", "#FFFFFF"].
drilldown (all | none) all Specify whether to enable or disable drilldown for the chart.
fieldColors object n/a Specify the color used for a field by specifying the hex code. For example: {"count": "#ff0000","percent": "#cb3b43"}.

If you would like to maintain a space between two fields, you can use the backslash and quotes to surround the string and maintain the space.

In this example: "{China:#45D4BA,US:#9AE6F7, \"Korea, South\" :#2F8AA7,SanMarino:#C0891E,Singapore:#780621,\"Cruise Ship\":#4EB2D2}"

Korea, South and Cruise Ship will have spaces when they appear in the visualization.

fontColorstring string n/a Specify the color used for fonts (axis labels, legends) using the hex code. For example, "#0000FF" .
foregroundColor string n/a Specify the color used for the chart foreground by specifying the hex code. For example, "#0000FF".
gridLinesX.showMajorLines boolean true Specify whether major grid lines are visible on the x-axis.
gridLinesY.showMajorLines boolean true Specify whether major grid lines are visible on the y-axis.
gridLinesY2.showMajorLines boolean true Specify whether major grid lines are visible on the second y-axis.
layout.splitSeries boolean false Set to true to split a multi-series chart into separate charts that are stacked from top to bottom; one for each series.
layout.splitSeries.allowIndependentYRanges boolean false Specify whether split series charts have independent y-ranges.
legend.labelStyle.overflowMode (ellipsisEnd | ellipsesMiddle | ellipsisStart | ellipsesNone) ellipsesMiddle Specify how to display legend labels when they overflow the layout boundaries by replacing overflow text with an ellipsis.
legend.mode (standard | seriesCompare) standard Provides visual and behavior settings for the tooltip and legend.
legend.placement (right | left | top | bottom | none) right Specify the location of the legend on the panel.
seriesColors string Dark mode: "#212527", Light mode: "#FFFFFF" Specify the hex color codes for the area chart. For example:

"[#FF0000,#0000FF,#008000]"

Bar chart

Bar chart options

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

Property Type Default Description
axisY2.enabled boolean false Enable a y2-axis for chart overlays.
axisY2.fields string N/A Specify a field to map to a second y-axis for chart overlays.
axisLabelsY.integerUnits boolean false Specify whether the major unit of the y-axis is rounded to the nearest integer.
axisY.includeZero boolean false Specify whether the y-axis range includes zero.
axisY2.includeZero boolean false Specify whether the y2-axis range includes zero.
axisY.maximumNumber (number | auto) auto Specify the maximum number for the visible y-axis range.
axisY2.maximumNumber (number | auto) auto Specify the maximum number for the visible y2-axis range.
axisY.minimumNumber (none | auto) auto Specify the minimum number for the visible y-axis range.
axisY2.minimumNumber (none | auto) auto Specify the minimum number for the visible y2-axis range.
axisY.scale (linear | log) linear Specify the scale type that applies to a numerical y-axis.
axisY2.scale (linear | log) linear Specify the scale type that applies to a numerical y2-axis.
axisTitleX.text string N/A Specify the title of the x-axis.
axisTitleY.text string N/A Specify the title of the y-axis.
axisTitleY2.text string N/A Specify the title of the y2-axis.
axisTitleX.visibility (visible | collapsed) visible Specify whether to show the title of the x-axis.
axisTitleY.visibility (visible | collapsed) visible Specify whether to show the title of the y-axis.
axisTitleY2.visibility (visible | collapsed) visible Specify whether to show the title of the y2-axis.
gridLinesX.showMajorLines boolean false Specify whether major grid lines are visible on the x-axis.
gridLinesY.showMajorLines boolean false Specify whether major grid lines are visible on the y-axis.
gridLinesY2.showMajorLines boolean false Specify whether major grid lines are visible on the second y-axis.
chart.overlayFields string N/A Specify a field, a space, or a comma-delimited list of fields that you want to map to the y2-axis.
backgroundColor string N/A Specify the color used for the chart background by using the hex code. For example, "#0000FF".
fontColor string N/A Specify the color used for fonts (axis labels, legends) using the hex code. For example, "#0000FF".
foregroundColor string N/A Specify the color used for the chart foreground by specifying the hex code. For example, "#0000FF".
fieldColors object N/A Specify the color used for a field by specifying the hex code. For example, {"count": "#ff0000","percent": "#cb3b43"}.

If you would like to maintain a space between two fields, you can use the backslash and quotes to surround the string and maintain the space.

In this example: "{China:#45D4BA,US:#9AE6F7, \"Korea, South\" :#2F8AA7,SanMarino:#C0891E,Singapore:#780621,\"Cruise Ship\":#4EB2D2}" Korea, South and Cruise Ship will have spaces when they appear in the visualization.

seriesColors array (dark and light mode defaults) ["#1E93C6", "#F2B827", "#D6563C", "#6A5C9E", "#31A35F"] Specify the hex color codes for the bars to use in order from largest to smallest. For example, ["#FF0000","#0000FF","#008000"].
drilldown (all | none) all Specify whether to enable or disable drilldown for the chart.
chart.barSpacing number N/A Specify the spacing, in pixels, between columns in a bar chart.
chart.seriesSpacing number N/A Specify the spacing, in pixels, between clustered series in column and bar charts.
chart.stackMode (default | stacked | stacked100) default Specify stacking options.
chart.resultTruncationLimit number 50000 Specify a limit for the number of data points rendered in a chart.
legend.placement (right | left | top | bottom | none) right Specify the location of the legend on the panel.
legend.labelStyle.overflowMode (ellipsisEnd | ellipsesMiddle | ellipsisStart | ellipsesNone) ellipsesMiddle Specify how to display legend labels when they overflow the layout boundaries by replacing overflow text with an ellipsis.
layout.splitSeries boolean false Set to true to split a multi-series chart into separate charts that are stacked from top to bottom; one for each series.
data.fieldListMode (show_hide | hide_show) hide_show Specify the order in which to apply the fieldShowList and fieldHideList filters.
data.fieldShowList array N/A Specify a list of fields to show in the results. For example: ["#FF0000", "#000000", "#FFFFFF"].
data.fieldHideList array N/A Specify a list of fields to hide in the results. For example: ["#FF0000", "#000000", "#FFFFFF"].
chart.showDataLabels (none | all | minmax) none Specify whether you want bar charts to display no labels, all labels, or only the min and max labels.

Bubble chart

Bubble chart options

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

Property Type Default Description
axisLabelsX.integerUnits boolean false Specify whether the y2-axis should be extended to include whole major tick marks.
axisLabelsX.majorUnit (number | auto) auto Specify the spacing, in pixels, between major tick marks along the numeric x-axis.
axisLabelsX.minorTickVisibility (auto | show | hide) auto Specify whether minor tick marks on the y-axis are visible.
axisX.abbreviation (none | auto) none Specify whether to abbreviate large x-axis values with the closest SI prefix.
axisX.includeZero boolean false Specify whether the x-axis range includes zero.
axisY.includeZero boolean false Specify whether the y-axis range includes zero.
axisX.maximumNumber (number | auto) auto Specify the maximum number for the visible x-axis range.
axisY.maximumNumber (number | auto) auto Specify the maximum number for the visible y-axis range.
axisX.minimumNumber (none | auto) auto Specify the minimum number for the visible x-axis range.
axisY.minimumNumber (none | auto) auto Specify the minimum number for the visible y-axis range.
axisX.scale (linear | log) linear Specify the scale type that applies to a numerical x-axis.
axisY.scale (linear | log) linear Specify the scale type that applies to a numerical y-axis.
axisTitleX.text string N/A Specify the title of the x-axis.
axisTitleY.text string N/A Specify the title of the y-axis.
axisTitleX.text string N/A Specify the title of the x-axis.
axisTitleX.visibility (visible | collapsed) visible Specify whether to show the title of the x-axis.
axisTitleY.visibility (visible | collapsed) visible Specify whether to show the title of the y-axis.
axisLabelsX.extendsAxisRange boolean true Specify whether the x-axis should be extended to include whole major tick marks.
gridLinesY.showMajorLines boolean true Specify whether major grid lines are visible on the y-axis.
backgroundColor string N/A Specify the color used for the chart background by using the Hex code. For example, "#0000FF" .
fontColor string N/A Specify the color used for fonts (axis labels, legends) using the Hex code. For example, "#0000FF" .
foregroundColor string N/A Specify the color used for the chart foreground by specifying the Hex code. For example, "#0000FF" .
fieldColors object N/A Specify the color used for a field by specifying the hex code. For example, {"count": "#ff0000","percent": "#cb3b43"}.

If you would like to maintain a space between two fields, you can use the backslash and quotes to surround the string and maintain the space.

In this example: "{China:#45D4BA,US:#9AE6F7, \"Korea, South\" :#2F8AA7,SanMarino:#C0891E,Singapore:#780621,\"Cruise Ship\":#4EB2D2}" Korea, South and Cruise Ship will have spaces when they appear in the visualization.

gridLinesX.showMinorLines boolean false Specify whether minor grid lines are visible on the x-axis.
legend.labelStyle.overflowMode (ellipsisEnd | ellipsesMiddle | ellipsisStart | ellipsesNone) ellipsesMiddle Specify how to display legend labels when they overflow the layout boundaries by replacing overflow text with an ellipsis.
legend.placement (right | left | top | bottom | none) right Specify the location of the legend on the panel.
seriesColors array (dark and light mode defaults) ["#1E93C6", "#F2B827", "#D6563C", "#6A5C9E", "#31A35F"] Specify the hex color codes for the bars to use in order from largest to smallest. For example, ["#FF0000","#0000FF","#008000"].
drilldown (all | none) all Specify whether to enable or disable drilldown for the chart.
chart.resultTruncationLimit number 50000 Specify a limit for the number of data points rendered in a chart.
chart.bubbleMaximumSize number 50 Specify, in pixels, the maximum size of each bubble. Set chart.bubbleSizeBy to specify how this is measured.
chart.bubbleMinimumSize number 10 Specify, in pixels, the minimum size of each bubble. Set chart.bubbleSizeBy to specify how this is measured.
chart.bubbleSizeBy (area | diameter) area Specify how bubble size is measured.

Choropleth map

Choropleth map options

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

Property Type Default Description
source (geo://default/world | geo://default/us) (geo://default/world | geo://default/us) Source for geographic data for the world or US.
projection (mercator | equirectangular) mercator Specify the way the map is projected
fillColor string #EAEFF2 Select a fill color for regions with no data. For example, if you want all regions with no data to be white, use "#FFFFFF".
strokeColor string #689C8D Select a stroke color for regions with no data. For example, if you want all regions with no data to be grey, use "#808080".

Choropleth SVG

Choropleth SVG options

The following options are available for editing choropleth SVG visualizations in the source editor:

Property Type Default Description
areaIds string > primary | seriesByType("string") Specify the dataSource field for identifying each area in the Choropleth SVG tagged with an ID field.
areaValues number > primary | seriesByType("number") Specify the dataSource field that indicates the values for the areas.
areaColors string > areaValues | rangeValue(areaColorsRangeConfig) Specify the dataSource field for setting the SVG fill attribute of identified areas.
backgroundColor string > themes.defaultBackgroundColor Specify, using a hex code, the background color behind the SVG map, title, and description. For example, "#0000FF".
svg string N/A KV store location of the SVG image.

Column chart

Column chart options

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

Property Type Default Description
annotation.categoryColors object N/A Map comma-delimited, hexadecimal color values to specified categories. For example, {"count": "#ff0000","percent": "#cb3b43"}.
axisY2.enabled boolean false Enable a y2-axis for chart overlays.
axisY2.fields string N/A Specify a field to map to a second y-axis for chart overlays.
axisY.includeZero boolean false Specify whether the y-axis range includes zero.
axisY2.includeZero boolean false Specify whether the y2-axis range includes zero.
axisY.maximumNumber (number | auto) auto Specify the maximum number for the visible y-axis range.
axisY2.maximumNumber (number | auto) auto Specify the maximum number for the visible y2-axis range.
axisY.minimumNumber (none | auto) auto Specify the minimum number for the visible y-axis range.
axisY2.minimumNumber (none | auto) auto Specify the minimum number for the visible y2-axis range.
axisY.scale (linear | log) linear Specify the scale type that applies to a numerical y-axis.
axisY2.scale (linear | log) linear Specify the scale type that applies to a numerical y2-axis.
axisTitleX.text string N/A Specify the title of the x-axis.
axisTitleY.text string N/A Specify the title of the y-axis.
axisTitleY2.text string N/A Specify the title of the y2-axis.
axisTitleX.visibility (visible | collapsed) visible Specify whether to show the title of the x-axis.
axisTitleY.visibility (visible | collapsed) visible Specify whether to show the title of the y-axis.
axisTitleY2.visibility (visible | collapsed) visible Specify whether to show the title of the y2-axis.
gridLinesX.showMajorLines boolean false Specify whether major grid lines are visible on the x-axis.
gridLinesY.showMajorLines boolean false Specify whether major grid lines are visible on the y-axis.
gridLinesY2.showMajorLines boolean false Specify whether major grid lines are visible on the second y-axis.
chart.overlayFields string N/A Specify a field or a space or comma-delimited list of fields to map to the y2-axis.
backgroundColor string N/A Specify the color used for the chart background by using the hex code. For example, "#0000FF".
data.fieldListMode (show_hide | hide_show) hide_show Specify the order in which to apply the fieldShowList and fieldHideList filters.
data.fieldShowList array N/A Specify a list of fields to show in the results. For example: ["#FF0000", "#000000", "#FFFFFF"].
data.fieldHideList array N/A Specify a list of fields to hide in the results. For example: ["#FF0000", "#000000", "#FFFFFF"].
fontColor string N/A Specify the color used for fonts using the hex code. For example, "#0000FF".
foregroundColor string N/A Specify the color used for the chart foreground by specifying the hex code. For example, "#0000FF".
fieldColors object N/A Specify the color used for a field by specifying the hex code. For example, {"count": "#ff0000","percent": "#cb3b43"}.

If you would like to maintain a space between two fields, you can use the backslash and quotes to surround the string and maintain the space.

In this example: "{China:#45D4BA,US:#9AE6F7, \"Korea, South\" :#2F8AA7,SanMarino:#C0891E,Singapore:#780621,\"Cruise Ship\":#4EB2D2}" Korea, South and Cruise Ship will have spaces when they appear in the visualization.

legend.labelStyle.overflowMode (ellipsisEnd | ellipsesMiddle | ellipsisStart | ellipsesNone) ellipsesMiddle Specify how to display legend labels when they overflow the layout boundaries by replacing overflow text with an ellipsis.
legend.placement (right | left | top | bottom | none) right Specify the location of the legend on the panel.
seriesColors array (dark and light mode defaults) ["#1E93C6", "#F2B827", "#D6563C", "#6A5C9E", "#31A35F"] Specify the hex color codes for the bars to use in order from largest to smallest. For example, ["#FF0000","#0000FF","#008000"].
drilldown (all | none) all Specify whether to enable or disable drilldown for the chart.
chart.seriesSpacing number N/A Specify the spacing, in pixels, between clustered series in column and bar charts.
chart.columnSpacing number N/A Specify the spacing, in pixels, between columns in a column chart.
chart.stackMode (default | stacked | stacked100) default Specify stacking options.
chart.resultTruncationLimit number 50000 Specify a limit for the number of data points rendered in a chart.
chart.showDataLabels (none | all | minmax) none Specify whether you want column charts to display no labels, all labels, or only the min and max labels.
layout.splitSeries boolean false Set to true to split a multi-series chart into separate charts that are stacked from top to bottom; one for each series.
layout.splitSeries.allowIndependentYRanges boolean false Specify whether split series charts have independent y-ranges.

Ellipses

Ellipse shape options

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

Property Type Default Description
stroke number Specify the color of the stroke using a hex code. For example, "#FF0000".
strokeOpacity number 1 Specify the opacity of the stroke. Choose a number in the range of 0-1. You can also express the value as a percentage. For example, "0.80" or "80%".
strokeWidth number 1 Specify the width of the stroke, in pixels, in the range of 1-25.
fill string Specify the color fill using a hex code. For example, "#FF0000".
fillOpacity number 1 Specify the opacity of the fill. Choose a number in the range of 0-1. You can also express the value as a percentage. For example, "0.80" or "80%".
strokeDasharray number 0 Specify the size, in pixels, of dashes and spaces used to create a custom, stitched outline. The value you specify applies to both dashes and spaces.
opacity number 1 Specify the opacity of the entire object. Stroke and fill colors are retained. Choose a number in the range of 0-1. You can also express the value as a percentage. For example, "0.80" or "80%".

Filler gauge

Filler gauge options

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

Property Type Default Description
backgroundColor string light mode: "FFFFFF" dark mode: "#212527" Use a hex code to specify the color used for the dashboard background. For example: "#0000FF".
majorUnit number or "auto" auto Specify the spacing between major tick marks in pixels.
orientation string horizontal Specify the axis orientation of the gauge. horizontal or vertical.
showLabels boolean true Specify whether to display labels.
showValue boolean true Specify whether the gauge value is displayed.
usePercentageRange boolean true Specify whether to format gauge ranges as percentages.
usePercentageValue boolean false Specify whether to format the gauge values as percentages.


Images

Image options

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

Property Type Default Description
src string N/A URL of an image file. The editor accepts all browser-supported image formats.
preserveAspectRatio boolean false Set to true to maintain the aspect ratio of an image when the screen is resized.

Line chart

Line chart options

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

Property Type Default Description
annotation.categoryColors object n/a Map comma-delimited, hexadecimal color values to specified categories. For example, {"count": "#ff0000","percent": "#cb3b43"}.
axisY2.enabled boolean false Enable a y2-axis for chart overlays.
axisY2.fields string n/a Specify a field to map to a second y-axis for chart overlays.
axisY.includeZero boolean false Specify whether the y-axis range includes zero.
axisY2.includeZero boolean false Specify whether the y2-axis range includes zero.
axisY.maximumNumber (number | auto) auto Specify the maximum number for the visible y-axis range.
axisY2.maximumNumber (number | auto) auto Specify the maximum number for the visible y2-axis range.
axisY.minimumNumber (none | auto) auto Specify the minimum number for the visible y-axis range.
axisY2.minimumNumber (none | auto) auto Specify the minimum number for the visible y2-axis range.
axisY.scale (linear | log) linear Specify the scale type that applies to a numerical y-axis.
axisY2.scale (linear | log) linear Specify the scale type that applies to a numerical y2-axis.
axisLabelsX.majorTickVisibility string hide Specify whether major tick marks on the x-axis are visible.
axisLabelsY.majorTickVisibility string hide Specify whether major tick marks on the y-axis are visible.
axisLabelsY2.majorTickVisibility string hide Specify whether major tick marks on the y2-axis are visible.
axisLabelsX.majorUnit (number | auto) auto Specify the spacing unit between major tick marks along the numeric x-axis.
axisLabelsY.majorUnit (number | auto) auto Specify the spacing unit between major tick marks along the numeric y-axis.
axisLabelsY2.majorUnit (number | auto) auto Specify the spacing unit between major tick marks along the numeric y2-axis.
axisTitleX.text string n/a Specify the title of the x-axis.
axisTitleY.text string n/a Specify the title of the y-axis.
axisTitleY2.text string n/a Specify the title of the y2-axis.
axisTitleX.visibility (visible | collapsed) visible Specify whether to show the title of the x-axis.
axisTitleY.visibility (visible | collapsed) visible Specify whether to show the title of the y-axis.
axisTitleY2.visibility (visible | collapsed) visible Specify whether to show the title of the y2-axis.
backgroundColor string n/a Specify the color used for the chart background by using the hex code. For example, "#0000FF".
chart.nullValueMode (gaps | zero | connected) gaps Specify how area and line charts handle null values.
chart.overlayFields string n/a Specify a field, or a space or comma-delimited list of fields, to map to the y2-axis.
chart.resultTruncationLimit number 50000 Specify the number of data points rendered in a chart.
chart.showDataLabels (none | all | minmax) none Specify whether you want line charts to display no labels, all labels, or only the min and max labels.
chart.showMarkers boolean true Specify whether to show markers in line charts.
data.fieldHideList array n/a Specify a list of fields to hide in the results. For example: ["#FF0000", "#000000", "#FFFFFF"].
data.fieldListMode (show_hide | hide_show) hide_show Specify the order in which to apply the fieldShowList and fieldHideList filters.
data.fieldShowList array n/a Specify a list of fields to show in the results. For example: ["#FF0000", "#000000", "#FFFFFF"].
drilldown (all | none) all Specify whether to enable or disable drilldown for the chart.
field DashStyle (solid | shortDash | shortDot | shortDashDot | shortDashDotDot | dot | dash | longDash | dashDot | longDashDot | longDashDotDot) solid Specify a dash style for all line series in the chart.
field DashStyles (solid | shortDash | shortDot | shortDashDot | shortDashDotDot | dot | dash | longDash | dashDot | longDashDot | longDashDotDot) solid Specify a dash style to use for each field. For example, '{"count":"longDashDot", "percent":"longDashDotDot"}'.
fieldColors object n/a Specify the color used for a field by specifying the hex code. For example, {"count": "#ff0000","percent": "#cb3b43"}.

If you would like to maintain a space between two fields, you can use the backslash and quotes to surround the string and maintain the space.

In this example: "{China:#45D4BA,US:#9AE6F7, \"Korea, South\" :#2F8AA7,SanMarino:#C0891E,Singapore:#780621,\"Cruise Ship\":#4EB2D2}" Korea, South and Cruise Ship will have spaces when they appear in the visualization.

fontColor string n/a Specify the color used for fonts using the hex code. For example, "#0000FF" .
foregroundColor string n/a Specify the color used for the chart foreground by specifying the hex code. For example, "#0000FF" .
gridLinesX.showMajorLines boolean true Specify whether major grid lines are visible on the x-axis.
gridLinesY.showMajorLines boolean true Specify whether major grid lines are visible on the y-axis.
gridLinesY2.showMajorLines boolean true Specify whether major grid lines are visible on the second y-axis.
layout.splitSeries boolean false Set to true to split a multi-series chart into separate charts that are stacked from top to bottom; one for each series.
layout.splitSeries.allowIndependentYRanges boolean false Specify whether split series charts have independent y-ranges.
legend.labelStyle.overflowMode (ellipsisEnd | ellipsesMiddle | ellipsisStart | ellipsesNone) ellipsesMiddle Specify how to display legend labels when they overflow the layout boundaries by replacing overflow text with an ellipsis.
legend.mode (standard | seriesCompare) standard Provides visual and behavior settings for the tooltip and legend.
legend.placement (right | left | top | bottom | none) right Specify the location of the legend on the panel.
lineWidth number 2 Specify the line width, in pixels, for all of the lines in a series.
seriesColors array (dark and light mode defaults) ["#1E93C6", "#F2B827", "#D6563C", "#6A5C9E", "#31A35F"] Specify the hex color codes for the bars to use in order from largest to smallest. For example, ["#FF0000","#0000FF","#008000"].

Line shape

Line shape options

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

Property Type Default Description
strokeColor string light mode: "#000000". Dark mode: "#FFFFFF" Specify the color of the line.
strokeOpacity number 1 Specify the opacity of the stroke. Choose a number in the range of 0-1. You can also express the value as a percentage. For example, "0.80" or "80%".
strokeWidth number 1 Specify the width of the stroke, in pixels, in the range of 1-25.
strokeDasharray number 0 Specify the size, in pixels, of dashes and spaces used to create a custom, stitched outline. The value you specify applies to both dashes and spaces.
toArrow boolean false Specify whether the line begins with an arrow.
fromArrow boolean false Specify whether the line ends with an arrow.

Marker gauge

Marker gauge options

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

Property Type Default Description
backgroundColor string light mode: "#FFFFFF" Dark mode: "#212527" Use a hex code to specify the color used for the dashboard background. For example: "#0000FF".
majorUnit number or "auto" auto Specify the spacing between major tick marks in pixels.
orientation string horizontal Specify the axis orientation of the gauge. horizontal or vertical.
showLabels boolean true Specify whether to display labels.
showValue boolean true Specify whether the gauge value is displayed.
usePercentageRange boolean true Specify whether to format gauge ranges as percentages.
usePercentageValue boolean false Specify whether to format the gauge values as percentages.
ranges arrayOf(object) ["[object Object]", "[object Object]", "[object Object]"] Specify the overall range of the gauge as a series of continuous, color-coded subranges. For example, [{"from": 0, "to": 20, "value": "#4BEBA8"}, {"from": 20, "to": 50, "value": "#F4DF7A"}].

Pie chart

Pie chart options

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

Property Type Default Description
backgroundColor string N/A Specify the color used for the chart background by using the hex code. For example, "#0000FF".
fontColor string N/A Specify the color used for fonts using the hex code. For example, "#0000FF".
foregroundColor string N/A Specify the color used for the chart foreground by specifying the hex code. For example, "#0000FF".
fieldColors object N/A Specify the color used for a field by specifying the hex code. For example, {"count": "#ff0000","percent": "#cb3b43"}.

If you would like to maintain a space between two fields, you can use the backslash and quotes to surround the string and maintain the space.

In this example: "{China:#45D4BA,US:#9AE6F7, \"Korea, South\" :#2F8AA7,SanMarino:#C0891E,Singapore:#780621,\"Cruise Ship\":#4EB2D2}" Korea, South and Cruise Ship will have spaces when they appear in the visualization.

seriesColors array (dark and light mode defaults) ["#1E93C6", "#F2B827", "#D6563C", "#6A5C9E", "#31A35F"] Specify the hex color codes for the bars to use in order from largest to smallest. For example, ["#FF0000","#0000FF","#008000"].
drilldown (all | none) none Specify whether to enable drilldown for the chart.
chart.sliceCollapsingLabel string other Specify the label for a consolidated pie slice.
chart.sliceCollapsingThreshold number 0.01 Specify the size threshold, as a percentage of the whole pie, at which point slices collapse into one consolidated slice.
chart.resultTruncationLimit number 50000 Specify a limit for the number of data points rendered in a chart.
chart.showLabels boolean true Specify whether to display labels.
chart.showPercent boolean false Specify whether to display percentage values in the labels.
hasDonutHole Specify whether the pie chart has a hole in the middle. Much like a donut. boolean false

Punchcard chart

Punchcard chart options

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

Property Type Default Description
backgroundColor string transparent Specify the hex code for the color used for the chart background. For example: "#0000FF".
showBubbleLabels string all Specify when a bubble label will be displayed. The options are max, all, and none.
bubbleRowScale string global Specify how bubbles scale relative to the rows. global scales the bubbles in relation to all of the rows in the chart, while row scales the bubbles only in relation to the row that each are in.
bubbleScale string area Specify whether the bubble size should be based on the value being proportional to the radius or the area.
seriesColors array (dark and light mode defaults) ["#1E93C6", "#F2B827", "#D6563C", "#6A5C9E", "#31A35F"] Specify the Hex code for colors used for a series. For example, ['#FF0000', '#0000FF', '#008000'].
isBubbleSizeDynamic boolean true Specify whether the bubble size should be dynamic or fixed. The default true means the bubbles scale with the values associated with them.
maxBubbleRadius number 15 Specifiy the maximum radius in pixels of the bubbles when isBubbleSizeDynamic is set to false. Numbers must be greater than 0.
minBubbleRadius number 1 Specify the minimum radius in pixels of the bubbles when isBubbleSizeDynamic is set to false. The number must be greater than 0.
maxBubbleSize number 1 Specify the maximum percentage (in decimal format) of space a bubble should take up within a cell when the isBubbleSizeDynamic option is set to true. The number specified must be between 0 and 1.
minBubbleSize number 0.25 Specifies the minimum percentage (in decimal format) of space a bubble should take up within a cell when isBubbleSizeDynamic is set to true . The number must be between 0 and 1.
showMaxValuePulsation boolean true Specify whether the maximum bubble should pulsate.
showLegend boolean true Specify whether a legend should be rendered in categorical colorMode.
useDefaultSort boolean false If set to true, axes will be sorted in the order of time order, digit values, and strings.

Rectangles

Rectangle shape options

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

Property Type Default Description
stroke number Specify the color of the stroke using a hex code. For example, "#FF0000".
strokeOpacity number 1 Specify the opacity of the stroke. Choose a number in the range of 0-1. You can also express the value as a percentage. For example, "0.80" or "80%".
strokeWidth number 1 Specify the width of the stroke, in pixels, in the range of 1-25.
fill string Specify the color fill using a hex code. For example, "#FF0000".
fillOpacity number 1 Specify the opacity of the fill. Choose a number in the range of 0-1. You can also express the value as a percentage. For example, "0.80" or "80%".
strokeDasharray number 0 Specify the size, in pixels, of dashes and spaces used to create a custom, stitched outline. The value you specify applies to both the dashes and the spaces.
opacity number 1 Specify the opacity of the entire object. Stroke and fill colors are retained. Choose a number in the range of 0-1. You can also express the value as a percentage. For example, "0.80" or "80%".
rx number auto Specify the curvature of the horizontal corner (or border) radius with an integer or a percent greater than or equal to zero.
ry number auto Specify the curvature of the vertical corner, or border radius with an integer or a percent greater than or equal to zero.
strokeLinejoin (arcs | bevel | miter | miter-clip | round) miter Specifies the shape to be used at the corners of paths when they are joined.

Scatter chart

Scatter chart options

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

Property Type Default Description
axisLabelsX.extendsAxisRange boolean true Specify whether to extend the x-axis to include whole major tick marks.
axisLabelsX.integerUnits boolean false Specify whether to extend the y2-axis to include whole major tick marks.
axisX.abbreviation (none | auto) none Specify whether to abbreviate large x-axis values with the closest SI prefix.
axisX.includeZero boolean false Specify whether the x-axis range includes zero.
axisY.includeZero boolean false Specify whether the y-axis range includes zero.
axisX.maximumNumber (number | auto) auto Specify the maximum number for the visible x-axis range.
axisY.maximumNumber (number | auto) auto Specify the maximum number for the visible y-axis range.
axisX.minimumNumber (none | auto) auto Specify the minimum number for the visible x-axis range.
axisY.minimumNumber (none | auto) auto Specify the minimum number for the visible y-axis range.
axisX.scale (linear | log) linear Specify the scale type that applies to a numerical x-axis.
axisY.scale (linear | log) linear Specify the scale type that applies to a numerical y-axis.
axisTitleX.text string N/A Specify the title of the x-axis.
axisTitleY.text string N/A Specify the title of the y-axis.
axisTitleX.visibility (visible | collapsed) visible Specify whether to show the title of the x-axis.
axisTitleY.visibility (visible | collapsed) visible Specify whether to show the title of the y-axis.
gridLinesY.showMajorLines boolean true Specify whether major grid lines are visible on the y-axis.
backgroundColor string N/A Specify the color used for the chart background by using the hex code. For example, "#0000FF" .
fontColor string N/A Specify the color used for fonts using the hex code. For example, "#0000FF" .
foregroundColor string N/A Specify the color used for the chart foreground by specifying the hex code. For example, "#0000FF" .
fieldColors object N/A Specify the color used for a field by specifying the hex code. For example, {"count": "#ff0000","percent": "#cb3b43"}.

If you would like to maintain a space between two fields, you can use the backslash and quotes to surround the string and maintain the space.

In this example: "{China:#45D4BA,US:#9AE6F7, \"Korea, South\" :#2F8AA7,SanMarino:#C0891E,Singapore:#780621,\"Cruise Ship\":#4EB2D2}" Korea, South and Cruise Ship will have spaces when they appear in the visualization.

gridLinesX.showMinorLines boolean false Specify whether minor grid lines are visible on the x-axis.
legend.labelStyle.overflowMode (ellipsisEnd | ellipsesMiddle | ellipsisStart | ellipsesNone) ellipsesMiddle Specify how to display legend labels when they overflow the layout boundaries by replacing overflow text with an ellipsis.
legend.placement (right | left | top | bottom | none) right Specify the location of the legend on the panel.
seriesColors array (dark and light mode defaults) ["#1E93C6", "#F2B827", "#D6563C", "#6A5C9E", "#31A35F"] Specify the hex color codes for the bars to use in order from largest to smallest. For example, ["#FF0000","#0000FF","#008000"].
drilldown (all | none) all Specify whether to enable or disable drilldown for the chart.
chart.markerSize number 4 Specify the marker size of the scatter chart.
chart.resultTruncationLimit number 50000 Specify a limit for the number of data points rendered in a chart.

Single value

Single value options

The following options are available for the single value visualization:

Property Type Default Description
majorValue (string | number) > sparklineValues |lastPoint() Specify the major value to display in the visualization. This can be a static value, or a dynamic value.
majorColor string > themes.defaultFontColor Specify the dynamic color of the major value by dataSource or a static color using the hex format. For example, #FFFFFF.
unit string N/A Specify label text to show next to the single value.
unitPosition (before | after) after Specify whether you want the unit label to appear before or after the single value.
underLabel string N/A Specify the label text that appears below the value.
underLabelFontSize number 12 Specify the font size, in pixels, for the text in the label under the visualization.
backgroundColor string > themes.defaultBackgroundColor Specify a color to use for the single value background. For example, "#008000".
trendValue number > sparklineValues | delta(-2) The trend value to display in the visualization.
trendColor string > themes.defaultFontColor Specify the color for trend value. If using a static value, use the hex value format. For example, #FFFFFF.
shouldAbbreviateTrendValue boolean false Specify whether to abbreviate the trend value to 2 decimal places. A magnitude unit will be displayed.
sparklineDisplay (before | after | below | off) below Specify where to place a sparkline. You can also disable it.
sparklineValues (number | string) > primary | seriesByPrioritizedTypes("number", "string", "time") Specify a list of dynamic or static list of sparkline values to display.
showSparklineAreaGraph boolean false Specify whether to show the sparkline as an area graph rather than a line.
sparklineAreaColor string > sparklineStrokeColor Specify a dynamic or static color for the fill under the sparkline. For a static color, enter a hex code. For example #FFFFFF.

Note that this setting only works when showSparklineAreaGraph is set to true.

sparklineStrokeColor string > themes.defaultSparklineStrokeColor Specify a dynamic or static color for the sparkline stroke. For a static color, enter a hex code. For example #FFFFFF.
showSparklineTooltip boolean false Show a tooltip to display values on the sparkline.
shouldSparklineAcceptNullData boolean true Specify whether to convert null and non-numeric values in the sparkline to 0.
sparklineHighlightSegments number 0 Specify the number of segments to highlight at the top of a sparkline area graph. Note that this setting only works when showSparklineAreaGraph is set to true.
sparklineHighlightDots number 0 Specify the number of markers, or dots, to display at the top of a sparkline area chart. Note that this setting only works when showSparklineAreaGraph is set to true.
trendDisplay (percent | absolute | off) absolute Specify whether the trend value is displayed as a percentage or an absolute count.
numberPrecision number 0 Specify the number of decimal places to display. For example, to display three decimal places, enter a value of 3. The maximum value is 20.
shouldUseThousandSeparators boolean true Specify whether numeric values use commas as thousandths separators.
majorFontSize number N/A Specify the font size (px) for the major value. By default the major value font size is calculated dynamically based on the available space.
trendFontSize number N/A

Single value icon

Single Value Icon options

The following options are available for the single value visualization:

Property Type Default Description
unit string N/A Specify label text to show next to the single value.
unitPosition (before | after) after Specify whether you want the unit label to appear before or after the single value.
underLabel string N/A Specify the label text that appears below the value.
majorValue (string | number) > primary | seriesByPrioritizedTypes("number", "string", "time") | lastPoint() Specify the major value to display in the visualization. This can be a static value, or a dynamic value.
majorColor string > themes.defaultFontColor Specify the dynamic color of the major value by dataSource or a static color using the hex format. For example, #FFFFFF.
backgroundColor string transparent Specify a color to use for the single value background. For example, "#FFA500".
showValue boolean false Specify whether to show or hide the major value trend indicator.
trendColor string > themes.defaultFontColor Specify the dynamic or static color for the trend value. If using a static value, use the hex value format. For example, #FFFFFF.
trendValue (number | string) > primary | seriesByPrioritizedTypes("number", "string", "time") | delta(-2) Specify the dynamic color of the trend value by dataSource or a static color using the hex format. For example, #FFFFFF.
trendDisplay (percent | absolute | off) absolute Specify whether the trend value is displayed as a percentage or an absolute count.
shouldAbbreviateTrendValue boolean false Specify whether to abbreviate the trend value to 2 decimal places. A magnitude unit will be displayed.
numberPrecision number 0 Specify the number of decimal places to display. For example, to display three decimal places, enter a value of 3. The maximum value is 20.
shouldUseThousandSeparators boolean true Specify whether numeric values use commas as thousandths separators.
icon string default Specify an icon. To use one of the default icons, specify the name: activity, clock, pencil, star, or default. To use an icon you've uploaded, specify the location in the key value store. For example, "icon": "splunk-enterprise-kvstore://601c8bdf1922f119a0184e13".
iconPosition string (before | after | below | top) Specify where to display the icon in relation to the single value.
iconOpacity number 1 Specify the opacity for the icon using numbers between and including 0 and 1 (inclusinve). This relates to the opacity percentages in the visual editor.
showValue boolean true Specify whether to enable or disable the value and trend indicator display.
iconColor string N/A Specify the icon color. Use color hex codes. For example, "#FF0000".
majorFontSize number N/A Specify the font size (px) for the major value of single value icon. By default the major value font size is calculated dynamically based on the available space.
trendFontSize number N/A Specify the font size (px) for the delta value of the single value icon.

Single value radial

Single Value Radial options

The following options are available for the single value radial visualization:

Property Type Default Description
unit string N/A Specify label text to show next to the single value.
unitPosition (before | after) after Specify whether you want the unit label to appear before or after the single value.
underLabel string N/A Specify the label text that appears below the value.
backgroundColor string light mode: "#FFFFFF". Dark mode: "#212527" Specify a color to use for the single value background. For example, "#008000".
showTrendIndicator boolean true Specify whether to show or hide the single value trend indicator.
useTrendUnits boolean false Specify whether to truncate the trend value to two significant digits. A magnitude unit is displayed.
trendDisplayMode (percent | absolute) absolute Specify whether the trend value is displayed as a percentage or an absolute count.
numberPrecision number 0 Specify the number of decimal places to display. For example, to display three decimal places, enter a value of 3. The maximum value is 20.
useThousandSeparators boolean true Specify whether numeric values use commas as thousandths separators.
radialBackgroundColor string none Specify a color in hex code to customize the radial background color. For example, "#FFFFFF".
radialStrokeColor string none Specify a color in hex code to customize the radial stroke color. For example, "#FFFFFF".

Table

Global table options

The following options are available for tables:

Property Type Default Description
table (string | number) > primary A two-dimensional array of data to be displayed in the table.
backgroundColor string > themes.defaultBackgroundColor Specify the color to use for the table background using a hex code. For example: "#FFFFFF".
count number 10 Specify the maximum number of rows to display.
showRowNumbers boolean false Specify whether to display the row numbers in the first column.
headers (string | array) > table | getField() Specify an array of headers to display on the table. Though these can be statically listed, it's best to use the dynamic default, as it will return the fields of your search.
headerVisibility (none | fixed | inline) inline Specify how to display the table header row.
paginateDataSourceKey string primary Specify the datasource key for pagination and sorting.


tableFormat (object type)

The following are nested settings that are set in the context section of the visualization stanza. They can then be called within tableFormat in the options section and an be used to format global table options:

Property Type Default Description
align (left | center | right ) > table | type() | matchValue(tableAlignByType) Alignment for each cell in the table.
cellTypes (TextCell | ArrayCell | SparklineCell ) > table | type() | matchValue(tableCellTypeByType) Specify how to render data in in cells.
data (string | number) N/A Two dimensional data to be displayed in the table. This is usually formatted data instead of raw data returned from a search.
headerBackgroundColor string Defaults to the background color. Specify the table header background color using a hex code. For example: "#FFFFFF".
headerColor string Light mode: "#3C444D". Dark mode: "#FFFFFF". Specify the table header text color using a hex code. For example: "#FFFFFF".
rowBackgroundColors string The default background color for the visualization. Specify a list of colors, in hex code, for the background color of each row of the table. For example, ["#2C333", "32373D"].
rowColors string Specify a list of colors, in hex code, for the text color of each row of the table. For example, ["#2C333", "32373D"].
sparklineAreaColors string Defaults to the global background color. Specify a list of colors, in hex code, for the sparkline area of each row of the table. For example, ["#2C333", "32373D"].
sparklineColors string Specify a list of colors, in hex code, for the sparkline stroke of each row of the table. For example, ["#2C333", "32373D"].
sparklineTypes line (line | area) Choose either area or line formatting for the Sparkline.

columnFormat (object type)

The following are nested settings that are set in the context section of the visualization stanza. They can then be called within columnFormat in the options section and an be used to format individual columns by specifying their fields:

Property Type Default Description
align (left | center | right ) Alignment for each cell in the column.
cellTypes (TextCell | ArrayCell | SparklineCell ) Specify how to render data in in cells.
data (string | number) N/A Data points to be displayed in the cells of a column.
rowBackgroundColors string Defaults to the background color. Specify a list of colors, in hex code, for the background color of each column of the table. For example: ["#2C333", "32373D"].
rowColors string Specify a list of colors, in hex code, for the text color of the cells of a column. For example, ["#2C333", "32373D"].
sparklineAreaColors string Defaults to the global background color. Specify a list of colors, in hex code, for the sparkline area of each column. For example, ["#2C333", "32373D"].
sparklineColors string Specify a list of colors, in hex code, for the sparkline stroke of each column. For example, ["#2C333", "32373D"].
sparklineTypes line (line | area) Choose either area or line formatting for the Sparkline.

Text

Text options

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 to be used. For example Comic Sans MS. <a>The font needs to be available to your end user.</a>
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.

Default properties

In addition to the settings in the options field, there are two default fields that you can set. These are not options, but should be placed at the same level as the options field.

showProgressBar shows a progress bar as a visualization loads and is set to false by default. showLastUpdated shows the last time the visualization was refreshed and is set to false by default.

You can enable these features by adding the properties to a visualization, and changing the settings to true.

In the following example, the visualization will override the default for showProgressBar and show a progress bar as it loads.

	"viz_tpRnLS1I": {
		"type": "viz.line",
		"showProgressBar": true,
		"options": {
			"showSparkline": false,
			"backgroundColor": "#ffffff"
		},
		"title": "Does have a progress bar",
		"description": "Due to viz override",
		"dataSources": {
			"primary": "ds_o7IqGHcO"
		}
Last modified on 07 October, 2021
PREVIOUS
Use inputs and tokens to make dashboards dynamic
  NEXT
Selector and formatting functions

This documentation applies to the following versions of Splunk® Enterprise: 8.2.1, 8.2.2


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