Overview of the custom chart configuration reference
The topics in this reference chapter provide details on the various charting elements and properties that you can use to customize dashboard charts using the Splunk Enterprise module system and advanced XML. Although you can configure most charts using simple XML
Chart customization introduction and tutorial
The topics in this chapter provide basic examples of how to manage chart customization with charting controls. See Chart customization for detailed chart examples that include background material on how they work.
Certain chart customization properties are not supported by JSChart. If you use an unsupported chart customization property, it is undefined how your chart displays. The behavior depends on the chart, the properties you are accessing, and whether the chart is displaying on an iOS mobile device. In some cases the chart renders using FlashChart; in others it renders the chart with JSChart, ignoring the unsupported customizations.
Each of the tables in this charting library reference has a Supported by JSChart? column to help you select the right chart for your dashboard.
For more information about using chart customization properties that are unsupported by JSChart, see the About JSChart topic in this manual.
About this reference
This reference provides details on the following charting elements:
- Charts - The
chartelement controls properties specific to individual chart types. For example, when
charthas a value of
line, you can specify properties for a line chart, such as
- Legends - You use the
legendelement to control aspects of the visual appearance of chart legends, including legend placement, label text, and text formatting.
- Axes - The
axiselement controls how data is mapped to the chart grid (but not how it appears--for that see the
axisLabelselement). It is set up to handle three types of chart axes: category axes (which map categorical values), numeric axes (which plot data along a numeric range), and time axes (which plot data along a range of time).
- Axis labels - The
axisLabelselement controls the visualization of chart axes. It places tick marks and labels at locations along chart axes that are appropriate depending upon the state of those axes.
- Axis titles - The
axisTitleelement is mainly used for Cartesian (dual axis) charts such as bar, column, area, and line charts. It enables placement of the x- and y-axis titles within the chart layout.
- Grid lines - The
gridLineselement is used to control the display and appearance of chart grid lines in cartesian (dual axis) chart types, such as bar, column, area, and line charts. Grid lines correspond to axis tick marks from axis labels and extend across the span of the chart.
- Tool tips - Tool tips are the visual elements that appear on chart mouseover, displaying information that corresponds to the chart data sprite underneath the mouse pointer.
- Fonts - Font properties enable you to set a number of characteristics for the fonts used in the charts, such as the font size and style.
- Colors - Color properties enable you to set basic chart color characteristics, such as the color of the chart background.
- Brushes - You can apply a variety of different brushes for the purpose of rendering chart lines and fills in different ways. For example, if you want a line chart to render its lines with a dashed stroke instead of a solid one, you can use a
brushelement of the
- Color palettes - The color palette element is used to control the colors used by brushes, which in turn are used to paint things like chart lines and series swatches in legends. You can define a set list of colors that the palette applies to series, or you can arrange to have the palette generate colors by interpolating between a range of colors (from red to yellow to blue for example).
- Brush palettes - Brush palettes match a series index to a brush type. This can come in handy for things like line charts, where you might want a different type of dashed or solid line for each series represented in the chart.
- Shapes and shape palettes - Shapes are used for markers in several cart types. You can have one shape be used throughout a chart, or you can use a shape palette to assign different shapes to different series.
- Layouts - The
layoutelement controls the layout of all visual chart elements in a dashboard. In most cases you won't need to work with it, but you might use it to set up something like two charts that share the same x- or y-axis.
- Data - The
dataelement enables you to tweak the tabular format that contains the reporting data from which the chart is generated. In most cases you won't need to adjust the
- Text blocks -
textBlockelements control text display in legend and axis labels as well as axis title and message text.
- Layout sprites and sprites - The
spriteelements are formatting elements that feed Flash display properties to many other elements throughout the charting system. In most cases you won't need to adjust these settings.
Splunk Enterprise API is RESTful
This documentation applies to the following versions of Splunk® Enterprise: 6.0, 6.0.1, 6.0.2, 6.0.3, 6.0.4, 6.0.5, 6.0.6, 6.0.7, 6.0.8, 6.0.9, 6.0.10, 6.0.11, 6.0.12, 6.0.13, 6.0.14, 6.0.15, 6.1, 6.1.1, 6.1.2, 6.1.3, 6.1.4, 6.1.5, 6.1.6, 6.1.7, 6.1.8, 6.1.9, 6.1.10, 6.1.11, 6.1.12, 6.1.13, 6.1.14, 6.2.0, 6.2.1, 6.2.2, 6.2.3, 6.2.4, 6.2.5, 6.2.6, 6.2.7, 6.2.8, 6.2.9, 6.2.10, 6.2.11, 6.2.12, 6.2.13, 6.2.14, 6.2.15