ChartSettings

ChartSettings
ChartSettings

Representation of the settings of a Wavefront chart

JSON Example
{
    "type": "string",
    "min": "number",
    "max": "number",
    "customTags": [
        "string"
    ],
    "expectedDataSpacing": 0,
    "fixedLegendEnabled": false,
    "fixedLegendUseRawStats": false,
    "plainMarkdownContent": "string",
    "lineType": "string",
    "stackType": "string",
    "windowing": "string",
    "windowSize": 0,
    "showHosts": false,
    "showLabels": false,
    "showRawValues": false,
    "showValueColumn": false,
    "autoColumnTags": false,
    "columnTags": "string",
    "tagMode": "string",
    "numTags": 0,
    "groupBySource": false,
    "sortValuesDescending": false,
    "defaultSortColumn": "string",
    "y1Max": "number",
    "y1Min": "number",
    "y1Units": "string",
    "y0ScaleSIBy1024": false,
    "y1ScaleSIBy1024": false,
    "y0UnitAutoscaling": false,
    "y1UnitAutoscaling": false,
    "invertDynamicLegendHoverControl": false,
    "fixedLegendPosition": "string",
    "fixedLegendDisplayStats": [
        "string"
    ],
    "fixedLegendFilterSort": "string",
    "fixedLegendShowSourceName": false,
    "fixedLegendShowMetricName": false,
    "fixedLegendFilterLimit": 0,
    "fixedLegendFilterField": "string",
    "fixedLegendHideLabel": false,
    "xmax": "number",
    "xmin": "number",
    "ymax": "number",
    "ymin": "number",
    "timeBasedColoring": false,
    "sparklineDisplayValueType": "string",
    "sparklineDisplayColor": "string",
    "sparklineDisplayVerticalPosition": "string",
    "sparklineDisplayHorizontalPosition": "string",
    "sparklineDisplayFontSize": "string",
    "sparklineDisplayPrefix": "string",
    "sparklineDisplayPostfix": "string",
    "sparklineSize": "string",
    "sparklineLineColor": "string",
    "sparklineFillColor": "string",
    "sparklineValueColorMapColors": [
        "string"
    ],
    "sparklineValueColorMapValuesV2": [
        "number"
    ],
    "sparklineValueColorMapValues": [
        0
    ],
    "sparklineValueColorMapApplyTo": "string",
    "sparklineDecimalPrecision": 0,
    "sparklineValueTextMapText": [
        "string"
    ],
    "sparklineValueTextMapThresholds": [
        "number"
    ],
    "chartDefaultColor": "string",
    "logsTable": {
        "columns": [
            "string"
        ]
    }
}
string
type
Required

Chart Type. 'line' refers to the Line Plot, 'scatter' to the Point Plot, 'stacked-area' to the Stacked Area plot, 'table' to the Tabular View, 'scatterploy-xy' to Scatter Plot, 'markdown-widget' to the Markdown display, and 'sparkline' to the Single Stat view

Possible values are : line, scatterplot, stacked-area, stacked-column, table, scatterplot-xy, markdown-widget, sparkline, globe, nodemap, top-k, status-list, histogram, heatmap, gauge, pie,
number As double As double
min
Optional

Min value of Y-axis. Set to null or leave blank for auto

number As double As double
max
Optional

Max value of Y-axis. Set to null or leave blank for auto

array of string
customTags
Optional

For the tabular view, a list of point tags to display when using the "custom" tag display mode

integer As int64 As int64
expectedDataSpacing
Optional

Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid line in line plots. Default: 60s

boolean
fixedLegendEnabled
Optional

Whether to enable a fixed tabular legend adjacent to the chart

boolean
fixedLegendUseRawStats
Optional

If true, the legend uses non-summarized stats instead of summarized

string
plainMarkdownContent
Optional

The Markdown content for a Markdown display, in plain text. Use this field instead of markdownContent.

string
lineType
Optional

Plot interpolation type. linear is default

Possible values are : linear, step-before, step-after, basis, cardinal, monotone,
string
stackType
Optional

Type of stacked chart (applicable only if chart type is stacked). zero (default) means stacked from y=0. expand means Normalized from 0 to 1. wiggle means Minimize weighted changes. silhouette means to Center the Stream

Possible values are : zero, expand, wiggle, silhouette, bars,
string
windowing
Optional

For the tabular view, whether to use the full time window for the query or the last X minutes

Possible values are : full, last,
integer As int64 As int64
windowSize
Optional

Width, in minutes, of the time window to use for "last" windowing

boolean
showHosts
Optional

For the tabular view, whether to display sources. Default: true

boolean
showLabels
Optional

For the tabular view, whether to display labels. Default: true

boolean
showRawValues
Optional

For the tabular view, whether to display raw values. Default: false

boolean
showValueColumn
Optional

For the tabular view, whether to display value column. Default: true

boolean
autoColumnTags
Optional

deprecated

string
columnTags
Optional

deprecated

string
tagMode
Optional

For the tabular view, which mode to use to determine which point tags to display

Possible values are : all, top, custom,
integer As int32 As int32
numTags
Optional

For the tabular view, how many point tags to display

boolean
groupBySource
Optional

For the tabular view, whether to group multi metrics into a single row by a common source. If false, each metric for each source is displayed in its own row. If true, multiple metrics for the same host will be displayed as different columns in the same row

boolean
sortValuesDescending
Optional

For the tabular view, whether to display display values in descending order. Default: false

string
defaultSortColumn
Optional

For the tabular view, to select column for default sort

number As double As double
y1Max
Optional

For plots with multiple Y-axes, max value for right-side Y-axis. Set null for auto

number As double As double
y1Min
Optional

For plots with multiple Y-axes, min value for right-side Y-axis. Set null for auto

string
y1Units
Optional

For plots with multiple Y-axes, units for right-side Y-axis

boolean
y0ScaleSIBy1024
Optional

Default: false. Whether to scale numerical magnitude labels for left Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI)

boolean
y1ScaleSIBy1024
Optional

Default: false. Whether to scale numerical magnitude labels for right Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI)

boolean
y0UnitAutoscaling
Optional

Default: false. Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units

boolean
y1UnitAutoscaling
Optional

Default: false. Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units

boolean
invertDynamicLegendHoverControl
Optional

Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed)

string
fixedLegendPosition
Optional

Where the fixed legend should be displayed with respect to the chart

Possible values are : RIGHT, TOP, LEFT, BOTTOM,
array of string
fixedLegendDisplayStats
Optional

For a chart with a fixed legend, a list of statistics to display in the legend

string
fixedLegendFilterSort
Optional

Whether to display "Top"- or "Bottom"-ranked series in the fixed legend

Possible values are : TOP, BOTTOM,
boolean
fixedLegendShowSourceName
Optional

Whether to display Source Name fixed legend

boolean
fixedLegendShowMetricName
Optional

Whether to display Metric Name fixed legend

integer As int32 As int32
fixedLegendFilterLimit
Optional

Number of series to include in the fixed legend

string
fixedLegendFilterField
Optional

Statistic to use for determining whether a series is displayed on the fixed legend

Possible values are : CURRENT, MEAN, MEDIAN, SUM, MIN, MAX, COUNT,
boolean
fixedLegendHideLabel
Optional

deprecated

number As double As double
xmax
Optional

For x-y scatterplots, max value for X-axis. Set null for auto

number As double As double
xmin
Optional

For x-y scatterplots, min value for X-axis. Set null for auto

number As double As double
ymax
Optional

For x-y scatterplots, max value for Y-axis. Set null for auto

number As double As double
ymin
Optional

For x-y scatterplots, min value for Y-axis. Set null for auto

boolean
timeBasedColoring
Optional

For x-y scatterplots, whether to color more recent points as darker than older points. Default: false

string
sparklineDisplayValueType
Optional

For the single stat view, whether to display the name of the query or the value of query

Possible values are : VALUE, LABEL,
string
sparklineDisplayColor
Optional

For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in "rgba(<rval>, <gval>, <bval>, <aval>)" format

string
sparklineDisplayVerticalPosition
Optional

deprecated

string
sparklineDisplayHorizontalPosition
Optional

For the single stat view, the horizontal position of the displayed text

Possible values are : MIDDLE, LEFT, RIGHT,
string
sparklineDisplayFontSize
Optional

For the single stat view, the font size of the displayed text, in percent

string
sparklineDisplayPrefix
Optional

For the single stat view, a string to add before the displayed text

string
sparklineDisplayPostfix
Optional

For the single stat view, a string to append to the displayed text

string
sparklineSize
Optional

For the single stat view, a misleadingly named property. This determines whether the sparkline of the statistic is displayed in the chart BACKGROUND, BOTTOM, or NONE

Possible values are : BACKGROUND, BOTTOM, NONE,
string
sparklineLineColor
Optional

For the single stat view, the color of the line. Values should be in "rgba(<rval>, <gval>, <bval>, <aval>)" format

string
sparklineFillColor
Optional

For the single stat view, the color of the background fill. Values should be in "rgba(<rval>, <gval>, <bval>, <aval>)" format

array of string
sparklineValueColorMapColors
Optional

For the single stat view, a list of colors that differing query values map to. Must contain one more element than sparklineValueColorMapValuesV2. Values should be in "rgba(<rval>, <gval>, <bval>, <aval>)" format

array of number
sparklineValueColorMapValuesV2
Optional

For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one less element than sparklineValueColorMapColors

array of integer
sparklineValueColorMapValues
Optional

deprecated

string
sparklineValueColorMapApplyTo
Optional

For the single stat view, whether to apply dynamic color settings to the displayed TEXT or BACKGROUND

Possible values are : TEXT, BACKGROUND,
integer As int32 As int32
sparklineDecimalPrecision
Optional

For the single stat view, the decimal precision of the displayed number

array of string
sparklineValueTextMapText
Optional

For the single stat view, a list of display text values that different query values map to. Must contain one more element than sparklineValueTextMapThresholds

array of number
sparklineValueTextMapThresholds
Optional

For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one less element than sparklineValueTextMapText

string
chartDefaultColor
Optional

Default color that will be used in any chart rendering. Values should be in "rgba(<rval>, <gval>, <bval>, <aval>)" format

logsTable
Optional

logsTable