Title here
Summary here
Panel Plugin
This is the list of every panel plugin we are supporting.
BarChart
kind: "BarChart"
spec:
calculation: <Calculation specification>
[ format: <Format specification> ]
[ sort: <enum = "asc" | "desc"> ]
[ mode: <enum = "value" | "percentage"> ]GaugeChart
kind: "GaugeChart"
spec:
calculation: <Calculation specification>
[ format: <Format specification> ]
[ thresholds: <Thresholds specification> ]
[ max: <int> ]Markdown
kind: "Markdown"
spec:
text: <string>StatChart
kind: "StatChart"
spec:
calculation: <Calculation specification>
[ format: <Format specification> ]
[ thresholds: <Thresholds specification> ]
[ sparkline: <Sparkline specification> ]
[ valueFontSize: <int> ]Sparkline specification
[ color: <string> ]
[ width: <int> ]ScatterChart
Note: Currently, ther are are no spec options avaiable for this panel
kind: "ScatterChart"
spec:TimeSeriesChart
kind: "TimeSeriesChart"
spec:
[ legend: <Legend specification> ]
[ tooltip: <Tooltip specification> ]
[ yAxis: <YAxis specification> ]
[ thresholds: <Thresholds specification> ]
[ visual: <Visual specification> ]Legend specification
position: <enum = "bottom" | "right">
[ mode: <enum = "list" | "table"> ]
[ size: <enum = "small" | "medium"> ]
values:
- [ <calculation> ]Tooltip specification
[ enablePinning: <boolean | default = false> ]YAxis specification
[ show: <boolean> ]
[ label: <string> ]
[ format: <format_spec> ]
[ min: <int> ]
[ max: <int> ]Visual specification
[ display: <enum = "line" | "bar"> ]
# Must be between 0.25 and 3
[ lineWidth: <int> ]
# Must be between 0 and 1
[ areaOpacity: <int> ]
[ showPoints: <enum = "auto" | "always"> ]
[ palette: <Palette specification> ]
# Must be between 0 and 6
[ pointRadius: <number> ]
[ stack: <enum = "all" | "percent"> ]
[ connectNulls: boolean | default = false ]Palette specification
mode: <enum = "auto" | "categorical">Common definitions
Calculation specification
It’s an enum. Possible values are:
firstlastfirst-numberlast-numbermeansumminmax
Format specification
The format spec is one of the following:
Time format
unit: <enum = "milliseconds" | "seconds" | "minutes" | "hours" | "days" | "weeks" | "months" | "years">
[ decimalPlaces: <int> ]Percent format
unit: <enum = "percent" | "percent-decimal">
[ decimalPlaces: <int> ]Decimal format
unit: "decimal"
[ decimalPlaces: <int> ]
[ shortValues: <boolean> | default = false ]Bytes format
unit: "bytes"
[ decimalPlaces: <int> ]
[ shortValues: <boolean> | default = false ]Throughput format
unit: < enum = "counts/sec" | "events/sec" | "messages/sec" | "ops/sec" | "packets/sec" | "reads/sec" | "records/sec" | "requests/sec" | "rows/sec" | "writes/sec">
[ decimalPlaces: <int> ]
[ shortValues: <boolean> | default = false ]Thresholds specification
[ mode: <enum = "percent" | "absolute"> ]
[ defaultColor: string ]
steps:
- [ <Step specification> ]Step specification
value: <int>
[ color: <string> ]
[ name: <string> ]